Deletes a provisioned CIDR block from an IP Address Manager (IPAM) pool.
Operation description
-
If CIDR blocks are provisioned in both a parent pool and its sub-pools, delete the CIDR blocks from the sub-pools before you delete the CIDR block from the parent pool.
-
If a CIDR block is provisioned only in a parent pool, you can delete the CIDR block directly from the parent pool.
-
If allocations exist from the provisioned CIDR block, delete the allocations before you delete the CIDR block.
-
Requests to delete a provisioned CIDR block from an IPAM pool must be sent from the region where the IPAM is deployed.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The ID of the region where the IPAM is hosted. For more information, see DescribeRegions. |
cn-hangzhou |
| IpamPoolId |
string |
Yes |
The ID of the IPAM pool. |
ipam-pool-6rcq3tobayc20t**** |
| Cidr |
string |
Yes |
The provisioned CIDR block to delete. Note
Only IPv4 CIDR blocks are supported. |
192.168.1.0/24 |
| DryRun |
boolean |
No |
Specifies whether to perform a dry run. Valid values:
|
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 automatically uses the request ID as the client token. The request ID can differ for each request. |
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. | |
| 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.