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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListPublicIpAddressPoolCidrBlocks

The operation that you want to perform. Set the value to ListPublicIpAddressPoolCidrBlocks.

PublicIpAddressPoolId String Yes pippool-6wetvn6fumkgycssx****

The ID of the IP address pool.

CidrBlock String No 47.0.XX.XX/24

The CIDR blocks.

MaxResults Integer No 10

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

NextToken String No FFmyTO70tTpLG6I3FmYAXGKPd****

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.
DryRun Boolean No false

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.
RegionId String Yes cn-chengdu

The region ID of the CIDR blocks.

Response parameters

Parameter Type Example Description
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

The ID of the request.

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

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.
MaxResults Integer 10

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

TotalCount Integer 10

The total number of entries returned.

PublicIpPoolCidrBlockList Array of PublicIpPoolCidrBlock

The information about the CIDR blocks.

PublicIpAddressPoolId String pippool-6wetvn6fumkgycssx****

The ID of the IP address pool.

CidrBlock String 47.0.XX.XX/24

The CIDR blocks.

CreationTime String 2022-05-10T01:37:38Z

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

Status String Created

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

  • Created: available
  • Deleting: being deleted
  • Modifying: being modified
UsedIpNum Integer 20

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

TotalIpNum Integer 20

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

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListPublicIpAddressPoolCidrBlocks
&PublicIpAddressPoolId=pippool-6wetvn6fumkgycssx****
&CidrBlock=47.0.XX.XX/24
&MaxResults=10
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&DryRun=false
&RegionId=cn-chengdu
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListPublicIpAddressPoolCidrBlocksResponse>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <MaxResults>10</MaxResults>
    <TotalCount>10</TotalCount>
    <PublicIpPoolCidrBlockList>
        <PublicIpAddressPoolId>pippool-6wetvn6fumkgycssx****</PublicIpAddressPoolId>
        <CidrBlock>47.0.XX.XX/24</CidrBlock>
        <CreationTime>2022-05-10T01:37:38Z</CreationTime>
        <Status>Created</Status>
        <UsedIpNum>20</UsedIpNum>
        <TotalIpNum>20</TotalIpNum>
    </PublicIpPoolCidrBlockList>
</ListPublicIpAddressPoolCidrBlocksResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults" : 10,
  "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, see Service error codes.