通过ListPublicIpAddressPoolCidrBlocks查询IP地址池的网段信息-弹性公网IP-阿里云

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vpc:ListPublicIpAddressPoolCidrBlocks	get	*PublicIpAddressPool `acs:vpc:{#regionId}:{#accountId}:publicipaddresspool/{#PublicIpAddressPoolId}`	无	无

请求参数

名称	类型	必填	描述	示例值
PublicIpAddressPoolId	string	是	IP 地址池的实例 ID。	pippool-6wetvn6fumkgycssx****
CidrBlock	string	否	IP 地址网段。	47.0.XX.XX/24
MaxResults	integer	否	本次读取的最大数据记录数量，取值范围：10~100，默认为 10。	10
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
DryRun	boolean	否	是否只预检此次请求。取值： true：发送检查请求，不会查询 IP 地址池中的 IP 地址网段信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接进行操作。	false
RegionId	string	是	要查询的 IP 地址网段所在的地域 ID。	cn-chengdu

返回参数

名称	类型	描述	示例值
	object	返回数据结构体。
RequestId	string	请求 ID。	4EC47282-1B74-4534-BD0E-403F3EE64CAF
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	本次请求条件下的数据总量。	10
PublicIpPoolCidrBlockList	array<object>	IP 地址池的 IP 地址网段数据列表。
PublicIpPoolCidrBlock	object	IP 地址池的 IP 地址网段结构体。
PublicIpAddressPoolId	string	IP 地址池的实例 ID。	pippool-6wetvn6fumkgycssx****
CidrBlock	string	IP 地址段。	47.0.XX.XX/24
CreationTime	string	创建时间，格式为`YYYY-MM-DDThh:mm:ssZ`。	2022-05-10T01:37:38Z
Status	string	IP 地址池中的 IP 地址网段状态。取值： Created：可用。 Deleting：删除中。 Modifying：修改中。	Created
UsedIpNum	integer	IP 地址池中 IP 地址网段的已用 IP 地址数。	20
TotalIpNum	integer	IP 地址池中 IP 地址网段的可用 IP 地址总数。	20

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalParam.NextToken	The specified NextToken is invalid.	参数NextToken非法.
400	MissingParam.PublicIpAddressPoolId	The parameter PublicIpAddressPoolId is missing.	参数PublicIpAddressPoolId缺失。

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

变更历史

变更时间	变更内容概要	操作
2024-07-31	OpenAPI 错误码发生变更	查看变更详情
2023-06-26	API 内部配置变更，不影响调用	查看变更详情
2023-05-15	OpenAPI 返回结构发生变更	查看变更详情