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

功能介绍

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

调试

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

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

eip:geipSegments:list

List

geipSegment *

-

-

-

-

g:EnterpriseProjectId

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
eip:geipSegments:list	List	geipSegment *	-	-	-
-	g:EnterpriseProjectId

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_address	否	Array of strings	根据指定的ip在CIDR中过滤
ipv6_address	否	Array of strings	根据指定的ipv6在CIDR_V6中过滤
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	参数解释：根据全域弹性公网IP段状态过滤。约束限制：不涉及取值范围： IDLE：全域弹性公网IP段未绑定实例。 INUSE：全域弹性公网IP段使用中。 FREEZED：全域弹性公网IP段被冻结。 PENDING_CREATE:全域弹性公网IP段创建中。 PENDING_UPDATE：全域弹性公网IP段更新中。默认取值：不涉及
associate_instance.region	否	Array of strings	根据绑定实例所属的局点过滤
associate_instance.instance_type	否	Array of strings	参数解释：根据支持绑定的实例类型过滤。约束限制：不涉及取值范围： DC-CONNECT-GATEWAY：云专线。 IPV6-DC-CONNECT-GATEWAY:IPV6云专线。默认取值：不涉及
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	功能说明：绑定实例的服务类型约束与限制：该值由调用方传递，非必选，目前绑定CCI服务时会传取值范围：无枚举值，上层服务标记使用。默认取值：不涉及
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	本次请求编号

请求示例

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

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

响应示例

状态码：200

{
  "example" : {
    "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,
      "is_charged" : true,
      "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
    }
  },
  "schema" : {
    "$ref" : "#/components/schemas/ListGlobalEipSegmentsResponseBody"
  }
}