接口说明
取消实例续订未生效订单。
注意事项:
-
最多支持20台实例。
-
支持取消还未生效的续订订单。
-
支持包年包月实例,不支持按量计费实例。
-
不支持边缘实例、专属宿主机上实例和弹性伸缩实例。
URL
POST https://ecloud.10086.cn/api/openapi-instance/v4/cancel-renew-instances
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
batchCancelRenewReq
|
BatchCancelRenewReq
|
是
|
batchCancelRenewReq |
|
instanceIds
|
<string> array
|
是
|
实例ID数组。可通过查询实例状态列表接口获取。 |
请求示例
POST https://ecloud.10086.cn/api/openapi-instance/v4/cancel-renew-instances
{
"instanceIds":[
"78cse2f9-23e5-4fca-xs3a-4f416d5188ae",
"00014ed8-7e91-42c3-8b6d-8878720431a9"
]
}
返回参数
返回码: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":"78cse2f9-23e5-4fca-xs3a-4f416d5188ae",
"result":true,
"message":""
},
{
"instanceId":"00014ed8-7e91-42c3-8b6d-8878720431a9",
"result":true,
"message":""
}
]
},
"requestId":"reqId-009623s4a556322e0d840-a7716046-1",
"state":"OK"
}