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

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 the pool. You can call the CreateIpamPool and AddIpamPoolCidr operations to create an IPAM pool and add a CIDR block to the pool, respectively.
When you specify the Cidr or CidrMask parameter to create a custom reserved CIDR block, the corresponding mask must fall within the range specified for the IPAM pool.
If the IPAM pool has a region attribute, the request to create a custom reserved CIDR block must be initiated from the region where the pool resides.
The custom reserved CIDR block to be created must not conflict with existing CIDR 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 region ID of the custom reserved CIDR block to be created. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
IpamPoolId	string	Yes	The instance ID of the IPAM pool.	ipam-pool-6rcq3tobayc20t****
Cidr	string	No	The CIDR block used to create a custom reserved CIDR block from the IPAM pool. Note You must specify at least one of the Cidr and CidrMask parameters.	192.168.1.0/24
CidrMask	integer	No	The CIDR mask used to create a custom reserved CIDR block from the IPAM pool. Note You must specify at least one of the Cidr and CidrMask parameters.	24
DryRun	boolean	No	Specifies whether to only precheck the request. Valid values: true: prechecks the request without creating the custom reserved CIDR block. The system checks whether required parameters are specified, the request format is valid, and service limits are met. If the request fails the precheck, an error is returned. If the request passes the precheck, the DryRunOperation error code is returned. false (default): sends the request. If the request passes the precheck, an HTTP 2xx 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. You can use the client to generate the value, but you must ensure that the value 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
IpamPoolAllocationDescription	string	No	The description of the custom reserved CIDR block. The description must be 1 to 256 characters in length and must start with a letter or a Chinese character. It cannot start with `http://` or `https://`. If you do not specify this parameter, it is empty by default.	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 list of returned information.
RequestId	string	The request ID.	CE9CDAE5-341E-5D0B-AC8A-2BAC707D3EB2
IpamPoolAllocationId	string	The instance ID of the created custom reserved CIDR block.	ipam-pool-alloc-112za33e4****
Cidr	string	The created custom reserved 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.	The DryRun validation passed.
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.
400	OperationDenied.CidrMaskTooLarge	The operation is denied because the CIDR mask %s is larger than the allocationMaxNetmask %s of the pool.	The operation is denied because the CIDR mask %s is larger than the allocationMaxNetmask %s of the pool.
400	OperationDenied.CidrMaskTooSmall	The operation is denied because the CIDR mask %s is less than the allocationMinNetmask %s of the pool.	The operation is denied because the CIDR mask %s is less than the allocationMinNetmask %s of the 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.