Use ListPublicIpAddressPoolCidrBlocks to query CIDR blocks in an IP address pool - Elastic IP Address - Alibaba Cloud - Elastic IP Address

Queries the CIDR block information in a specified IP address 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
PublicIpAddressPoolId	string	Yes	The ID of the IP address pool.	pippool-6wetvn6fumkgycssx****
CidrBlock	string	No	The CIDR blocks.	47.0.XX.XX/24
MaxResults	integer	No	The maximum number of entries to return. Valid values: 10 to 100. Default value: 10.	10
NextToken	string	No	The pagination token for the next query. Valid values: If this is your first query or no next queries are to be sent, ignore this parameter. If a subsequent query is to be sent, set this parameter to the NextToken value returned from the last call.	FFmyTO70tTpLG6I3FmYAXGKPd****
DryRun	boolean	No	Whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request syntax, and 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 sends the request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	false
RegionId	string	Yes	The region ID of the CIDR blocks.	cn-chengdu

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	4EC47282-1B74-4534-BD0E-403F3EE64CAF
NextToken	string	The pagination token for the next query. Valid values: If NextToken was not returned, no additional results exist. If NextToken is returned, the value is the token for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	The maximum number of entries returned. Valid values: 10 to 100. Default value: 10.	10
PublicIpPoolCidrBlockList	array<object>	The total number of entries returned.
	object
PublicIpAddressPoolId	string	The information about the CIDR blocks.	pippool-6wetvn6fumkgycssx****
CidrBlock	string	The ID of the IP address pool.	47.0.XX.XX/24
CreationTime	string	The CIDR blocks.	2022-05-10T01:37:38Z
Status	string	The time when the CIDR block was created. The time is displayed in `YYYY-MM-DDThh:mm:ssZ` format.	Created
UsedIpNum	integer	The status of the CIDR block in the IP address pool. Valid values: Created: available Deleting: being deleted Modifying: being modified	20
TotalIpNum	integer	The total number of available IP addresses in the CIDR block.	20

Examples

Success response

JSON format

{
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 10,
  "PublicIpPoolCidrBlockList": [
    {
      "PublicIpAddressPoolId": "pippool-6wetvn6fumkgycssx****",
      "CidrBlock": "47.0.XX.XX/24",
      "CreationTime": "2022-05-10T01:37:38Z",
      "Status": "Created",
      "UsedIpNum": 20,
      "TotalIpNum": 20
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.NextToken	The specified NextToken is invalid.	The specified NextToken is invalid.
400	MissingParam.PublicIpAddressPoolId	The parameter PublicIpAddressPoolId is missing.	The parameter PublicIpAddressPoolId is missing.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.