Delete an IPAM address pool by calling the DeleteIpamPool API - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Deletes an IPAM pool instance.

Operation description

Usage notes

Before deleting a parent pool, make sure that all subpools under the parent pool have been deleted.
When a parent pool has an effective region configured and has addresses that have already been allocated, the parent pool cannot be deleted.
When a subpool has an effective region configured and has addresses that have already been allocated, the subpool cannot be deleted.
When a pool has a sharing relationship, the pool cannot be deleted.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the IPAM managed region. You can call the DescribeRegions operation to obtain the region ID.	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 without actually deleting the IPAM pool instance. The system checks whether the required parameters are specified, the request format is valid, and the instance status is correct. If the check fails, the corresponding error is returned. If the check succeeds, DryRunOperation is returned. false (default): sends a normal request. After the request passes the check, an HTTP 2xx status code is returned and the operation is directly 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 value, but you must make sure that the value is unique among different requests. The ClientToken value can contain only ASCII characters. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object	The returned information list.
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.
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.