CreateIpamPoolAllocation - Virtual Private Cloud - Alibaba Cloud Documentation Center

Creates a custom reserved CIDR block from an IPAM pool.

Operation description

Before you create a custom reserved CIDR block, ensure that you have created an IPAM pool and added a CIDR block to it. You can call the CreateIpamPool operation to create an IPAM pool and the AddIpamPoolCidr operation to add a CIDR block to the pool.
When you specify the Cidr or CidrMask parameter to create a custom reserved CIDR block, the mask must be within the range specified for the IPAM pool.
If an IPAM pool has a region attribute, the request to create a custom reserved CIDR block must be initiated from the region where the pool is located.
The custom reserved CIDR block must not conflict with existing CIDR block allocations in the IPAM pool.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where you want to create the custom reserved CIDR block. You can call DescribeRegions to obtain the region ID.	cn-hangzhou
IpamPoolId	string	Yes	The ID of the IPAM pool.	ipam-pool-6rcq3tobayc20t****
Cidr	string	No	The CIDR block to allocate from the IPAM pool. Note You must specify either the Cidr or CidrMask parameter.	192.168.1.0/24
CidrMask	integer	No	The mask of the CIDR block to allocate from the IPAM pool. Note You must specify either the Cidr or CidrMask parameter.	24
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Sends a check request. The custom reserved CIDR block is not created. The system checks for required parameters, request format, and service limits. If the check fails, an error is returned. If the check passes, the DryRunOperation error code is returned. false (default): Sends a normal request. After the request passes the check, a 2xx HTTP status code is returned and the custom reserved CIDR block is created.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a value on your client to make sure that the value is unique among different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the request as the ClientToken. The RequestId may be different for each request.	123e4567-e89b-12d3-a456-426655440000
IpamPoolAllocationDescription	string	No	The description of the custom reserved CIDR block. The description must be 1 to 256 characters in length. It must start with a letter or a Chinese character and cannot start with `http://` or `https://`. The default value is an empty string.	test description
IpamPoolAllocationName	string	No	The name of the custom reserved CIDR block. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.	test name

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	CE9CDAE5-341E-5D0B-AC8A-2BAC707D3EB2
IpamPoolAllocationId	string	The ID of the custom reserved CIDR block.	ipam-pool-alloc-112za33e4****
Cidr	string	The allocated CIDR block.	192.168.1.0/24
SourceCidr	string	The source CIDR block.	192.168.0.0/16

Examples

Success response

JSON format

{
  "RequestId": "CE9CDAE5-341E-5D0B-AC8A-2BAC707D3EB2",
  "IpamPoolAllocationId": "ipam-pool-alloc-112za33e4****",
  "Cidr": "192.168.1.0/24",
  "SourceCidr": "192.168.0.0/16"
}

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	MissingParam.CidrOrCidrMask	The CIDR or CIDR Mask must be input.	The CIDR or CIDR Mask must be input.
400	OperationDenied.IpamPoolNotInRegion	The operation is not allowed because the IPAM pool not in specific region does not support creating VPC or associating CIDR for VPC.	The operation is not allowed because the IPAM pool not in specific region does not support creating VPC or associating CIDR for VPC.
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	IllegalParam.Cidr	The specified CIDR is illegal.	The CIDR block is invalid.
400	IllegalParam.CidrMask	The specified CidrMask is illegal.	Invalid CidrMask.
400	DryRunOperation	Request validation has been passed with DryRun flag set.
400	OperationDenied.AvailableCidrInsufficient	The operation is not allowed because available CIDR is insufficient.	The operation is not allowed because available CIDR is insufficient.
400	OperationDenied.CidrInExcludeCidrs	The operation is not allowed because the input CIDR is within the illegal CIDRs.	The operation is not allowed because the input CIDR is within the illegal CIDRs.
400	OperationDenied.CidrUnavailableInPool	The operation is not allowed because the CIDR is unavailable in the IPAM pool.	The operation is not allowed because the CIDR is unavailable in the IPAM pool.
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.