All Products
Search

This Product

    Elastic IP Address:DeletePublicIpAddressPool

    Document Center

    Elastic IP Address:DeletePublicIpAddressPool

    Last Updated:Mar 22, 2024

    Deletes an IP address pool.

    Operation description

    Before you call this operation, take note of the following items:

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

    • DeletePublicIpAddressPool is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the ListPublicIpAddressPools operation to query the status of the task.

      • 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.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    vpc:DeletePublicIpAddressPoolWrite
    • PublicIpAddressPool
      acs:vpc:{#regionId}:{#accountId}:publicipaddresspool/{#PublicIpAddressPoolId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    PublicIpAddressPoolIdstringYes

    The ID of the IP address pool.

    		pippool-6wetvn6fumkgycssx****
    ClientTokenstringNo

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

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

    		0c593ea1-3bea-11e9-b96b-88e9fe60000
    DryRunbooleanNo

    Specifies whether to perform a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service 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 performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    		false
    RegionIdstringYes

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

    		cn-chengdu

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		4EC47282-1B74-4534-BD0E-403F3EE64CAF

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400ResourceNotFound.PublicIpAddressPoolThe specified resource ofPublicIpAddressPool [%s] is not found.-
    400IncorrectStatus.PublicIpAddressPoolThe status of PublicIpAddressPool [%s] is incorrect.-
    400ResourceInUse.PublicIpAddressPoolThe specified resource of PublicIpAddressPool [%s] is in use.-
    400OperationFailed.ResourceIsSharedThe operation is failed because of PublicIpAddressPool is shared with other users.The public IP address pool is shared with another user and cannot be deleted.
    400OperationDenied.OperateSharedResourceThe operation is not allowed because of the PublicIpAddressPool is a shared resource.The public IP address pool is a shared resource and cannot be modified.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history