调用 DescribeIpAddressPools 接口，按条件查询已创建的IP地址池的详细信息。

请求说明

请求方式：GET

请求地址：/?Action=DescribeIpAddressPools&Version=2020-04-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeIpAddressPools

要执行的操作，取值：DescribeIpAddressPools。

Version string 必选示例值：2020-04-01

API的版本，取值：2020-04-01。

IpAddressPoolIds.N string[] 可选示例值：ippool-fda83op****

IP地址池的ID。

ISP string 可选示例值：BGP

线路类型，取值如下：

BGP：BGP（多线）。

若您的账号已申请并开通了静态单线权限，则可传入如下取值：

ChinaMobile：中国移动静态单线。

ChinaTelecom：中国电信静态单线。

ChinaUnicom：中国联通静态单线。

若您的账号已申请并开通了BGP单线权限，则可传入SingleLine_BGP。

若您的账号已申请并开通了融合BGP权限，则可传入Fusion_BGP。

若您的账号已申请并开通了惠选型静态单线权限，则可传入如下取值：

ChinaMobile_Value：中国移动惠选型静态单线。

ChinaUnicom_Value：中国联通惠选型静态单线。

ChinaTelecom_Value：中国电信惠选型静态单线。

Status string 可选示例值：Available

IP地址池的状态。取值如下：

Creating：创建中。

Available：可用。

Deleting：删除中。

Pending：配置中。

ProjectName string 可选示例值：Project_1

IP地址池所属项目的名称。

TagFilters.N.Key string[] 可选示例值：k1

标签的标签键。

参数 - N：表示标签键的序号，取值范围：1～10。

多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的IP地址池。

TagFilters.N.Values.N string[] 可选示例值：v1

标签的标签值。

第一个N：表示标签键的序号。

第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的IP地址池。

多个标签值之间用&分隔。

说明

若传入该参数，则必须先传入TagFilters.N.Key。

传入空字符串时，表示查询标签值为空的IP地址池。

NextToken string 可选示例值：caeba0bbb2be03f84eb48b699f0a****

分页查询凭证，用于标记分页的位置。

不填则从头开始查询。

传入之前调用本API返回的NextToken，则从该次API调用标记分页的位置往后开始查询。

MaxResults integer 可选示例值：50

查询的数量，最大值为100，默认值为10。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

RequestId string 示例值：20210624153033015207C4****

请求ID。

NextToken string 示例值：caeba0bbb2be03f84eb48b699f0a****

本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。

IpAddressPools object[] 示例值：-

IP地址池的网段信息。

OverdueTime string 示例值：2024-10-10T14:17:28+08:00

资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值。

DeletedTime string 示例值：2024-10-10T14:17:28+08:00

预期资源强制回收时间。

BusinessStatus string 示例值：Normal

IP地址池是否被锁定。

Normal: 正常。

FinancialLocked: 被锁定。

IpAddressPoolId string 示例值：ippool-fda83op****

IP地址池ID。

ISP string 示例值：BGP

线路类型。

BGP：BGP（多线）。

ChinaMobile：中国移动静态单线。

ChinaTelecom：中国电信静态单线。

ChinaUnicom：中国联通静态单线。

SingleLine_BGP：BGP单线。

Fusion_BGP：融合BGP。

ChinaMobile_Value：中国移动惠选型静态单线。

ChinaUnicom_Value：中国联通惠选型静态单线。

ChinaTelecom_Value：中国电信惠选型静态单线。

Status string 示例值：Available

IP地址池的状态。取值如下：

Creating：创建中。

Available：可用。

Deleting：删除中。

Pending：配置中。

Name string 示例值：IpAddressPool01

IP地址池的名称。

Description string 示例值：This is an IpAddressPool

IP地址池的描述。

UsedIpCount integer 示例值：0

IP地址池中已分配为EIP的IP地址个数。

TotalIpCount integer 示例值：256

IP地址池中包含的IP地址总个数。

CidrBlocks string[] 示例值：["101.x.x.x/24"]

IP地址池网段。

ProjectName string 示例值：Project_1

IP地址池所属项目的名称。

Tags object[] 示例值：-

IP地址池的标签信息。

Key string 示例值：k1

标签的标签键。

Value string 示例值：v1

标签的标签值。

CreationTime string 示例值：2024-10-10T14:17:28+08:00

IP地址池的创建时间。

UpdateTime string 示例值：2024-10-10T14:17:28+08:00

更新IP地址池的时间。

请求示例

返回示例

错误码

您可访问公共错误码，获取更多错误码信息。

公网IP