接口说明
设置/取消自动退订实例及系统盘不含关联的数据盘和公网IP/带宽(支持批量)。
设置自动退订时请谨慎操作,配置的时间到期后将自动退订ECS实例。
注意事项:
-
仅按量付费实例支持设置/取消自动退订。
-
设置自动退订时间,使用GMT+8的时区时间,格式为yyyy-MM-dd HH:mm:ss;最短退订时间为当前时间1小时之后;如果不传入参数autoReleaseTime,表示取消自动退订功能,实例资源不再自动退订。
-
专属宿主机上云主机不支持。
URL
POST https://ecloud.10086.cn/api/openapi-instance/v4/modify-auto-release
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
batchModifyAutoReleaseReq
|
BatchModifyAutoReleaseReq
|
是
|
batchModifyAutoReleaseReq |
|
instanceBatchAutoReleases
|
<ModifyAutoReleaseReq> array
|
是
|
实例批量设置/取消自动退订请求体。 |
|
instanceId
|
string
|
是
|
实例ID,可通过查询实例状态列表接口获取。 |
|
autoReleaseTime
|
string
|
否
|
自动退订时间,如需设置自动退订时间则传yyyy-MM-dd HH:mm:ss格式,如取消自动退订则不传该参数。 |
请求示例
POST https://ecloud.10086.cn/api/openapi-instance/v4/modify-auto-release
{
"instanceBatchAutoReleases":[
{
"autoReleaseTime":"2014-12-31 12:00:00",
"instanceId":"42se3721-hf4c-4d14-wek4-1ed8775155f4"
},
{
"autoReleaseTime":"2014-12-31 11:00:00",
"instanceId":"42se3721-hf4c-4d14-wek4-1ed87751551a"
}
]
}
返回参数
返回码: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-79aa6022dabc4f2488f4-8e359238-7",
"state":"OK",
"body":{
"instanceBatchResult":[
{
"instanceId":"42se3721-hf4c-4d14-wek4-1ed8775155f4",
"result":true,
"message":""
},
{
"instanceId":"42se3721-hf4c-4d14-wek4-1ed87751551a",
"result":true,
"message":""
}
]
}
}