公网IP
公网IP
文档指南
请输入
- 文档首页
公网IPAPI参考IP地址池DescribeIpAddressPools - 查询IP地址池
复制全文
下载 pdfDescribeIpAddressPools - 查询IP地址池
文档反馈
问问助手调用 DescribeIpAddressPools 接口，按条件查询已创建的IP地址池的详细信息。
调试
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：中国电信惠选型静态单线。
Name String 可选 示例值：IpAddressPool01
IP地址池的名称，暂不支持模糊查询。
- 长度限制为 1 ~ 128个字符。
- 需要以字母或数字开头，不能以 http:// 或 https://.开头。可包含字母、数字、引号（：）、下划线（_）和短划线（-）。
Status String 可选 示例值：Available
IP地址池的状态。取值如下：
- Creating：创建中。
- Available：可用。
- Deleting：删除中。
- Pending：配置中。
ProjectName String 可选 示例值：Project_1
IP地址池所属项目的名称。
TagFilters.N.Key String 可选 示例值：k1
标签的标签键。
- 参数 - N：表示标签键的序号，取值范围：1～10。
- 多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的IP地址池。
NextToken String 可选 示例值：caeba0bbb2be03f84eb48b699f0a****
分页查询凭证，用于标记分页的位置。
- 不填则从头开始查询。
- 传入之前调用本API返回的NextToken，则从该次API调用标记分页的位置往后开始查询。
MaxResults Integer 可选 示例值：50
查询的数量，最大值为100，默认值为10。
TagFilters.N.Values.N String 可选 示例值：TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=v1
标签的标签值。
- 第一个N：表示标签键的序号。
- 第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的IP地址池。
- 多个标签值之间用&分隔。
说明
- 若传入该参数，则必须先传入TagFilters.N.Key。
- 传入空字符串时，表示查询标签值为空的IP地址池。
返回参数
RequestId String 示例值：20210624153033015207C4****
请求ID。
NextToken String 示例值：caeba0bbb2be03f84eb48b699f0a****
本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。
IpAddressPools Object[] 示例值：-
IP地址池的网段信息。
IpAddressPoolId String 示例值：ippool-fda83op****
IP地址池的ID。
BusinessStatus String 示例值：Normal
IP地址池是否被锁定。
- Normal: 正常。
- FinancialLocked: 被锁定。
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地址池的描述信息。
TotalIpCount Integer 示例值：256
IP地址池中包含的IP地址总个数。
UsedIpCount Integer 示例值：0
IP地址池中已分配为EIP的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地址池的更新时间。
DeletedTime String 示例值：2024-10-11 01:00:00
资源回收时间。仅当资源欠费关停时，此参数才有返回值。
OverdueTime String 示例值：2024-10-11 01:00:00
资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值。
请求示例
GET /?Action=DescribeIpAddressPools&Version=2020-04-01&IpAddressPoolId=ippool-fda83op**** HTTP/1.1
Host: vpc.cn-beijing.volcengineapi.com
Service: vpc
Region: cn-beijing
返回示例
{
"ResponseMetadata": {
"RequestId": "20210624153033015207C4****",
"Action": "DescribeIpAddressPools",
"Version": "2020-04-01",
"Service": "vpc",
"Region": "cn-beijing"
},
"Result":{
"RequestId": "2021062415303301022514515207C4****",
"NextToken":"caeba0bbb2be03f84eb48b699f0a****",
"IpAddressPools":[
{
"IpAddressPoolId": "ippool-fda83op****",
"BusinessStatus":"Normal",
"ISP": "BGP",
"Status": "Available",
"Name": "IpAddressPool01",
"Description": "This is an IpAddressPool",
"TotalIpCount":256,
"UsedIpCount":0,
"CidrBlocks": [
"101.0.XX.XX/24"
]
"ProjectName": "Project_1",
"Tags":[
{
"Key":"k1",
"Value":"v1"
}
]
"CreationTime": "2024-10-10T14:17:28+08:00",
"UpdateTime": "2024-10-10T14:17:28+08:00",
"OverdueTime": "2024-10-11 01:00:00",
"DeletedTime": "2024-10-11 01:00:00"
}
]
}
}
错误码
最近更新时间：2026.01.23 15:56:39
这个页面对您有帮助吗？
有用
有用
无用
无用