文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 实例管理/ 查询弹性公网IP- ShowInstanceEip
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询弹性公网IP - ShowInstanceEip

功能介绍

查询弹性公网IP。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:instance:getPublicIp

    Read

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:instance:list

    -

URI

GET /v3/{project_id}/instances/{instance_id}/eip

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，此参数是实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，后缀为in07，长度为36个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

can_enable_public_access

Boolean

参数解释：

是否能访问公网。

取值范围：

  • true：能访问。

  • false: 不能访问。

id

String

参数解释：

弹性公网ID。

取值范围：

不涉及。

type

String

参数解释：

弹性公网IP的网络类型。

取值范围：

  • 5_bgp：全动态BGP。

  • 5_sbgp：静态BGP。

  • 5_youxuanbgp：优选BGP。

port_id

String

参数解释：

端口ID。

取值范围：

不涉及。

public_ip_address

String

参数解释：

弹性公网IP地址。

取值范围：

不涉及。

private_ip_address

String

参数解释：

绑定弹性公网IP的私有IP地址。

取值范围：

不涉及。

status

String

参数解释：

弹性公网IP状态。

取值范围：

  • FREEZED：冻结。

  • BIND_ERROR：绑定失败。

  • BINDING：绑定中。

  • PENDING_DELETE：释放中。

  • PENDING_CREATE：创建中。

  • NOTIFYING：创建中。

  • NOTIFY_DELETE：释放中。

  • PENDING_UPDATE：更新中。

  • DOWN：未绑定。

  • ACTIVE：绑定。

  • ELB：绑定ELB。

  • VPN：绑定VPN。

  • ERROR：失败。

tenant_id

String

参数解释：

租户ID。

取值范围：

不涉及。

create_time

String

参数解释：

弹性公网IP申请时间。

取值范围：

不涉及。

bandwidth_id

String

参数解释：

带宽ID。

取值范围：

不涉及。

bandwidth_name

String

参数解释：

带宽名称。

取值范围：

不涉及。

bandwidth_size

String

参数解释：

带宽大小，单位为Mbit/s。

取值范围：

不涉及。

bandwidth_share_type

String

参数解释：

带宽类型。

取值范围：

  • PER：独享带宽。

  • WHOLE：共享带宽。

profile

Object

参数解释：

额外参数，包括订单ID、产品ID等信息。如果profile不为空，说明是包周期的弹性公网IP。

取值范围：

不涉及。

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询弹性公网IP。

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/12a49c2dc32648df8dd25e2976f70180in07/eip

响应示例

状态码： 200

Success.

{
  "can_enable_public_access" : true,
  "id" : "45a0ed37-cfa7-4403-8aeb-d720b4e831cf",
  "type" : "5_bgp",
  "port_id" : "2c02dc5b-a136-4921-b7ad-27e084548616",
  "public_ip_address" : "10.83.35.151",
  "private_ip_address" : "172.16.1.137",
  "status" : "ACTIVE",
  "tenant_id" : "23a50154cf494ec9ad6883979a12db0a",
  "create_time" : "2024-04-09 13:42:11",
  "bandwidth_id" : "2a4b2bc5-2a0a-42df-8f13-2fbe3d8bbbb2",
  "bandwidth_name" : "bandwidth-d3f4",
  "bandwidth_size" : 1,
  "bandwidth_share_type" : "PER",
  "profile" : { }
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 实例管理