调用ListPublicIpAddressPoolCidrBlocks接口查询IP地址池CIDR Block网段信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListPublicIpAddressPoolCidrBlocks

系统规定参数。取值：ListPublicIpAddressPoolCidrBlocks。
PublicIpAddressPoolId String 是 pippool-6wetvn6fumkgycssx****

IP地址池的实例ID。
CidrBlock String 否 47.0.XX.XX/24

IP地址段。
MaxResults Integer 否 10

本次读取的最大数据记录数量，取值范围：10~100，默认为10。
NextToken String 否 FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌（Token）。取值：

  • 第一次查询和没有下一次查询时，均无需填写。
  • 如果有下一次查询，取值为上一次API调用返回的NextToken值。
DryRun Boolean 否 false

是否只预检此次请求。取值：

  • true：发送检查请求，不会查询IP地址池Cidr Block信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
  • false（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。
RegionId String 是 cn-chengdu

要查询的IP地址段所在的地域ID。

返回数据

名称 类型 示例值 描述
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

请求ID。
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌（Token）。取值：

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值，该取值表示下一次查询开始的令牌。
MaxResults Integer 10

本次读取的最大数据记录数量，取值范围：10~100，默认为10。
TotalCount Integer 10

本次请求条件下的数据总量。
PublicIpPoolCidrBlockList Array of PublicIpPoolCidrBlock

地址池CIDR BLOCK数据列表。
PublicIpAddressPoolId String pippool-6wetvn6fumkgycssx****

IP地址池的实例ID。
CidrBlock String 47.0.XX.XX/24

IP地址段。
CreationTime String 2022-05-10T01:37:38Z

创建时间，格式为YYYY-MM-DDThh:mm:ssZ。
Status String Created

IP地址池中网段状态。取值：

  • Created：可用。
  • Deleting：删除中。
  • Modifying：修改中。
UsedIpNum Integer 20

IP地址池中网段的可用IP地址总数。
TotalIpNum Integer 20

IP地址池中网段的已用IP地址数。

示例

请求示例

http(s)://[Endpoint]/?Action=ListPublicIpAddressPoolCidrBlocks
&PublicIpAddressPoolId=pippool-6wetvn6fumkgycssx****
&CidrBlock=47.0.XX.XX/24
&MaxResults=10
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&DryRun=false
&RegionId=cn-chengdu
&公共请求参数

正常返回示例

XML格式

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格式

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
  } ]
}

错误码

访问错误中心查看更多错误码。