文档首页/ 弹性公网IP EIP/ API参考/ GEIP API/ 全域公网带宽标签/ 查询全域弹性公网IP段列表

更新时间：2025-02-07 GMT+08:00

查看PDF

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

功能介绍

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

调试

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

URI

GET /v3/{domain_id}/global-eip-segments

表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 description domain_id access_site geip_pool_name isp ip_version cidr cidr_v6 freezen freezen_info status created_at updated_at internet_bandwidth associate_instance is_pre_paid tags sys_tags enterprise_project_id
sort_key	否	Array of strings	按照sort_key指定的字段排序
sort_dir	否	Array of strings	功能说明：排序方向取值范围：asc（升序）、desc（降序）
id	否	Array of strings	根据资源ID过滤
internet_bandwidth_id	否	Array of strings	根据全域公网带宽的ID过滤，支持多值查询，查询条件格式：internet_bandwidth_id=xxx&internet_bandwidth_id=xxx。
name	否	Array of strings	根据名称过滤，支持多值查询，查询条件格式：name=xxx&name=xxx。
name_like	否	String	根据名称模糊匹配
access_site	否	Array of strings	根据接入点过滤，支持多值查询，查询条件格式：access_site=xxx&access_site=xxx。
geip_pool_name	否	Array of strings	根据全域弹性公网IP池名称过滤，支持多值查询，查询条件格式：geip_pool_name=xxx&geip_pool_name=xxx。
isp	否	Array of strings	根据运营商线路过滤，支持多值查询，查询条件格式：isp=xxx&isp=xxx。
ip_version	否	Array of integers	根据可分配的IP版本过滤
cidr	否	Array of strings	根据分配的CIDR过滤
cidr_v6	否	Array of strings	根据分配的IPv6 CIDR过滤
freezen	否	Array of booleans	根据是否冻结过滤
internet_bandwidth_is_null	否	Array of booleans	根据是否绑定全域公网带宽过滤
status	否	Array of strings	根据状态过滤
associate_instance.region	否	Array of strings	根据绑定实例所属的局点过滤
associate_instance.instance_type	否	Array of strings	根据绑定实例的类型过滤
associate_instance.public_border_group	否	Array of strings	功能说明：根据绑定实例所属的边缘信息过滤取值范围：center、边缘站点名称
associate_instance.instance_site	否	Array of strings	根据绑定实例所在的站点过滤
associate_instance.instance_id	否	Array of strings	根据绑定实例的ID过滤
associate_instance.project_id	否	Array of strings	根据绑定实例所属的项目ID过滤
associate_instance.service_id	否	Array of strings	根据绑定实例所属的服务ID过滤
associate_instance.service_type	否	Array of strings	根据绑定实例的服务类型过滤
enterprise_project_id	否	Array of strings	根据企业项目ID过滤
tags	否	Array of strings	根据标签过滤，过滤格式为key1\|value1,key2\|value2,...

请求参数

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

响应参数

状态码： 200

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

表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	租户账号ID，获取租户账号ID请参见租户账号ID
access_site	String	接入点信息，具体接入点信息可通过查询接入点列表接口查询。
geip_pool_name	String	全域弹性公网IP池子名称
isp	String	全域公网带宽接入的线路，接入线路信息可通过查询全域弹性公网IP池列表接口查询。
ip_version	Integer	功能说明：全域弹性公网IP段的版本取值范围：4、6
cidr	String	全域公网IP段的cidr
cidr_v6	String	指定cidr-v6创建
freezen	Boolean	是否冻结
freezen_info	String	冻结原因
status	String	状态
created_at	String	创建时间
updated_at	String	更新时间
internet_bandwidth	InternetBandwidthInfo object	全域公网带宽信息
associate_instance	InstanceInfo object	绑定实例的信息
global_connection_bandwidth_info	GlobalConnectionBandwidthInfo 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	项目ID，获取项目ID请参见获取项目ID
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 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值

**表10** Tag
参数	参数类型	描述
key	String	功能说明：标签名称约束：同一资源的key值不能重复，创建的预定义标签如果与已有的预定义标签完全相同，则会覆盖已有的预定义标签。键的长度最大128字符，由英文字母、数字、下划线、中划线、中文字符组成。单个资源最多可以添加20个标签。最小长度：1 最大长度：128
value	String	功能说明：标签值约束：值的长度最大255字符，由英文字母、数字、下划线、点、中划线、中文字符组成。最小长度：0 最大长度：255

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

请求示例

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

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

响应示例

状态码： 200

{
  "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段

下一篇：查询全域弹性公网IP段详情

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

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

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线