批量删除实例

接口说明


删除实例(支持批量)。

注意事项:

  1. 实例删除后,实例所使用的资源会被回收,相关数据会全部丢失且不可修复。

  2. 批量删除实例资源最大支持50台。

  3. 若deletePublicNetwork(是否删除实例关联的弹性公网IP)或者deleteDataVolumes(是否删除实例挂载的数据盘)为true,批量删除最大支持20台。

  4. RAM用户批量操作数量限制10台。

  5. 弹性伸缩实例无法进行删除操作。


推荐使用API Explorer调试

API Explorer支持接口在线可视化调用,同时自动生成动态代码示例,搭配OpenAPI SDK无需计算签名实现接口快速集成。

URL

POST https://ecloud.10086.cn/api/openapi-instance/v4/delete-instances

请求参数

Body

参数名称
类型
必填
描述
batchDeleteInstanceReq
BatchDeleteInstanceReq
是

batchDeleteInstanceReq

instanceIds
<string> array
是

实例ID数组,可通过查询实例状态列表接口获取。

deletePublicNetwork
boolean
否

是否删除实例绑定的弹性公网IP。取值范围:

  • true:删除关联实例的弹性公网IP资源。
  • false:不删除关联实例的弹性公网IP资源。

默认值:false。

deleteDataVolumes
boolean
否

是否删除实例挂载的数据盘。取值范围:

  • true:删除关联实例的数据盘资源。
  • false:不删除关联实例的数据盘资源。

默认值:false。

dryRun
boolean
否

资源删除预检参数。取值范围:

  • true:发送检查请求,不会删除资源。如果检查不通过,则返回对应错误;如果检查通过,则返回错误码DryRunOperation。
  • false: 发送正常请求,通过检查后直接删除资源。

默认值:false。

请求示例

POST https://ecloud.10086.cn/api/openapi-instance/v4/delete-instances
{
	"instanceIds":[
		"6a67d90c-4dc1-444f-8c18-c1eb97a1536e",
		"5667d90c-4dc1-444f-8c18-c1et57a1555e"
	],
	"deletePublicNetwork":true,
	"deleteDataVolumes":true
}

返回参数

返回码:200
OK
参数名称
类型
描述
body
BatchAction«InstanceActionResult»

请求成功时返回的数据。

instanceBatchResult
<InstanceActionResult> array

实例批量操作结果集。

instanceId
string

实例ID。

result
boolean

操作是否下发成功。

message
string

操作结果信息,失败时返回错误信息,成功时返回空字符串。

errorCode
string

统一错误码。

errorMessage
string

页面国际化错误提示。

errorParams
<string> array

统一错误码的自定义参数。

requestId
string

每个请求的序列号。

state
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)

返回状态码。返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN。

返回示例

返回码:200
OK
{
	"body":{
		"instanceBatchResult":[
			{
				"instanceId":"6a67d90c-4dc1-444f-8c18-c1eb97a1536e",
				"result":true
			},
			{
				"instanceId":"5667d90c-4dc1-444f-8c18-c1et57a1555e",
				"result":false,
				"message":"实例不存在"
			}
		]
	},
	"requestId":"reqId-14b1195bcd99f9f037a07-8f5afe7d-8",
	"state":"OK"
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。