批量退订预付费实例
更新时间：2024-11-11
该接口用于批量退订包年包月（预付费）实例。
- 支持释放预付费云服务器实例，释放后实例所使用的物理资源都被收回，相关数据全部丢失且不可恢复。
- 单次操作最多支持20个实例。
- 不支持已经过期的预付费资源释放，包含实例及其关联的CDS、EIP等。
- 预付费释放退款规则详情请见：退款说明。
请求结构
POST /v{version}/instance/batchRefundResource HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string
{
"instanceIds": ["instanceId"],
"relatedReleaseFlag": relatedReleaseFlag,
"deleteCdsSnapshotFlag":deleteCdsSnapshotFlag,
"deleteRelatedEnisFlag" : deleteRelatedEnisFlag
}请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号 |
| instanceId | List |
是 | RequestBody参数 | 实例id列表，单次操作最多支持20个实例 |
| relatedReleaseFlag | boolean | 否 | RequestBody参数 | 是否关联释放当前时刻，实例挂载的EIP和数据盘。默认值：false，不关联释放。注意：实例关联的预付费CDS盘会强制随实例一起释放。 |
| deleteCdsSnapshotFlag | boolean | 否 | RequestBody参数 | 是否释放云磁盘快照。默认值：false，不关联释放 |
| deleteRelatedEnisFlag | boolean | 否 | RequestBody参数 | 实例释放时是否删除关联的ENI。默认值：false，不关联释放 |
返回头域
除公共头域外，无其它特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| failedInstanceIds | List |
删除失败的实例列表 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| Instance.DeletionProtection | Instance can not release with DeletionProtection. | 403 | 不允许释放删除保护中的虚机 |
| InsufficientCreditException | Insufficient user refund quota | 400 | 用户退费的配额不足 |
| BadRequest | The size of the prepay instances is limited to 20. | 400 | 单次操作最多支持20个实例 |
| BadRequest | Instanceid status not support delete | 400 | 实例状态不对 |
| Instance.ReleaseNotPrepay | This interface not support delete postpay instance | 403 | 后付费虚机，不允许释放 |
请求示例
POST /v2/instance/batchRefundResource HTTP/1.1
Host: bcc.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b***
{
"instanceIds": ["instanceId"],
"relatedReleaseFlag": true,
"deleteCdsSnapshotFlag":true,
"deleteRelatedEnisFlag" : true
}返回示例
HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2024 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"failedInstanceIds": []
}