# 查询全域弹性公网IP列表 - ListGlobalEips #### 功能介绍 查询全域弹性公网IP列表。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GEIP/doc?api=ListGlobalEips)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-eip/eip_apipermission_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | eip:globalEips:list | List | globalEip \* | - | - | - | | eip:globalEips:list | List | - | g:EnterpriseProjectId | - | - | #### URI GET /v3/{domain_id}/global-eips 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | domain_id | 是 | String | - 租户账号ID，获取租户账号ID请参见[租户账号ID](https://support.huaweicloud.com/api-iam/iam_17_0002.html) 最小长度：**5** 最大长度：**32** | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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 - ip_address - ipv6_address - freezen - freezen_info - polluted - status - created_at - updated_at - internet_bandwidth_info - global_connection_bandwidth_info - associate_instance_info - 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过滤，支持多值查询，查询条件格式：id=xxx\&id=xxx。 | | 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版本过滤，支持多值查询，查询条件格式：ip_version=xxx\&ip_version=xxx。 | | ip_address | 否 | Array of strings | 根据ip地址过滤，支持多值查询，查询条件格式：ip_address=xxx\&ip_address=xxx。 | | ipv6_address | 否 | Array of strings | 根据ipv6地址过滤，支持多值查询，查询条件格式：ipv6_address=xxx\&ipv6_address=xxx。 | | freezen | 否 | Array of booleans | 根据是否冻结过滤，支持多值查询，查询条件格式：freezen=xxx\&freezen=xxx。 | | polluted | 否 | Array of booleans | 根据是否污染过滤，支持多值查询，查询条件格式：polluted=xxx\&polluted=xxx。 | | internet_bandwidth_is_null | 否 | Array of booleans | 根据是否绑定全域公网带宽过滤 | | gcb_bandwidth_is_null | 否 | Array of booleans | 根据是否绑定骨干带宽过滤 | | status | 否 | Array of strings | 根据资源状态过滤，支持多值查询，查询条件格式：status=xxx\&status=xxx。 | | associate_instance_info.region | 否 | Array of strings | 根据绑定实例所属的局点过滤，支持多值查询，查询条件格式：id=xxx\&id=xxx。 | | associate_instance_info.instance_type | 否 | Array of strings | 根据绑定实例的类型过滤，支持多值查询，查询条件格式：id=xxx\&id=xxx。 | | associate_instance_info.public_border_group | 否 | Array of strings | - 功能说明：根据绑定实例所属的边缘信息过滤，支持多值查询，查询条件格式：id=xxx\&id=xxx。 - 取值范围：center、边缘站点名称 | | associate_instance_info.instance_site | 否 | Array of strings | 根据绑定实例所在的站点过滤，支持多值查询，查询条件格式：id=xxx\&id=xxx。 | | associate_instance_info.instance_id | 否 | Array of strings | 根据绑定实例的ID过滤，支持多值查询，查询条件格式：id=xxx\&id=xxx。 | | associate_instance_info.project_id | 否 | Array of strings | 根据绑定实例所属的项目ID过滤，支持多值查询，查询条件格式：id=xxx\&id=xxx。 | | associate_instance_info.service_id | 否 | Array of strings | 根据绑定实例所属的服务ID过滤，支持多值查询，查询条件格式：id=xxx\&id=xxx。 | | associate_instance_info.service_type | 否 | Array of strings | 根据绑定实例的服务类型过滤，支持多值查询，查询条件格式：id=xxx\&id=xxx。 | | enterprise_project_id | 否 | Array of strings | 根据企业项目ID过滤，支持多值查询，查询条件格式：id=xxx\&id=xxx。 | | tags | 否 | Array of strings | 根据标签过滤，过滤格式为key1\|value1,key2\|value2,... | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户的Token，如何获取用户Token请参见[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html#iam_30_0001__li195948474711) | #### 响应参数 **状态码：200** 表4响应Header参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | X-Request-Id | String | 本次请求编号 | 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 本次请求的编号 | | global_eips | Array of [ListGlobalEips] objects | 全域弹性公网IP列表 | | page_info | [page_info] object | 分页页码信息 | 表6ListGlobalEips | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 全域弹性公网IP的ID | | name | String | - 功能说明：全域弹性公网IP名称 - 取值范围：1-64，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） 最小长度：**1** 最大长度：**64** | | description | String | - 功能说明：用户自定义的资源描述 - 约束与限制： - 值的长度最大512字符，由数字、字母、中文、_(下划线)、-（中划线）、.（点）组成。 最小长度：**0** 最大长度：**512** | | domain_id | String | - 租户账号ID，获取租户账号ID请参见[租户账号ID](https://support.huaweicloud.com/api-iam/iam_17_0002.html) | | access_site | String | 接入点信息，具体接入点信息可通过[查询接入点列表](https://support.huaweicloud.com/api-eip/ListAccessSites.html)接口查询。 | | geip_pool_name | String | 全域弹性公网IP池子名称 | | isp | String | 全域弹性公网IP所属线，接入线路信息可通过[查询全域弹性公网IP池列表](https://support.huaweicloud.com/api-eip/ListGeipPools.html)接口查询。 | | ip_version | Integer | - 功能说明：全域弹性公网IP的版本 - 取值范围：4、6 | | ip_address | String | IPv4地址 | | ipv6_address | String | IPv6地址 | | freezen | Boolean | 是否冻结 | | freezen_info | String | 冻结原因 | | polluted | Boolean | 是否污染 | | is_charged | Boolean | 是否收费 | | status | String | 全域弹性公网IP的状态 | | 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的获取及企业项目特性的详细信息，请参见[《企业管理用户指南》](https://support.huaweicloud.com/usermanual-em/zh-cn_topic_0126101490.html)。 | | tos_infos | Array of [tos] objects | 全域公网带宽服务分类信息 | 表7InternetBandwidthInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | 全域公网带宽的ID | | size | Integer | 全域公网带宽大小（出云方向） | 表8GlobalConnectionBandwidthInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | gcb_id | String | 骨干带宽的ID | | size | Integer | 骨干带宽的大小 | | gcb_type | String | 骨干带宽类型（城域、区域和大区） | | admin_state | String | - 功能说明：骨干带宽状态 - 取值范围：NORMAL 正常、FREEZED 冻结 | | sla_level | String | - 功能说明：网络服务等级 - 取值范围：Pt - 铂金，Au - 金牌，Ag - 银牌，Cu - 铜牌 | | dscp | Integer | 线路质量金银铜对应的DSCP值 | 表9InstanceInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | region | String | 站点信息 | | project_id | String | - 项目ID，获取项目ID请参见[获取项目ID](https://support.huaweicloud.com/api-vpc/vpc_api_0011.html) | | 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 | 绑定实例所在的站点 | 表10Tag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | - 功能说明：标签名称 - 约束与限制： - 同一资源的key值不能重复，创建的预定义标签如果与已有的预定义标签完全相同，则会覆盖已有的预定义标签。 - 键的长度最大128字符，由英文字母、数字、下划线、中划线、中文字符组成。 - 单个资源最多可以添加20个标签。 最小长度：**1** 最大长度：**128** | | value | String | - 功能说明：标签值 - 约束与限制： - 值的长度最大255字符，由英文字母、数字、下划线、点、中划线、中文字符组成。 最小长度：**0** 最大长度：**255** | 表11tos | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | 服务类型标识 | | code | Integer | 服务类型编码 | 表12page_info | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | 翻页时，作为后一页的marker取值 | | previous_marker | String | 翻页时，作为前一页的marker取值 | | current_count | Integer | 当前页的数据总数 | #### 请求示例 查询全域弹性公网IP列表 ``` GET https://{Endpoint}/v3/{domain_id}/global-eips ``` #### 响应示例 **状态码：200** ``` { "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, "is_charged" : true, "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, "tos_infos" : [ { "type" : "骨干", "code" : 3 }, { "type" : "IEC-CN", "code" : 2 } ] }, { "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" }, "tos_infos" : [ { "type" : "IEC-LA", "code" : 4, "dscp" : 20 } ] } ], "page_info" : { "previous_marker" : "393f69a0-e007-45ee-89f0-872d11620f31", "current_count" : 2 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eip/ErrorCode.html)。