调用ListPublicIpAddressPools查询IP地址池信息_专有网络VPC(VPC)-阿里云帮助中心

调用ListPublicIpAddressPools接口查询可使用的IP地址池信息。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
PublicIpAddressPoolIds	array	否	IP 地址池的实例 ID 列表。您最多可输入 100 个 IP 地址池的实例 ID。
	string	否	IP 地址池的实例 ID 列表。您最多可输入 100 个 IP 地址池的实例 ID。	pippool-6wetvn6fumkgycssx****
Status	string	否	IP 地址池实例状态。取值： Created：可用。 Deleting：删除中。 Modifying：修改中。	Created
MaxResults	integer	否	本次读取的最大数据记录数量。取值范围：10~100。默认值：10。	10
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
Isp	string	否	线路类型。取值： BGP（默认值）：BGP（多线）线路。 BGP_PRO：BGP（多线）_精品线路。关于 BGP（多线）线路和 BGP（多线）_精品线路的更多信息，请参见 EIP 线路类型。如果您是单线带宽的白名单用户，您还可以选择以下类型： ChinaTelecom：中国电信 ChinaUnicom：中国联通 ChinaMobile：中国移动 ChinaTelecom_L2：中国电信 L2 ChinaUnicom_L2：中国联通 L2 ChinaMobile_L2：中国移动 L2 如果您是杭州金融云用户，该字段必填，取值：BGP_FinanceCloud。	BGP
Name	string	否	地址池实例的名称。名称长度为 0-128 个字符，不能以`http://`或`https://`开头。	AddressPoolName
DryRun	boolean	否	是否只预检此次请求。取值： true：发送检查请求，不会查询可使用的 IP 地址池信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接进行操作。	false
ResourceGroupId	string	否	IP 地址池所属的资源组 ID。	rg-acfmxazb4pcdvf****
Tags	array<object>	否	标签列表。
	object	否	标签列表。
Key	string	否	资源的标签键。最多支持输入 20 个标签键。如需传入该值，则不能输入空字符串。一个标签键最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	资源的标签值。最多支持输入 20 个标签值。如需传入该值，可以输入空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceJoshua
RegionId	string	是	要查询的 IP 地址池所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-chengdu
SecurityProtectionEnabled	boolean	否	是否开启 DDoS 防护（增强版）。取值： false：不开启。 true：开启。	true

返回参数

名称	类型	描述	示例值
	object	返回数据结构体。
RequestId	string	请求 ID。	4EC47282-1B74-4534-BD0E-403F3EE64CAF
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	本次请求条件下的数据总量。	1
PublicIpAddressPoolList	array<object>	IP 地址池的实例列表。
PublicIpAddressPool	object	IP 地址池的实例结构体。
PublicIpAddressPoolId	string	IP 地址池的实例 ID。	pippool-6wetvn6fumkgycssx****
RegionId	string	要查询的 IP 地址池所在的地域 ID。	cn-chengdu
CreationTime	string	创建时间，格式为`YYYY-MM-DDThh:mm:ssZ`。	2022-05-10T01:37:38Z
Isp	string	线路类型。 BGP：BGP（多线）线路。 BGP_PRO：BGP（多线）_精品线路。关于 BGP（多线）线路和 BGP（多线）_精品线路的更多信息，请参见 EIP 线路类型。如果您是单线带宽的白名单用户，返回类型还可能为： ChinaTelecom：中国电信 ChinaUnicom：中国联通 ChinaMobile：中国移动 ChinaTelecom_L2：中国电信 L2 ChinaUnicom_L2：中国联通 L2 ChinaMobile_L2：中国移动 L2 如果您是杭州金融云用户，返回BGP_FinanceCloud。	BGP
Name	string	IP 地址池实例的名称。	AddressPoolName
Status	string	IP 地址池实例状态。 Created：可用。 Deleting：删除中。 Modifying：修改中。	Created
Description	string	IP 地址池实例的描述。	AddressPoolDescription
TotalIpNum	integer	公网 IP 地址池可用 IP 地址总数。	100
UsedIpNum	integer	公网 IP 地址池已用 IP 地址数。	20
IpAddressRemaining	boolean	是否还有空闲的 IP 地址。 true：是。 false：否。	true
UserType	string	用户的类型。取值： admin：管理员，表示可以删除、修改、查询 IP 地址池以及为 IP 地址池分配弹性公网 IP（Elastic IP Address，简称 EIP）等操作。 user：普通用户，表示只能为 IP 地址池分配 EIP 以及查询 IP 地址池，但是无法修改以及删除 IP 地址池。	admin
OwnerId	long	IP 地址池所属的阿里云账号（主账号）。	121012345612*****
ShareType	string	IP 地址池的共享类型。 Shared：表示该 IP 地址池为共享的 IP 地址池。空：表示该 IP 地址池不是共享的 IP 地址池。	Shared
ResourceGroupId	string	IP 地址池所属的资源组 ID。	rg-acfmxazb4pcdvf****
Tags	array<object>	标签列表。
Tag	object	标签列表。
Key	string	标签键。	FinanceDept
Value	string	标签值。	FinanceDept
BizType	string	IP 地址池的业务类型。 CloudBox：云盒。仅云盒用户支持该类型。 Default（默认值）：默认，表示非特殊类型。	CloudBox
Zones	array	IP 地址池的可用区。仅当 IP 地址池业务类型为云盒时，返回该参数。
Zone	string	IP 地址池的可用区。仅当 IP 地址池业务类型为云盒时，返回该参数。	ap-southeast-1-lzdvn-cb
SecurityProtectionTypes	array	安全防护级别。配置为空时，默认为 DDoS 防护（基础版）。配置为AntiDDoS_Enhanced时，表示 DDoS 防护（增强版）。
SecurityProtectionType	string	安全防护级别。配置为空时，默认为 DDoS 防护（基础版）。配置为AntiDDoS_Enhanced时，表示 DDoS 防护（增强版）。	AntiDDoS_Enhanced
BusinessStatus	string	IP 地址池实例的业务状态。 Normal：正常。 FinancialLocked：被锁定。	Normal

示例

正常返回示例

JSON格式

{
  "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 1,
  "PublicIpAddressPoolList": [
    {
      "PublicIpAddressPoolId": "pippool-6wetvn6fumkgycssx****",
      "RegionId": "cn-chengdu",
      "CreationTime": "2022-05-10T01:37:38Z",
      "Isp": "BGP",
      "Name": "AddressPoolName",
      "Status": "Created",
      "Description": "AddressPoolDescription",
      "TotalIpNum": 100,
      "UsedIpNum": 20,
      "IpAddressRemaining": true,
      "UserType": "admin",
      "OwnerId": 0,
      "ShareType": "Shared",
      "ResourceGroupId": "rg-acfmxazb4pcdvf****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceDept"
        }
      ],
      "BizType": "CloudBox",
      "Zones": [
        "ap-southeast-1-lzdvn-cb"
      ],
      "SecurityProtectionTypes": [
        "AntiDDoS_Enhanced"
      ],
      "BusinessStatus": "Normal"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalParam.Isp	The param of Isp [%s] is illegal.	参数 Isp 不合法，请根据请求参数规定重新输入。
400	IllegalParam.NextToken	The specified NextToken is invalid.	参数NextToken非法.

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

变更历史

变更时间	变更内容概要	操作
2024-08-08	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-07-31	OpenAPI 错误码发生变更	查看变更详情
2024-06-06	OpenAPI 错误码发生变更	查看变更详情
2024-05-27	OpenAPI 返回结构发生变更	查看变更详情
2024-01-22	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-08-08	OpenAPI 返回结构发生变更	查看变更详情
2023-05-15	OpenAPI 返回结构发生变更	查看变更详情