文档首页/ 弹性公网IP EIP/ API参考/ GEIP API/ 全域弹性公网IP/ 查询全域弹性公网IP列表
更新时间：2024-04-26 GMT+08:00
查看PDF
分享

查询全域弹性公网IP列表

功能介绍

查询全域弹性公网IP列表

调试

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

URI

GET /v3/{domain_id}/global-eips

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

最小长度：5

最大长度：32
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页条数

最小值：0

最大值：2000

offset

否

Integer

分页查询起始的资源序号

marker

否

String

分页起始点

page_reverse

否

Boolean

翻页方向

fields

否

Array

只显示指定的字段

sort_key

否

Array

按照sort_key指定的字段排序

sort_dir

否

Array

  • 功能说明：排序方向

  • 取值范围：asc（升序）、desc（降序）

id

否

Array

根据ID过滤

internet_bandwidth_id

否

Array

根据全域公网带宽的ID过滤

name

否

Array

根据名称过滤

name_like

否

String

根据名称模糊匹配

access_site

否

Array

根据接入点过滤

geip_pool_name

否

Array

根据全域弹性公网IP池名称过滤

isp

否

Array

根据运营商线路过滤

ip_version

否

Array

根据IP版本过滤

ip_address

否

Array

根据ip地址过滤

ipv6_address

否

Array

根据ipv6地址过滤

freezen

否

Array

根据是否冻结过滤

polluted

否

Array

根据是否污染过滤

internet_bandwidth_is_null

否

Array

根据是否绑定全域公网带宽过滤

gcb_bandwidth_is_null

否

Array

根据是否绑定骨干带宽过滤

status

否

Array

根据资源状态过滤

associate_instance_info.region

否

Array

根据绑定实例所属的局点过滤

associate_instance_info.instance_type

否

Array

根据绑定实例的类型过滤

associate_instance_info.public_border_group

否

Array

  • 功能说明：根据绑定实例所属的边缘信息过滤

  • 取值范围：center、边缘站点名称

associate_instance_info.instance_site

否

Array

根据绑定实例所在的站点过滤

associate_instance_info.instance_id

否

Array

根据绑定实例的ID过滤

associate_instance_info.project_id

否

Array

根据绑定实例所属的项目ID过滤

associate_instance_info.service_id

否

Array

根据绑定实例所属的服务ID过滤

associate_instance_info.service_type

否

Array

根据绑定实例的服务类型过滤

enterprise_project_id

否

Array

根据企业项目ID过滤

tags

否

Array

根据标签过滤，过滤格式为key1|value1,key2|value2,...

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户的Token，如何获取用户Token请参见获取用户Token

响应参数

状态码： 200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

-

本次请求编号
表5 响应Body参数

参数

参数类型

描述

request_id

String

本次请求的编号

global_eips

Array of ListGlobalEips objects

全域弹性公网IP列表

page_info

page_info object

分页页码信息
表6 ListGlobalEips

参数

参数类型

描述

id

String

全域弹性公网IP的ID

name

String

  • 功能说明：全域弹性公网IP名称

  • 取值范围：1-64，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）

最小长度：1

最大长度：64

description

String

  • 功能说明：用户自定义的资源描述

  • 约束：

    • 值的长度最大512字符，由数字、字母、中文、_(下划线)、-（中划线）、.（点）组成。

最小长度：0

最大长度：512

domain_id

String

access_site

String

接入点信息

geip_pool_name

String

全域弹性公网IP池子名称

isp

String

全域弹性公网IP所属线路

ip_version

Integer

  • 功能说明：全域弹性公网IP的版本

  • 取值范围：4、6

枚举值：

  • 4

  • 6

ip_address

String

IPv4地址

ipv6_address

String

IPv6地址

freezen

Boolean

是否冻结

freezen_info

String

冻结原因

polluted

Boolean

是否污染

status

String

全域弹性公网IP的状态

枚举值：

  • PENDING_CREATE

  • IDLE

  • INUSE

  • PENDING_UPDATE

created_at

String

创建时间

updated_at

String

更新时间

internet_bandwidth_info

InternetBandwidthInfo object

全域公网带宽信息

global_connection_bandwidth_info

GlobalConnectionBandwidthInfo object

全域互联带宽信息

associate_instance_info

InstanceInfo object

绑定实例的信息

is_pre_paid

Boolean

是否包周期

tags

Array of Tag objects

全域弹性公网IP标签

enterprise_project_id

String

  • 企业项目ID。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。

  • 创建全域弹性公网IP时，给全域弹性公网IP绑定企业项目ID。

  • 不指定该参数时，默认值是 0

  • 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。
表7 InternetBandwidthInfo

参数

参数类型

描述

id

String

全域公网带宽的ID

size

Integer

全域公网带宽大小（出云方向）
表8 GlobalConnectionBandwidthInfo

参数

参数类型

描述

gcb_id

String

骨干带宽的ID

size

Integer

骨干带宽的大小

gcb_type

String

骨干带宽类型（城域、区域和大区）

admin_state

String

  • 功能说明：骨干带宽状态

  • 取值范围：NORMAL 正常、FREEZED 冻结

sla_level

String

  • 功能说明：网络服务等级

  • 取值范围：Pt - 铂金，Au - 金牌，Ag - 银牌，Cu - 铜牌

dscp

Integer

线路质量金银铜对应的DSCP值
表9 InstanceInfo

参数

参数类型

描述

region

String

站点信息

project_id

String

instance_type

String

支持绑定的实例类型

instance_id

String

实例ID

service_type

String

  • 功能说明：绑定实例的服务类型

  • 约束：

    • 该值由调用方传递，非必选，目前绑定CCI服务时会传

service_id

String

  • 功能说明：绑定实例的服务ID

  • 约束：

    • 该值由调用方传递，非必选，目前绑定CCI服务时会传

public_border_group

String

  • 功能说明：表示中心站点资源或者边缘站点资源

  • 取值范围：center、边缘站点名称

最小长度：1

最大长度：64

instance_site

String

绑定实例所在的站点
表10 Tag

参数

参数类型

描述

key

String

  • 功能说明：标签名称

  • 约束：

    • 同一资源的key值不能重复，创建的预定义标签如果与已有的预定义标签完全相同，则会覆盖已有的预定义标签。

    • 键的长度最大36字符，由英文字母、数字、下划线、中划线、中文字符组成。

    • 单个资源最多可以添加20个标签。

最小长度：1

最大长度：36

value

String

  • 功能说明：标签值

  • 约束：

    • 值的长度最大43字符，由英文字母、数字、下划线、点、中划线、中文字符组成。

最小长度：0

最大长度：43
表11 page_info

参数

参数类型

描述

next_marker

String

翻页时，作为后一页的marker取值

previous_marker

String

翻页时，作为前一页的marker取值

current_count

Integer

当前页的数据总数

请求示例

查询全域弹性公网IP列表

GET https://{Endpoint}/v3/{domain_id}/global-eips

响应示例

状态码： 200

OK

{
  "request_id" : "da346cb858ae8d335a6f6b45edbc4836",
  "global_eips" : [ {
    "enterprise_project_id" : 0,
    "name" : "geip-f833",
    "created_at" : "2023-12-11T09:44:44Z",
    "updated_at" : "2023-12-11T09:44:45Z",
    "id" : "393f69a0-e007-45ee-89f0-872d11620f31",
    "description" : null,
    "domain_id" : "f35feb8670a94a04a08d6628e0d5165b",
    "access_site" : "cn-south-odin",
    "geip_pool_name" : "cn-south-odin",
    "isp" : "BGP",
    "ip_version" : 4,
    "freezen" : false,
    "status" : "idle",
    "freezen_info" : null,
    "is_pre_paid" : false,
    "tags" : [ {
      "key" : "tag1",
      "value" : "tom"
    } ],
    "ip_address" : "10.83.68.92",
    "ipv6_address" : null,
    "polluted" : false,
    "internet_bandwidth_info" : {
      "id" : "63d8437d-e0b4-4704-967c-1bc74e5926ef",
      "size" : 100
    },
    "global_connection_bandwidth_info" : null,
    "associate_instance_info" : null
  }, {
    "enterprise_project_id" : 0,
    "name" : "AA-0002",
    "created_at" : "2023-06-28T07:42:52Z",
    "updated_at" : "2023-07-26T09:12:11Z",
    "id" : "3f706cda-46f9-44b9-ac69-57013c912e62",
    "description" : null,
    "domain_id" : "f35feb8670a94a04a08d6628e0d5165b",
    "access_site" : "cn-south-odin",
    "geip_pool_name" : "cn-south-odin",
    "isp" : "BGP",
    "ip_version" : 4,
    "freezen" : false,
    "status" : "inuse",
    "freezen_info" : null,
    "is_pre_paid" : false,
    "tags" : [ ],
    "ip_address" : "10.83.68.160",
    "ipv6_address" : null,
    "polluted" : false,
    "internet_bandwidth_info" : {
      "id" : "ba2edc2b-84c4-4df6-8900-6e6d0df4189e",
      "size" : 10
    },
    "global_connection_bandwidth_info" : {
      "gcb_id" : "76a7b5c4-bb1f-4a25-afa4-d389176707c0",
      "size" : 300,
      "gcb_type" : "Region",
      "admin_state" : "normal",
      "sla_level" : "Au",
      "dscp" : 26
    },
    "associate_instance_info" : {
      "region" : "cn-southwest-242",
      "project_id" : "cb576f8cf0df40b8bb6cea0a1765c569",
      "instance_type" : "ECS",
      "instance_id" : "3f1fd413-2e66-4c85-927d-bb23b128b78b",
      "service_type" : null,
      "service_id" : null,
      "public_border_group" : "center",
      "instance_site" : "cn-south-odin"
    }
  } ],
  "page_info" : {
    "previous_marker" : "393f69a0-e007-45ee-89f0-872d11620f31",
    "current_count" : 2
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 全域弹性公网IP

相关文档