文档首页/ 弹性公网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-eip-segments

表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版本过滤

cidr

否

Array

根据分配的CIDR过滤

cidr_v6

否

Array

根据分配的IPv6 CIDR过滤

freezen

否

Array

根据是否冻结过滤

internet_bandwidth_is_null

否

Array

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

status

否

Array

根据状态过滤

associate_instance.region

否

Array

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

associate_instance.instance_type

否

Array

根据绑定实例的类型过滤

associate_instance.public_border_group

否

Array

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

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

associate_instance.instance_site

否

Array

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

associate_instance.instance_id

否

Array

根据绑定实例的ID过滤

associate_instance.project_id

否

Array

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

associate_instance.service_id

否

Array

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

associate_instance.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_eip_segments

Array of ListGlobalEipSegments objects

全域弹性公网IP段对象

page_info

page_info object

分页页码信息
表6 ListGlobalEipSegments

参数

参数类型

描述

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_version

Integer

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

  • 取值范围：4、6

枚举值：

  • 4

  • 6

cidr

String

全域公网IP段的cidr

cidr_v6

String

指定cidr-v6创建

freezen

Boolean

是否冻结

freezen_info

String

冻结原因

status

String

状态

枚举值：

  • IDLE

  • INUSE

created_at

String

创建时间

updated_at

String

更新时间

internet_bandwidth

InternetBandwidthInfo object

全域公网带宽信息

associate_instance

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 InstanceInfo

参数

参数类型

描述

region

String

站点信息

project_id

String

instance_type

String

支持绑定的实例类型

instance_id

String

实例ID

service_type

String

服务类型

service_id

String

服务ID

public_border_group

String

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

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

最小长度：1

最大长度：64

instance_site

String

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

参数

参数类型

描述

key

String

  • 功能说明：标签名称

  • 约束：

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

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

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

最小长度：1

最大长度：36

value

String

  • 功能说明：标签值

  • 约束：

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

最小长度：0

最大长度：43
表10 page_info

参数

参数类型

描述

next_marker

String

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

previous_marker

String

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

current_count

Integer

当前页的数据总数

请求示例

查询全域弹性公网IP段列表

GET https://{Endpoint}/v3/{domain_id}/global-eip-segments

响应示例

状态码： 200

OK

{
  "request_id" : "d224afc0e7add65c715707dbadd3004a",
  "global_eip_segments" : [ {
    "enterprise_project_id" : 0,
    "name" : "geip-48bb",
    "created_at" : "2023-12-12T11:41:49Z",
    "updated_at" : "2023-12-12T11:41:50Z",
    "id" : "cc3da1f6-fa84-4161-98f9-89e2563dff27",
    "description" : null,
    "domain_id" : "f35feb8670a94a04a08d6628e0d5165b",
    "access_site" : "cn-south-odin",
    "geip_pool_name" : "test_dc_segment",
    "isp" : "BGP",
    "ip_version" : 4,
    "freezen" : false,
    "status" : "idle",
    "freezen_info" : null,
    "is_pre_paid" : false,
    "tags" : [ ],
    "cidr" : "215.255.202.192/26",
    "cidr_v6" : null,
    "internet_bandwidth" : {
      "id" : "1975a0b2-faee-48f5-a0f3-fe1c5586efec",
      "size" : 100
    },
    "associate_instance" : null
  } ],
  "page_info" : {
    "previous_marker" : "cc3da1f6-fa84-4161-98f9-89e2563dff27",
    "current_count" : 1
  }
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 全域弹性公网IP段

相关文档