DeleteIpamPool-Virtual Private Cloud(VPC)-阿里云帮助中心

Deletes an IPAM pool instance.

Operation description

Usage notes

Before deleting a parent pool, ensure that all subpools under the parent pool have been deleted.
You cannot delete a parent pool if an effective region is configured for the parent pool and the parent pool has allocated IP addresses.
You cannot delete a subpool if an effective region is configured for the subpool and the subpool has allocated IP addresses.
You cannot delete a pool if the pool is shared.

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:DeleteIpamPool

delete

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the hosted region for IPAM. You can call the DescribeRegions operation to query region IDs.	cn-hangzhou
IpamPoolId	string	Yes	The instance ID of the IPAM pool.	ipam-pool-6rcq3tobayc20t****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run and does not delete the IPAM pool instance. The system checks whether required parameters are specified, the request format is valid, and the instance status is normal. 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): sends a normal request. If the request passes the dry run, an HTTP 2xx status code is returned and the operation is performed.	false
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 client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the client token. The RequestId of each API request is unique.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object	The list of returned information.
RequestId	string	The request ID.	57B7DCCA-F192-5528-8AF3-2FE1413228C9

Examples

Success response

JSON format

{
  "RequestId": "57B7DCCA-F192-5528-8AF3-2FE1413228C9"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationDenied.PoolRegionNotSupportDeletePool	The operation is not allowed because of pool region not support delete.	The operation was denied because the delete address pool operation could not be performed in the domain.
400	DependencyViolation.SubCidr	The specified resource of %s depends on %s, so the operation cannot be completed.	The specified resource is dependent on other resources and the current operation is not allowed.
400	DependencyViolation.CustomCidrs	The specified resource of %s depends on %s, so the operation cannot be completed.	The specified resource is dependent on other resources and the current operation is not allowed.
400	Forbidden.SubPool	The IPAM pool contains subpools.	The IPAM address pool contains subpools and cannot be deleted.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	The DryRun validation passed.
400	OperationDenied.OperateShareResource	The operation is not allowed because the instance is a shared resource.	The operation is not allowed because the instance is a shared resource.
400	IncorrectStatus.IpamPool	The status of the IPAM pool is incorrect.	The status of the IPAM pool is incorrect.
400	DependencyViolation.ShareResource	The specified resource of IPAM pool depends on resource sharing, so the operation cannot be completed.	The specified resource of IPAM pool depends on resource sharing, so the operation cannot be completed.
400	DependencyViolation.PoolCidr	The operation is not allowed because the IpamPool has pool CIDR dependency %s.	The IpamPool cannot be deleted because it has pool CIDR dependency %s.
400	OperationDenied.IpamPoolAllocationExist	The operation is not allowed because the IpamPool has existing allocations.	The IpamPool cannot be deleted because it has existing allocations.
400	DependencyViolation.CustomPoolAllocation	The operation is not allowed because the IpamPool has custom pool allocation dependency.	The IpamPool cannot be deleted because it has custom pool allocation dependency.
404	ResourceNotFound.IpamPool	The dependent IPAM pool is not found.	The IPAM pool does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.