GetIpamPoolNextAvailableCidr - Virtual Private Cloud - Alibaba Cloud Documentation Center

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

get

*IpamPool

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region of the IPAM pool. Note If the IPAM pool has a region property, this parameter specifies the region where the pool is active. If the IPAM pool does not have a region property, this parameter specifies the managed region of IPAM.	cn-hangzhou
IpamPoolId	string	Yes	The instance ID of the IPAM pool.	ipam-pool-6rcq3tobayc20t****
CidrBlock	string	No	The CIDR block to be allocated. Note You must specify CidrBlock or CidrMask.	172.68.0.0/26
CidrMask	integer	No	The mask length of the CIDR block to be allocated. Note You must specify CidrBlock or CidrMask.	26
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a unique value for this parameter from your client. The ClientToken value can contain only ASCII characters. Note If you do not specify this parameter, the system uses the RequestId as the ClientToken. The RequestId of each request is unique.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	29FC6758-9B7C-5CC7-8CBF-4DD846FE7D82
CidrBlock	string	The available CIDR block.	172.68.0.0/26

Examples

Success response

JSON format

{
  "RequestId": "29FC6758-9B7C-5CC7-8CBF-4DD846FE7D82",
  "CidrBlock": "172.68.0.0/26"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParam.CidrOrCidrMask	The CIDR or CIDR Mask must be input.	The CIDR or CIDR Mask must be input.
400	ResourceNotEnough.IpamPoolCidr	The specified resource of IPAM pool CIDR is not enough.	The specified resource of IPAM pool CIDR is not enough.
400	OperationDenied.IpamRegionNotSupportGetPoolAvailableCidr	The operation is not allowed because IPAM region does not support getting available CIDR of IPAM pool.	The operation is not allowed because IPAM region does not support getting available CIDR of IPAM pool.
400	IllegalParam.Cidr	The specified CIDR is illegal.	The CIDR block is invalid.
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.