调用DeletePublicIpAddressPool接口删除IP地址池。

使用说明

  • DeletePublicIpAddressPool接口属于异步接口,即系统会先返回一个请求ID,但IP地址池并未删除完成,系统后台的删除任务仍在进行。您可以调用ListPublicIpAddressPools查询IP地址池的状态。
    • 当IP地址池处于Deleting状态时,表示IP地址池正在删除中,在该状态下,您只能执行查询操作,不能执行其他操作。
    • 当查询不到该IP地址池时,表示IP地址池删除完成。
  • DeletePublicIpAddressPool接口不支持并发删除同一个IP地址池。

前提条件

删除IP地址池前,请确保该地址池内的IP地址没有被使用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DeletePublicIpAddressPool

系统规定参数。取值:DeletePublicIpAddressPool

PublicIpAddressPoolId String pippool-6wetvn6fumkgycssx****

IP地址池的实例ID。

ClientToken String 0c593ea1-3bea-11e9-b96b-88e9fe60000

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

DryRun Boolean false

是否只预检此次请求。取值:

  • true:发送检查请求,不会删除地址池。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回HTTP 2xx状态码并直接进行操作。
RegionId String cn-chengdu

要创建的IP地址池所在的地域ID。

返回数据

名称 类型 示例值 描述
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DeletePublicIpAddressPool
&PublicIpAddressPoolId=pippool-6wetvn6fumkgycssx****
&ClientToken=0c593ea1-3bea-11e9-b96b-88e9fe6****
&DryRun=false
&RegionId=cn-chengdu
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DeletePublicIpAddressPoolResponse>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
</DeletePublicIpAddressPoolResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}

错误码

HttpCode 错误码 错误信息 描述
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地址池实例是共享资源,不允许修改。

访问错误中心查看更多错误码。