TerminateDdosIpAddress

1. 接口描述

本接口用于退还一个Ddos IP。

注意事项

不再使用的Ddos IP，可通过本接口主动退还。如果是后付费，退还的Ddos IP将停止计费。
本接口无法主动退还预付费订阅模式的Ddos IP，订阅模式的 Ddos IP将会在订阅到期后自动退还。
退还后的 Ddos IP将进入回收站，进入回收站后如无其他操作 Ddos IP将在24小时后自动释放，也可以调用ReleaseDdosIpAddresses接口主动进行释放。
该接口只能被状态处于 AVAILABLE 或 ASSOCIATED 或 CREATE_FAILED 或 RECYCLE 的Ddos IP调用。
对于创建失败状态为 CREATE_FAILED的Ddos IP，会自动退还所有的已支付金额。
处于 ASSOCIATED 状态的Ddos IP，系统会将Ddos IP与机器解绑。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称

必选

类型

描述

ddosIpId

是

String

一个Ddos IP ID。

可通过DescribeDdosIpAddresses接口返回值中的ddosIpId 获取。

3. 响应结果

参数名称

类型

描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 代码示例

1. 退还指定ID的Ddos IP

退还指定的Ddos IP。

POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: TerminateDdosIpAddress
<Common Request Params>

Request：
{
    "ddosIpId": "ddosIpId"
}

Response：
{
   "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
   "response": { 
      "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
   }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码

错误码

说明

404

INVALID_DDOS_IP_NOT_FOUND

指定的Ddos IP不存在。

403

OPERATION_DENIED_DDOS_IP_SUBSCRIPTION

订阅模式的Ddos IP不支持该操作。

403

OPERATION_DENIED_DDOS_IP_RECYCLED

已经在回收站中的Ddos IP不支持该操作。

最后更新于1年前