查询全域弹性公网IP池列表 - ListGeipPools

功能介绍

查询全域弹性公网IP池列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v3/{domain_id}/geip/geip-pools

表1 路径参数
参数	是否必选	参数类型	描述
domain_id	是	String	租户账号ID，获取租户账号ID请参见租户账号ID 最小长度：5 最大长度：32

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	每页条数最小值：0 最大值：2000
offset	否	Integer	分页查询起始的资源序号
marker	否	String	功能说明：上一页最后一条记录的ID 使用说明：必须与limit一起使用输入的值必须为有效的ID值
page_reverse	否	Boolean	功能说明：翻页方向取值： true：查询上一页 false：查询下一页
fields	否	Array of strings	功能说明：查询指定的字段，格式为fields=A&fields=B&fields=C&...... 支持的字段： id name isp access_site type ip_version en_name cn_name status created_at updated_at description
sort_key	否	Array of strings	按照sort_key指定的字段排序
sort_dir	否	Array of strings	功能说明：排序方向取值范围：asc（升序）、desc（降序）
id	否	Array of strings	根据ID过滤，支持多值查询，查询条件格式：id=xxx&id=xxx。
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	根据池子里存的内容过滤。取值：GEIP-用于分配全域弹性公网IP单地址；GEIP_SEGMENT-用于分配全域弹性公网IP段

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户的Token，如何获取用户Token请参见获取用户Token

响应参数

状态码：200

表4 响应Header参数
参数	参数类型	描述
X-Request-Id	String	本次请求编号

表5 响应Body参数
参数	参数类型	描述
request_id	String	本次请求的编号
geip_pools	Array of ListGeipPools objects	全域弹性公网IP池列表
page_info	page_info object	分页页码信息

表6 ListGeipPools
参数	参数类型	描述
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池的版本取值范围：4、6
access_site	String	接入点信息，具体接入点信息可通过查询接入点列表接口查询。
type	String	类型
created_at	String	创建时间
updated_at	String	更新时间
description	String	功能说明：用户自定义的资源描述约束与限制：值的长度最大512字符，由数字、字母、中文、_(下划线)、-（中划线）、.（点）组成。最小长度：0 最大长度：512
allowed_bandwidth_types	Array of AllowedBandwidthTypes objects	地址池支持的全域公网带宽类型资源

表7 AllowedBandwidthTypes
参数	参数类型	描述
type	String	全域公网带宽类型名称
cn_name	String	中文名称
en_name	String	英文名称

表8 page_info
参数	参数类型	描述
next_marker	String	翻页时，作为后一页的marker取值
previous_marker	String	翻页时，作为前一页的marker取值
current_count	Integer	当前页的数据总数

请求示例

查询全域弹性公网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
  }
}