CreateIpamPool - Virtual Private Cloud - Alibaba Cloud Documentation Center

Creates an IP Address Manager (IPAM) pool.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:CreateIpamPool	create	IpamPool `acs:vpc:{#regionId}:{#accountId}:ipamscope/`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the IPAM instance is hosted. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
IpamScopeId	string	Yes	The ID of the IPAM scope.	ipam-scope-glfmcyldpm8lsy****
IpamPoolName	string	No	The name of the IPAM pool. It must be 1 to 128 characters in length and cannot start with `http://` or `https://`.	abc
IpamPoolDescription	string	No	The description of the IPAM pool. It must be 2 to 256 characters in length. It must start with a letter, but cannot start with a `http://` or `https://`. This parameter is empty by default.	test description
ResourceGroupId	string	No	The resource group ID.	rg-acfmxazb4ph6aiy****
PoolRegionId	string	No	The effective region of the IPAM pool.	cn-hangzhou
SourceIpamPoolId	string	No	The ID of the source IPAM pool. Note If you do not specify this parameter, the pool is a parent pool.	ipam-pool-6rcq3tobayc20t****
AllocationDefaultCidrMask	integer	No	The default network mask assigned to the IPAM pool. An IPv4 mask must be 0 to 32 bits in length.	28
AllocationMaxCidrMask	integer	No	The maximum network mask assigned to the IPAM pool. An IPv4 mask must be 0 to 32 bits in length.	32
AllocationMinCidrMask	integer	No	The minimum network mask assigned to the IPAM pool. An IPv4 mask must be 0 to 32 bits in length.	8
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned. false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	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, but you must make sure 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 request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-426655440000
IpVersion	string	No	The IP version. Only IPv4 is supported.	IPv4
AutoImport	boolean	No	Whether the pool has the auto-import feature enabled.	true
Tag	array<object>	No	The tag list.
Tag	object	No
Key	string	No	The tag key. You can specify at most 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The tag key must start with a letter but cannot start with `aliyun` or `acs:`. The tag key cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It cannot start with a `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceJoshua

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	BB2C39DE-CEB8-595A-981A-F2EFCBE7324E
IpamPoolId	string	The ID of the IPAM pool.	ipam-pool-6rcq3tobayc20t****

Examples

Sample success responses

JSONformat

{
  "RequestId": "BB2C39DE-CEB8-595A-981A-F2EFCBE7324E",
  "IpamPoolId": "ipam-pool-6rcq3tobayc20t****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ResourceNotFound.IpamScope	The specified resource of IPAM scope is not found.	The input IPAM scope does not exist.
400	ResourceNotFound.SourceIpamPool	The dependent source IPAM pool is not found.	The dependent resource source IPAM Pool does not exist.
400	UnsupportedFeature.PublicIpamScopeType	The feature of PublicIpamScopeType is not supported.	The IPAM you specified does not support the creation of public scope.
400	IllegalParam.AllocationDefaultNetmask	The specified AllocationDefaultNetmask is illegal.	AllocationDefaultNetmask parameter is illegal.
400	IllegalParam.AllocationMaxNetmask	The specified AllocationMaxNetmask is illegal.	AllocationMaxNetmask parameter is illegal.
400	IllegalParam.AllocationMinNetmask	The specified AllocationMinNetmask is illegal.	AllocationMinNetmask parameter is illegal.
400	IllegalParam.IpVersion	The specified IpVersion is illegal.	Invalid IpVersion.
400	QuotaExceeded.IpamPoolQuotaDepth	The quota of IpamPoolQuotaDepth count is exceeded.	Maximum number of IPAM address pool depth allowed exceeds limit
400	ResourceNotFound.Ipam	The specified resource of ipam is not found.	The IPAM entered does not exist.
400	IllegalParam.PoolRegionId	The specified PoolRegionId is illegal.	PoolRegionId parameter is illegal.
400	QuotaExceeded.IpamSubPoolQuotaPerIpamPool	The quota of ipamSubPoolQuotaPerIpamPool count is exceeded.	The number of sub-pools for the IPAM pool exceeds the limit.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	-
400	IncorrectStatus.IpamPool	The status of the IPAM pool is incorrect.	The status of the IPAM pool is incorrect.
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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-12-19	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-09-12	The Error code has changed. The request parameters of the API has changed	View Change Details