All Products
Search
Document Center

Virtual Private Cloud:ListPublicIpAddressPoolCidrBlocks

Last Updated:Jul 10, 2024

Queries CIDR blocks in an IP address pool.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
PublicIpAddressPoolIdstringYes

The ID of the IP address pool.

pippool-6wetvn6fumkgycssx****
CidrBlockstringNo

The CIDR blocks.

47.0.XX.XX/24
MaxResultsintegerNo

The maximum number of entries to return. Valid values: 10 to 100. Default value: 10.

10
NextTokenstringNo

The token that is used for the next query. Valid values:

  • If this is your first query and no next queries are to be sent, ignore this parameter.
  • If a subsequent query is to be sent, set the parameter to the value of NextToken that is returned from the last call.
FFmyTO70tTpLG6I3FmYAXGKPd****
DryRunbooleanNo

Specifies 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
RegionIdstringYes

The region ID of the CIDR blocks.

cn-chengdu

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

4EC47282-1B74-4534-BD0E-403F3EE64CAF
NextTokenstring

The token that is used for the next query. Valid values:

  • If NextToken was not returned, it indicates that no additional results exist.
  • If NextToken is returned, the value is the token that is used for the next query.
FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCountinteger

The maximum number of entries returned. Valid values: 10 to 100. Default value: 10.

10
PublicIpPoolCidrBlockListarray<object>

The total number of entries returned.

object
PublicIpAddressPoolIdstring

The information about the CIDR blocks.

pippool-6wetvn6fumkgycssx****
CidrBlockstring

The ID of the IP address pool.

47.0.XX.XX/24
CreationTimestring

The CIDR blocks.

2022-05-10T01:37:38Z
Statusstring

The time when the CIDR block was created. The time is displayed in YYYY-MM-DDThh:mm:ssZ format.

Created
UsedIpNuminteger

The status of the CIDR block in the IP address pool. Valid values:

  • Created: available
  • Deleting: being deleted
  • Modifying: being modified
20
TotalIpNuminteger

The total number of available IP addresses in the CIDR block.

20

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change timeSummary of changesOperation
2023-06-26The internal configuration of the API is changed, but the call is not affectedView Change Details
2023-05-15The response structure of the API has changedView Change Details