Use DeleteIpamPoolAllocation to release a CIDR allocation from an IPAM pool - Virtual Private Cloud

Releases a CIDR allocation from an IP Address Management (IPAM) address pool. Supported allocation types include virtual private cloud (VPC) and custom allocation.

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 ID of the region where the CIDR block allocation that you want to release is located. You can call the DescribeRegions operation to obtain the region ID.	cn-hangzhou
IpamPoolAllocationId	string	Yes	The ID of the CIDR block allocation that you want to release.	ipam-alloc-c4vhvr3b22mmc6****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request format, and service limits. The CIDR block allocation is not released. If the check fails, an error message is returned. If the check succeeds, the `DryRunOperation` error code is returned. false (default): sends a normal request. If the request passes the check, a 2xx HTTP status code is returned and the CIDR block allocation is released.	false
ClientToken	string	No	Ensures idempotency. Provide a unique ASCII token generated by your client. A new token is provided for each distinct request. Note If you do not specify this parameter, the system uses the RequestId as the ClientToken. The RequestId is unique for each request.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	B90776C8-F703-51D5-893A-AD1CA699D535

Examples

Success response

JSON format

{
  "RequestId": "B90776C8-F703-51D5-893A-AD1CA699D535"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationDenied.ResourceTypeIsNotCustom	The operation is not allowed because the resource type is not Custom.	The operation is not allowed because the resource type is not Custom.
400	DryRunOperation	Request validation has been passed with DryRun flag set.
400	ResourceNotFound.IpamPoolAllocation	The specified resource of IPAM pool allocation is not found.	The specified allocation does not exist.
400	OperationDenied.UnexpectedResourceType	The operation is not allowed because the resource type is unexpected.	The operation is not allowed because the resource type is unexpected.
400	OperationDenied.Unauthorized	The operation is denied because the user is not authorized.	The operation is denied because the user is not authorized.
400	OperationDenied.RequestRegionInvalid	The operation is not allowed because the request is not invoked in the region of the IPAM pool.	The operation is not called in the region of the pool.
400	OperationDenied.Ipv6VpcNotSupport	The allocation of IPv6 VPC is not supported to delete.	The allocation of IPv6 VPC is not supported to delete.
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.