调用DeletePublicIpAddressPool接口删除IP地址池。
接口说明
在调用本接口时,请了解以下内容:
-
删除 IP 地址池前,请确保该地址池内的 IP 地址没有被使用。
-
DeletePublicIpAddressPool 接口属于异步接口,即系统会先返回一个请求 ID,但 IP 地址池并未删除完成,系统后台的删除任务仍在进行。您可以调用 ListPublicIpAddressPools 查询 IP 地址池的状态。
-
当 IP 地址池处于 Deleting 状态时,表示 IP 地址池正在删除中,在该状态下,您只能执行查询操作,不能执行其他操作。
-
当查询不到该 IP 地址池时,表示 IP 地址池删除完成。
-
-
DeletePublicIpAddressPool 接口不支持并发删除同一个 IP 地址池。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PublicIpAddressPoolId | string | 是 | IP 地址池的实例 ID。 | pippool-6wetvn6fumkgycssx**** |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 | 0c593ea1-3bea-11e9-b96b-88e9fe60000 |
DryRun | boolean | 否 | 是否只预检此次请求。取值:
| false |
RegionId | string | 是 | 要创建的 IP 地址池所在的地域 ID。 | cn-chengdu |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IncorrectStatus.PublicIpAddressPool | The status of PublicIpAddressPool [%s] is incorrect. | - |
400 | ResourceInUse.PublicIpAddressPool | The specified resource of PublicIpAddressPool [%s] is in use. | - |
400 | OperationFailed.ResourceIsShared | The operation is failed because of PublicIpAddressPool is shared with other users. | 公网IP地址池已经共享给其他用户,不允许删除。 |
400 | OperationDenied.OperateSharedResource | The operation is not allowed because of the PublicIpAddressPool is a shared resource. | 该公网IP地址池实例是共享资源,不允许修改。 |
400 | ResourceNotFound.PublicIpAddressPool | The specified resource of PublicIpAddressPool [%s] is not found. | 指定的公网IP地址池实例不存在 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-06-26 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |