查询全域弹性公网IP池列表 - ListGeipPools
功能介绍
查询全域弹性公网IP池列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v3/{domain_id}/geip/geip-pools
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| domain_id | 是 | String | 参数解释: 租户账号ID,获取租户账号ID请参见租户账号ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 最小长度:5 最大长度:32 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 每页条数。 约束限制: 不涉及。 取值范围: 0-2000 默认取值: 不涉及。 最小值:0 最大值:2000 |
| offset | 否 | Integer | 参数解释: 分页查询起始的资源序号。 约束限制: 不涉及。 取值范围: 0-2000 默认取值: 不涉及。 |
| marker | 否 | String | 参数解释: 上一页最后一条记录的ID。 约束限制: 取值范围: 格式:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} 默认取值: 不涉及。 |
| page_reverse | 否 | Boolean | 参数解释: 翻页方向。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| fields | 否 | Array of strings | 参数解释: 查询指定的字段。 约束限制: 格式为fields=A&fields=B&fields=C&...... 取值范围: 支持的字段: 默认取值: 不涉及。 |
| sort_key | 否 | Array of strings | 参数解释: 按照sort_key指定的字段排序。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| sort_dir | 否 | Array of strings | 参数解释: 排序方向。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| id | 否 | Array of strings | 参数解释: 根据ID过滤,支持多值查询。 约束限制: 查询条件格式:id=xxx&id=xxx。 取值范围: 格式:[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} 默认取值: 不涉及。 |
| name | 否 | Array of strings | 参数解释: 根据名称过滤,支持多值查询。 约束限制: 查询条件格式:name=xxx&name=xxx。 取值范围: 不涉及。 默认取值: 不涉及。 |
| access_site | 否 | Array of strings | 参数解释: 根据接入点过滤,支持多值查询。 约束限制: 查询条件格式:access_site=xxx&access_site=xxx。 取值范围: 不涉及。 默认取值: 不涉及。 |
| isp | 否 | Array of strings | 参数解释: 根据运营商线路过滤,支持多值查询。 约束限制: 查询条件格式:isp=xxx&isp=xxx。 取值范围: 不涉及。 默认取值: 不涉及。 |
| ip_version | 否 | Array of strings | 参数解释: 根据IP版本过滤。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| status | 否 | Array of strings | 参数解释: 根据池子状态过滤。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| type | 否 | Array of strings | 参数解释: 根据池子里存的内容过滤。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户的Token,如何获取用户Token请参见获取用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-Request-Id | String | 本次请求编号 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| request_id | String | 参数解释: 请求ID。 取值范围: 不涉及。 |
| geip_pools | Array of ListGeipPools objects | 参数解释: 全域弹性公网IP池列表。 取值范围: 不涉及。 |
| page_info | page_info object | 参数解释: 分页页码信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 全域弹性公网IP池的ID。 取值范围: 不涉及。 |
| name | String | 参数解释: 全域弹性公网IP池名称。 取值范围: 1-64,支持数字、字母、中文、_(下划线)、-(中划线)、.(点) 最小长度:1 最大长度:64 |
| en_name | String | 参数解释: 英文名称。 取值范围: 不涉及。 |
| cn_name | String | 参数解释: 中文名称。 取值范围: 不涉及。 |
| status | String | 参数解释: 状态。 取值范围: |
| isp | String | 参数解释: 全域公网带宽接入的线路。 取值范围: 不涉及。 |
| ip_version | Integer | 参数解释: 全域弹性公网IP池的版本。 取值范围: |
| access_site | String | 参数解释: 接入点信息,具体接入点信息可通过查询接入点列表接口查询。 取值范围: 不涉及。 |
| type | String | 参数解释: 类型。 取值范围: 不涉及。 |
| created_at | String | 参数解释: 创建时间。 取值范围: 格式:yyyy-MM-dd'T'HH:mm:ss'Z' |
| updated_at | String | 参数解释: 更新时间。 取值范围: 格式:yyyy-MM-dd'T'HH:mm:ss'Z' |
| description | String | 参数解释: 用户自定义的资源描述。 取值范围: 值的长度最大512字符,由数字、字母、中文、_(下划线)、-(中划线)、.(点)组成。 最小长度:0 最大长度:512 |
| allowed_bandwidth_types | Array of AllowedBandwidthTypes objects | 参数解释: 地址池支持的全域公网带宽类型资源。 取值范围: 不涉及。 |
请求示例
查询全域弹性公网IP池列表
GET https://{Endpoint}/v3/{domain_id}/geip/geip-pools 响应示例
状态码:200
{
"request_id" : "d224afc0e7add65c715707dbadd3004a",
"geip_pools" : [ {
"name" : "segment-v6-for-ui",
"created_at" : "2023-08-08T02:50:33Z",
"updated_at" : "2023-08-23T10:13:30Z",
"id" : "01c2a3b2-2530-419d-88f0-b3d5e3d8f082",
"cn_name" : "GEIP段页面调试IPv6池",
"en_name" : "segment-v6-for-ui",
"isp" : "BGP",
"access_site" : "cn-south-odin",
"type" : "GEIP_SEGMENT",
"ip_version" : 6,
"allowed_bandwidth_types" : [ {
"type" : "standard",
"cn_name" : "标准带宽",
"en_name" : "Standard"
} ]
}, {
"name" : "cn-south-odin",
"created_at" : "2023-04-06T03:40:46Z",
"updated_at" : "2023-12-11T14:56:10Z",
"id" : "76612916-63a0-4606-b91c-b0230f079f40",
"cn_name" : "奥丁测试池",
"en_name" : "cn-south-odin",
"isp" : "BGP",
"access_site" : "cn-south-odin",
"type" : "GEIP",
"ip_version" : 4,
"allowed_bandwidth_types" : [ {
"type" : "standard",
"cn_name" : "标准带宽",
"en_name" : "Standard"
} ]
} ],
"page_info" : {
"previous_marker" : "01c2a3b2-2530-419d-88f0-b3d5e3d8f082",
"current_count" : 2
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。