实例放入回收站

接口说明


将实例加入回收站(支持批量)。回收站内实例保留7天,如7天内未进行实例恢复,系统彻底删除资源。如4月20日19:00:00加入回收站,4月27日19:00:00资源彻底删除。

注意事项:

  1. 一次最多操作10台实例加入回收站,互联网用户不支持批量操作。

  2. 仅支持实例及对应系统盘加入回收站,如果实例绑定数据盘、公网 IP、云存储网关等资源则不允许加入回收站。

  3. 回收站中实例恢复时,存在因资源不足而无法恢复的风险,请谨慎操作。

  4. 处于退订保护的实例无法加入回收站。

  5. 实例自动退订时间不足七天,需取消自动退订后再加入回收站。

  6. 同一实例仅允许加入回收站 3 次。

  7. 每个资源池回收站内实例限制 20 个,如超出需要退订回收站内资源。

  8. 已冻结的实例不支持加入回收站。

  9. 专属宿主机上实例不支持加入回收站。


推荐使用API Explorer调试

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

URL

POST https://ecloud.10086.cn/api/openapi-instance/v4/add-to-recycle-bin

请求参数

Body

参数名称
类型
必填
描述
batchActionReq
BatchActionReq
是

batchActionReq

instanceIds
<string> array
是

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

请求示例

POST https://ecloud.10086.cn/api/openapi-instance/v4/add-to-recycle-bin
{
	"instanceIds":[
		"6a67d90c-4dc1-444f-8c18-c1eb97a1536e",
		"5667d90c-4dc1-444f-8c18-c1et57a1555e"
	]
}

返回参数

返回码: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
{
	"requestId":"reqId-69d193dd-d316-446e-8a49-***",
	"state":"OK",
	"body":{
		"instanceBatchResult":[
			{
				"instanceId":"86380653-e311-4323-95df-***",
				"result":true,
				"message":null
			},
			{
				"instanceId":"ae2faccd-adba-4d7c-b0be-***",
				"result":true,
				"message":null
			},
			{
				"instanceId":"88ad8cbe-8f0a-4da3-9783-***",
				"result":true,
				"message":null
			},
			{
				"instanceId":"c38e108d-46e9-4f3e-9771-***",
				"result":true,
				"message":null
			}
		]
	}
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。