更新时间:2024-09-11 GMT+08:00

查询弹性公网IP

功能介绍

查询弹性公网IP。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

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

instance_id

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

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

Content-Type

String

内容类型。

取值:application/json。

X-Language

String

语言。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

can_enable_public_access

Boolean

是否能访问公网。

id

String

弹性公网ID。

type

String

弹性公网IP的网络类型。

port_id

String

端口ID。

public_ip_address

String

弹性公网IP地址。

private_ip_address

String

私网IP地址。

status

String

弹性公网IP状态。

tenant_id

String

租户ID。

create_time

String

创建时间。

bandwidth_id

String

带宽ID。

bandwidth_name

String

带宽名称。

bandwidth_size

String

带宽大小。

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" : { }
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码