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

Operation description

If CIDR blocks are preset in both the parent pool and the child pool, you must delete the CIDR block from the child pool before you delete the CIDR block from the parent pool.
If a CIDR block is preset only in the parent pool, you can directly delete the CIDR block from the parent pool.
If allocations are created under the preset CIDR block, you must delete the allocations before you delete the CIDR block.
Requests to delete a preset CIDR block from an IPAM pool must be initiated from the IPAM hosted region.

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

delete

*IpamPool

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the IPAM hosted region. You can call the DescribeRegions operation to retrieve the region ID.	cn-hangzhou
IpamPoolId	string	Yes	The instance ID of the IPAM pool.	ipam-pool-6rcq3tobayc20t****
Cidr	string	Yes	The preset CIDR block that you want to delete. Note Only IPv4 CIDR blocks are supported.	192.168.1.0/24
DryRun	boolean	No	Specifies whether to perform a dry run for the request. Valid values: true: performs a dry run and does not delete the CIDR block from the IPAM pool. The system checks whether required parameters are specified, the request format is valid, and service limits are met. If the request fails the dry run, an error is returned. If the request passes the dry run, the DryRunOperation error code is returned. false (default): sends the actual request. If the request passes the dry run, an HTTP 2xx status code is returned and the CIDR block is deleted.	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, and you must ensure 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	BaseResult
RequestId	string	The request ID.	F28A239E-F88D-500E-ADE7-FA5E8CA3A170

Examples

Success response

JSON format

{
  "RequestId": "F28A239E-F88D-500E-ADE7-FA5E8CA3A170"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ResourceNotFound.IpamPoolCidr	The specified resource of IPAM pool CIDR is not found.	The CIDR block of the IPAM pool does not exist.
400	OperationDenied.PoolRegionNotSupportDeletePoolCidr	The operation is not allowed because pool region does not support deleting cidr.	You cannot delete CIDR blocks in this region.
400	OperationDenied.IpamPoolAllocationExist	The operation is not allowed because of the existence of IPAM pool allocation.	The operation is not allowed because an allocation exists.
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.
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.