本接口用于批量删除或者释放按量付费实例或者到期的包年包月实例,支持通过参数设置决定云盘是否释放或转换为按量付费保留。
接口说明
警告
释放实例后,实例所使用的物理资源都被回收,相关数据全部丢失且不可恢复。
释放实例时,云盘的手动快照会被保留,实例上挂载的云盘和自动快照是否释放取决于创建时的参数设置。释放实例之前,您可以通过 DescribeDisks 查询实例上挂载的云盘和自动快照的相关参数设置:
DeleteWithInstance=false
,云盘会被转换成按量付费云盘而保留下来,否则会随实例被释放。DeleteAutoSnapshot=false
,自动快照被保留,否则会随实例被释放。
注意 被安全锁定的实例,即使云盘的DeleteWithInstance参数设置为false,释放实例时也会忽略这个属性而释放云盘。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecs:DeleteInstances | delete | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DryRun | boolean | 否 | 是否只预检此次请求。
默认值:false。 | false |
Force | boolean | 否 | 是否强制释放运行中(
默认值:false。 警告 强制释放相当于断电,实例内存以及存储中的临时数据都会被擦除,无法恢复。 | false |
TerminateSubscription | boolean | 否 | 是否释放已到期的包年包月实例。
默认值:false。 | false |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-426655440000 |
RegionId | string | 是 | 实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
InstanceId | array | 是 | 实例 ID 数组。数组长度:1~100。 | |
string | 是 | 实例 ID。 | i-bp1g6zv0ce8oghu7**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "7B7813C6-57BF-41XX-B12B-F172F65A6046"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter.CrossRegionNotSupport | Instances of multiple regions not support. | - |
400 | DRYRUN.SUCCESS | This request is a dryrun request with successful result. | 您设置了预检此次请求,并且检查通过。 |
400 | DependencyViolation.SLBConfiguring | Specified operation is denied as your instance is using by another product. | 实例被 SLB 引用,且 SLB 正在配置。 |
400 | DependencyViolation.RouteEntry | Specified instance is used by route entry. | 当前专有网络 VPC 还存在未删除的自定义路由规则,删除失败。 |
403 | InvalidParameter.TooManyInstanceIds | Instance ids cannot be more than 100. | - |
403 | InvalidInstanceIds.ValueNotSupported | The specified instanceIds is not valid. | - |
403 | InvalidOperation.DeletionProtection | The operation is not allowed due to deletion protection. | - |
403 | InvalidOperation.DeletionProtection | %s | 该操作无效,请先取消该实例的释放保护。 |
403 | ChargeTypeViolation | %s | - |
403 | IncorrectInstanceStatus.Initializing | %s | - |
403 | InvalidOperation.EniLinked | %s | 实例的当前弹性网卡关联了其他弹性网卡,导致操作无效。需要解除关联后才能从实例分离。 |
403 | IncorrectInstanceStatus | %s | 当前实例的状态不支持此操作。 |
403 | InstanceLockedForSecurity | The specified operation is denied as your instance is locked for security reasons. | 实例被安全锁定。 |
404 | InvalidInstanceIds.NotFound | The specified InstanceIds does not exist. | 指定的 InstanceId 不存在。请检查 InstanceId 参数值是否正确。您可以调用 DescribeInstances 查询指定实例的状态。 |
404 | InvalidInstanceId.NotFound | %s | 指定的实例不存在,请确认参数 InstanceId 是否正确。 |
500 | InvalidParameter | Invalid parameters. | 参数无效,可能由于参数格式错误或缺少必填参数所导致 |
500 | InternalError | The request processing has failed due to some unknown error. | 内部错误,请重试。 |
500 | InternalError | %s | 内部错误。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-07-17 | OpenAPI 错误码发生变更 | 查看变更详情 |