DeleteIpamPool - Virtual Private Cloud - Alibaba Cloud Documentation Center

Deletes an IP Address Manager (IPAM) scope.

Operation description

Usage notes

Before you delete a parent pool, make sure that all subpools of the parent pool are deleted.
If an effective region is specified for a parent pool and IP addresses are allocated from the parent pool, you cannot delete the parent pool.
If an effective region is specified for a subpool and IP addresses are allocated from the subpool, you cannot delete the subpool.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:DeleteIpamPool	delete	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the IPAM instance is hosted. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
IpamPoolId	string	Yes	The ID of the IPAM pool.	ipam-pool-6rcq3tobayc20t****
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 message is returned. If the request passes the dry run, DryRunOperation 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
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. Usage notes** If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-426655440000

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	57B7DCCA-F192-5528-8AF3-2FE1413228C9

Examples

Sample success responses

JSONformat

{
  "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.	-
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.
404	ResourceNotFound.IpamPool	The dependent IPAM pool is not found.	The IPAM pool does not exist.

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

Change history

Change time	Summary of changes	Operation
2024-09-12	The Error code has changed	View Change Details