ListIpamPoolCidrs - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries the provisioned CIDR blocks of an 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:ListIpamPoolCidrs

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the IPAM is created. Call the DescribeRegions operation to obtain the region ID.	cn-hangzhou
IpamPoolId	string	Yes	The instance ID of the IPAM pool.	ipam-pool-6rcq3tobayc20t****
Cidr	string	No	The provisioned CIDR block to query. Note Only IPv4 CIDR blocks are supported.	192.168.1.0/24
NextToken	string	No	The token that is used to retrieve the next page of results. Set the value to the `NextToken` value that is returned in the last call. You do not need to specify this parameter for the first call. If NextToken is empty, no further query is needed. If NextToken has a value, use it as the token for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	The information that is returned.
IpamPoolCidrs	array<object>	A list of provisioned CIDR blocks of the IPAM pool.
	object	The details of a provisioned CIDR block.
IpamPoolId	string	The instance ID of the IPAM pool.	ipam-pool-6rcq3tobayc20t****
Cidr	string	The provisioned CIDR block.	192.168.1.0/24
Status	string	The instance status of the provisioned CIDR block of the IPAM pool. Valid values: Created: The CIDR block is created. Deleted: The CIDR block is deleted.	Created
NextToken	string	The token that is used to retrieve the next page of results. If this parameter is empty, no more results are to be returned. If a value is returned, the value is the token that is used for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	The total number of entries that match the query.	1000
MaxResults	integer	The maximum number of entries returned per page.	10
Count	integer	The number of entries returned on the current page.	10
RequestId	string	The request ID.	9E7CCB95-62E0-534D-9B9A-71F27E8B71B1

Examples

Success response

JSON format

{
  "IpamPoolCidrs": [
    {
      "IpamPoolId": "ipam-pool-6rcq3tobayc20t****",
      "Cidr": "192.168.1.0/24",
      "Status": "Created"
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 1000,
  "MaxResults": 10,
  "Count": 10,
  "RequestId": "9E7CCB95-62E0-534D-9B9A-71F27E8B71B1"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationDenied.PoolRegionNotSupportListPoolCidr	The operation is not allowed because pool region does not support listing cidrs.	You cannot query CIDR blocks in this region.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.