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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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.