DeleteIpamPoolAllocation - Virtual Private Cloud - Alibaba Cloud Documentation Center

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

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

delete

*IpamPool

acs:vpc:{#regionId}:{#accountId}:ipampool/{#IpamPoolId}

None

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.