调用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 |
| MaxResults | integer | 否 | 本次读取的最大数据记录数量。取值范围：10~100。默认值：10。 | 10 |
| NextToken | string | 否 | 是否拥有下一次查询的令牌（Token）。取值：
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
| Isp | string | 否 | 线路类型。取值：
关于 BGP（多线）线路和 BGP（多线）_精品线路的更多信息，请参见 EIP 线路类型。 如果您是单线带宽的白名单用户，您还可以选择以下类型：
如果您是杭州金融云用户，该字段必填，取值：BGP_FinanceCloud。 | BGP |
| Name | string | 否 | 地址池实例的名称。 名称长度为 0-128 个字符，不能以 | AddressPoolName |
| DryRun | boolean | 否 | 是否只预检此次请求。取值：
| false |
| ResourceGroupId | string | 否 | IP 地址池所属的资源组 ID。 | rg-acfmxazb4pcdvf**** |
| Tags | array<object> | 否 | 标签列表。 | |
| object | 否 | 标签列表。 | ||
| Key | string | 否 | 资源的标签键。最多支持输入 20 个标签键。如需传入该值，则不能输入空字符串。 一个标签键最多支持 128 个字符，不能以 | FinanceDept |
| Value | string | 否 | 资源的标签值。最多支持输入 20 个标签值。如需传入该值，可以输入空字符串。 最多支持 128 个字符，不能以 | FinanceJoshua |
| RegionId | string | 是 | 要查询的 IP 地址池所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-chengdu |
| SecurityProtectionEnabled | boolean | 否 | 是否开启 DDoS 防护（增强版）。取值：
| true |
返回参数
示例
正常返回示例
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 返回结构发生变更 | 查看变更详情 |