Delete a Public IP Address Pool Using DeletePublicIpAddressPool API - Elastic IP Address - Alibaba Cloud - Elastic IP Address

Operation description

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

Before you delete an IP address pool, make sure that the IP addresses in the pool are not in use.
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 ListPublicIpAddressPools to query the status of the 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 perform query operations.
- If the IP address pool cannot be found, the IP address pool is deleted.
You cannot call DeletePublicIpAddressPool to concurrently delete the same IP address pool.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DeletePublicIpAddressPool

delete

*PublicIpAddressPool

acs:vpc:{#regionId}:{#accountId}:publicipaddresspool/{#PublicIpAddressPoolId}

None

Request parameters

Parameter	Type	Required	Description	Example
PublicIpAddressPoolId	string	Yes	The instance ID of the IPAM pool.	pippool-6wetvn6fumkgycssx****
ClientToken	string	No	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
DryRun	boolean	No	Specifies whether to perform only 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 code 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, an HTTP 2xx status code is returned and the operation is directly performed.	false
RegionId	string	Yes	The region ID of the IP address pool.	cn-chengdu

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The request ID.	4EC47282-1B74-4534-BD0E-403F3EE64CAF

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
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.	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 public IP address pool is a shared resource and cannot be modified.
400	ResourceNotFound.PublicIpAddressPool	The specified resource of PublicIpAddressPool [%s] is not found.	The specified public IP address pool does not exist.
400	Forbidden.MinimumHoldingPeriod	The EIP is within its minimum holding period.	Local ISP can only be released after 30 days of creation. If you want to delete it, please do so after 30 days.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.