# 查询已绑定的弹性公网IP列表 - QueryingEIPsBoundtoaDBInstance #### 功能介绍 查询实例已绑定的弹性公网IP列表。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ListBindedEips)中调试该接口。 #### URI GET /v3/{project_id}/instances/{instance_id}/public-ips 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID，此参数是用户创建实例的唯一标识。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取实例ID。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值** **：** 不涉及。 | | offset | 否 | Integer | **参数解释：** 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 **约束限制：** 不涉及。 **取值范围：** ≥0。 **默认取值** **：** 默认为0（偏移0条数据，表示从第一条数据开始查询）。 | | limit | 否 | Integer | **参数解释：** 查询记录数。 **约束限制：** 不涉及。 **取值范围：** 最小值为1，最大值为50。 **默认取值** **：** 默认为50。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | X-Language | 否 | String | **参数解释：** 指定接口返回信息的语言类型。 **约束限制：** 不涉及。 **取值范围：** - **zh-cn**：中文 - **en-us**：英文 **默认取值** **：** **en-us** | #### 响应参数 表3参数说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | public_ips | Array of objects | **参数解释** **：** 查询实例已绑定EIP列表。 详情请参见[表4]。 | | total_count | Integer | **参数解释** **：** 实例已绑定的弹性公网IP总数。 **取值范围** **：** 不涉及。 | 表4public_ips字段数据结构说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | public_ip_id | String | **参数解释** **：** 弹性公网ID。 **取值范围** **：** 不涉及。 | | public_ip_type | String | **参数解释** **：** 弹性公网类型。 **取值范围** **：** - 5_bgp：全动态BGP。 - 5_sbgp：静态BGP。 - 5_youxuanbgp：优选BGP。 | | port_id | String | **参数解释** **：** 端口ID。 **取值范围** **：** 不涉及。 | | public_ip_address | String | **参数解释** **：** 弹性公网IP。 **取值范围** **：** 不涉及。 | | private_ip_address | String | **参数解释** **：** 内网地址。 **取值范围** **：** 不涉及。 | | bandwidth_id | String | **参数解释** **：** 带宽ID。 **取值范围** **：** 不涉及。 | | bandwidth_name | String | **参数解释** **：** 带宽名称。 **取值范围** **：** 不涉及。 | | bandwidth_share_type | String | **参数解释** **：** 带宽共享类型。 **取值范围** **：** - WHOLE：共享带宽。 - PER：独享带宽。 | | bandwidth_size | Integer | **参数解释** **：** 带宽大小。单位：Mbit/s。 **取值范围** **：** 不涉及。 | | applied_at | String | **参数解释** **：** 修改时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+08:00。 **取值范围** **：** 不涉及。 | #### 请求示例 查询实例已绑定的弹性公网IP列表。 ``` GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/599628f2665841b2a66fa2780fadc025/instances/e0984e23578c4296950336e613d99d32in14/public-ips?offset=0&limit=1 ``` #### 响应示例 查询实例已绑定的弹性公网IP列表成功。 ``` { "public_ips" : [ { "public_ip_id" : "78458261-5175-4254-8242-5959115d379a", "public_ip_type" : "5_bgp", "port_id" : "a8d606bf-7e20-463d-afed-b7fc2909aa7d", "public_ip_address" : "100.95.156.144", "private_ip_address" : "192.168.0.133", "applied_at" : "2022-08-09T03:06:52+08:00", "bandwidth_id" : "7ae23d75-3150-4957-94ae-9352b15f140e", "bandwidth_name" : "Bandwidth_2021-12-08-16-39-27", "bandwidth_size" : 5, "bandwidth_share_type" : "PER" } ], "total_count" : 1 } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。