华为云计算 云知识 查询弹性公网IPShowPublicip
查询弹性公网IPShowPublicip

 

功能介绍

查询指定的EIP。

调试

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

URI

GET /v1/{project_id}/publicips/{publicip_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取项目ID请参见获取项目ID

publicip_id

String

EIP唯一标识

最大长度:36

请求参数

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

publicip

PublicipShowResp object

EIP对象

表3 PublicipShowResp

参数

参数类型

描述

bandwidth_id

String

  • 功能说明:EIP对应带宽ID

最大长度:36

bandwidth_name

String

  • 功能说明:带宽名称

最小长度:1

最大长度:64

bandwidth_share_type

String

  • 功能说明:表示共享带宽或者独享带宽

  • 取值范围:

    • WHOLE:共享带宽

    • PER:独享带宽

  • 约束:其中IPv6暂不支持WHOLE类型带宽。

枚举值:

  • WHOLE

  • PER

bandwidth_size

Integer

  • 功能说明:带宽大小,单位为Mbit/s。

最小值:0

create_time

String

  • 功能说明:EIP申请时间(UTC)

ent erp rise_project_id

String

  • 企业项目ID。最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。

  • 创建 弹性公网IP 时,给弹性 公网IP 绑定企业项目ID。

  • 不指定该参数时,默认值是 0

关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》

最大长度:36

id

String

  • 功能说明:EIP唯一标识

最大长度:36

port_id

String

  • 功能说明:端口id。

  • 约束:只有绑定了的EIP查询才会返回该参数

最大长度:36

private_ip_address

String

  • 功能说明:绑定弹性公网IP的私有IP地址

  • 约束:只有绑定了的弹性公网IP查询才会返回该参数

profile

ProfileResp object

  • 功能说明:额外参数,包括订单id、产品id等信息

  • 约束:如果profile不为空,说明是包周期的EIP

public_ip_address

String

  • 功能说明:IPv4时是申请到的EIP地址,IPv6时是IPv6地址对应的IPv4地址

最大长度:15

status

String

  • 功能说明:弹性公网IP的状态

  • 取值范围

    • FREEZED:冻结

    • BIND_ERROR:绑定失败

    • BINDING:绑定中

    • PENDING_DELETE:释放中

    • PENDING_CREATE:创建中

    • NOTIFYING:创建中

    • NOTIFY_DELETE:释放中

    • PENDING_UPDATE:更新中

    • DOWN:未绑定

    • ACTIVE:绑定

    • ELB:绑定ELB

    • VPN:绑定VPN

    • ERROR:失败

枚举值:

  • FREEZED

  • BIND_ERROR

  • BINDING

  • PENDING_DELETE

  • PENDING_CREATE

  • NOTIFYING

  • NOTIFY_DELETE

  • PENDING_UPDATE

  • DOWN

  • ACTIVE

  • ELB

  • VPN

  • ERROR

tenant_id

String

  • 功能说明:项目ID

最大长度:36

type

String

  • 功能说明:EIP的类型

  • 取值范围:5_bgp(全动态BGP),5_sbgp(静态BGP),5_youxuanbgp(优选BGP)

    • 华南-广州:5_bgp、5_sbgp

    • 华东-上海一:5_bgp、5_sbgp

    • 华东-上海二:5_bgp、5_sbgp

    • 华北-北京一:5_bgp、5_sbgp

    • 中国-香港:5_bgp、5_youxuanbgp

    • 亚太-曼谷:5_bgp

    • 亚太-新加坡:5_bgp

    • 非洲-约翰内斯堡:5_bgp

    • 西南-贵阳一:5_sbgp

    • 华北-北京四:5_bgp、5_sbgp

    • 拉美-圣地亚哥:5_bgp

    • 拉美-圣保罗一:5_bgp

    • 拉美-墨西哥城一:5_bgp

    • 拉美-布宜诺斯艾利一:5_bgp

    • 拉美-利马一:5_bgp

    • 拉美-圣地亚哥二: 5_bgp

  • 约束:

    • 必须是系统具体支持的类型。

    • publicip_id为IPv4端口,所以"type"字段未给定时,默认为5_bgp。

最大长度:36

public_ipv6_address

String

  • 功能说明:IPv4时无此字段,IPv6时为申请到的EIP地址

最大长度:39

ip_version

Integer

  • 功能说明:IP版本信息

  • 取值范围是4和6,IPv6为开启NAT64能力

    • 4:IPv4

    • 6:IPv6

枚举值:

  • 4

  • 6

public_border_group

String

  • 功能说明:表示中心站点资源或者边缘站点资源,对接了边缘站点的区域才会返回该字段

  • 取值范围: center、边缘站点名称

  • 约束:publicip只能绑定该字段相同的资源

最小长度:1

最大长度:64

allow_share_bandwidth_types

Array of strings

  • 功能说明:表示此publicip可以加入的共享带宽类型列表,如果列表为空,则表示该publicip不能加入任何共享带宽

  • 约束:publicip只能加入到有该带宽类型的共享带宽中

最大长度:64

alias

String

  • 功能说明:弹性公网IP名称

  • 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)

最大长度:64

表4 ProfileResp

参数

参数类型

描述

order_id

String

订单的id

最大长度:36

product_id

String

产品的id

最大长度:36

region_id

String

region的id

最大长度:36

user_id

String

用户的id

最大长度:36

请求示例

查询id为2ec9b78d-9368-46f3-8f29-d1a95622a568的弹性公网IP详情

GET https://{Endpoint}/v1/{project_id}/publicips/2ec9b78d-9368-46f3-8f29-d1a95622a568

响应示例

状态码: 200

GET操作正常返回

{
  "publicip" : {
    "tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
    "bandwidth_name" : "bandwidth-test",
    "public_ip_address" : "161.xx.xx.12",
    "create_time" : "2015-07-16 04:32:50",
    "profile" : {
      "user_id" : "35f2b308f5d64441a6fa7999fbcd4321",
      "product_id" : "00301-48027-0--0",
      "region_id" : "xxx",
      "order_id" : "xxxxxxxxx"
    },
    "type" : "5_bgp",
    "bandwidth_id" : "49c8825b-bed9-46ff-9416-704b96d876a2",
    "bandwidth_size" : 10,
    "enterprise_project_id" : "b261ac1f-2489-4bc7-b31b-c33c3346a439",
    "ip_version" : 4,
    "private_ip_address" : "192.168.10.5",
    "bandwidth_share_type" : "PER",
    "id" : "2ec9b78d-9368-46f3-8f29-d1a95622a568",
    "status" : "ACTIVE",
    "port_id" : "4977b983-cd4f-4ecc-93a1-cb52d848a9b3",
    "public_border_group" : "center",
    "allow_share_bandwidth_types" : [ "share" ]
  }
}

状态码

状态码

描述

200

GET操作正常返回

错误码

请参见错误码

 

上一篇:删除函数/版本DeleteFunction 下一篇:查询流日志ShowFlowLog

弹性公网IP EIP

弹性公网IP(Elastic IP)提供独立的公网IP资源,包括公网IP地址与公网出口带宽服务。可以与弹性云服务器、裸金属服务器、虚拟IP、弹性负载均衡、NAT网关等资源灵活地绑定及解绑。拥有多种灵活的计费方式,可以满足各种业务场景的需要

动态BGP带宽:¥23.00/M/月起