接口说明
本接口用于退订云主机。
说明:
- 弹性伸缩云主机无法进行退订操作。
- 仅可执行退订操作的云主机支持关联的云硬盘和弹性公网IP一起退订。
- 关联的云硬盘和弹性公网IP资源如无法退订请将云硬盘或弹性公网IP资源参数取消后再继续退订,不影响云主机和系统盘正常退订,无法退订的云硬盘或弹性公网IP资源保留并继续计费。
- 绑定IPv6带宽的云主机需解绑后退订。
接口更新历史:
| 序号 | 接口更新时间 | 更新类型 | 接口更新内容 |
|---|---|---|---|
| 1 | 2024年5月 | 新增参数 | 1.增加退订预检参数dryRun |
URL
DELETE https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/order/{serverId}
请求参数
Path
|
参数名称
|
类型
|
必填
|
描述
|
|
serverId
|
string
|
是
|
云主机ID,可通过主机列表详情接口获取 |
Query
|
参数名称
|
类型
|
必填
|
描述
|
|
publicIpDelete
|
boolean
|
否
|
是否一起退订IPv4,true:是,false:否。 |
|
dataVolumeDelete
|
boolean
|
否
|
是否一起退订云硬盘,true:是,false:否。 |
|
dryRun
|
boolean
|
否
|
资源退订预检参数。 |
请求示例
DELETE https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/order/{serverId}
返回参数
返回码:200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
enum(ALLOW,TEMP_DENY,FOREVER_DENY)
|
请求成功时返回的数据:ALLOW(可操作),TEMP_DENY(置灰),FOREVER_DENY(不可见) |
|
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-635d9746fba0295333136-99563e8e-1",
"state":"OK",
"body":"ALLOW"
}