Deletes an IP address pool.

Usage notes

  • The DeletePublicIpAddressPool operation is asynchronous. After you send the request, the system returns a request ID. However, the operation is still being performed in the system background. You can call the ListPublicIpAddressPools operation to query the status of an IP address pool:
    • If the IP address pool is in the Deleting state, the IP address pool is being deleted. In this state. you can only query the IP address pool and cannot perform other operations.
    • If you cannot query the IP address pool, the IP address pool is deleted.
  • You cannot repeatedly call the DeletePublicIpAddressPool operation to delete an IP address pool within the specified period of time.

Prerequisites

Before you delete an IP address pool, make sure that no IP address in the pool is being used.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DeletePublicIpAddressPool

The operation that you want to perform. Set the value to DeletePublicIpAddressPool.

PublicIpAddressPoolId String Yes pippool-6wetvn6fumkgycssx****

The ID of the IP address pool.

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

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that it is unique among different requests. The client token can contain only ASCII characters.

DryRun Boolean No false

Specifies whether to perform a dry run. Valid values:

  • true: performs a dry run. The system checks the required parameters, request syntax, and limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
  • false (default): performs a dry run and sends the request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
RegionId String Yes cn-chengdu

The ID of the region where you want to create the IP address pool.

Response parameters

Parameter Type Example Description
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DeletePublicIpAddressPool
&PublicIpAddressPoolId=pippool-6wetvn6fumkgycssx****
&ClientToken=0c593ea1-3bea-11e9-b96b-88e9fe6****
&DryRun=false
&RegionId=cn-chengdu
&Common request parameters

Sample success responses

XML format

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

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

JSON format

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

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

Error codes

HttpCode Error code Error message Description
400 OperationFailed.ResourceIsShared The operation is failed because of PublicIpAddressPool is shared with other users. The error message returned because the public IP address pool is shared with another user and cannot be deleted.
400 OperationDenied.OperateSharedResource The operation is not allowed because of the PublicIpAddressPool is a shared resource. The error message returned because the public IP address pool is a shared resource and cannot be modified.

For a list of error codes, see Service error codes.