文档首页 > > API参考> API> 弹性公网IP> 查询弹性公网IP

查询弹性公网IP

分享
更新时间: 2019/11/22 GMT+08:00

功能介绍

查询指定弹性公网IP。

URI

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

参数说明请参见 表1
表1 参数说明

名称

是否必选

说明

project_id

项目ID

publicip_id

弹性公网IP唯一标识

请求消息

  • 请求参数

  • 请求样例

响应消息

  • 响应参数
    表2 响应参数

    名称

    参数类型

    说明

    publicip

    Object

    弹性公网IP对象,请参见表3

    表3 publicip字段说明

    名称

    参数类型

    说明

    id

    String

    弹性公网IP唯一标识

    status

    String

    • 功能说明:弹性公网IP的状态
    • 取值范围:
      • FREEZED:冻结
      • BIND_ERROR:绑定失败
      • BINDING:绑定中
      • PENDING_DELETE:释放中
      • PENDING_CREATE:创建中
      • PENDING_UPDATE:更新中
      • DOWN:未绑定
      • ACTIVE:绑定
      • ELB:绑定ELB
      • ERROR:异常失败

    profile

    Object

    功能说明:额外参数,包括订单id、产品id等信息,详情请参见表4

    约束:如果profile不为空,说明是包周期的弹性公网IP

    type

    String

    • 功能说明:弹性公网IP的类型
    • 取值范围:5_telcom(电信),5_union(联通),5_bgp(全动态BGP),5_sbgp(静态BGP)
      • 东北-大连:5_telcom、5_union
      • 华南-广州:5_bgp、5_sbgp
      • 华东-上海二:5_bgp、5_sbgp
      • 华北-北京一:5_bgp、5_sbgp
      • 亚太-香港:5_bgp
      • 亚太-曼谷:5_bgp
      • 亚太-新加坡:5_bgp
      • 非洲-约翰内斯堡:5_bgp
      • 西南-贵阳一:5_sbgp
      • 华北-北京四:5_bgp、5_sbgp
    • 约束:
      • 必须是系统具体支持的类型
      • publicip_id为IPv4端口,所以"publicip_type"字段未给定时,默认为5_bgp。

    public_ipv6_address

    String

    IPv4时无此字段,IPv6时为申请到的弹性公网IP地址

    ip_version

    Integer

    IP版本信息,取值范围是4和6

    • 4:表示IPv4
    • 6:表示IPv6

    private_ip_address

    String

    • 功能说明:绑定弹性公网IP的私有IP地址
    • 约束:只有绑定了的弹性公网IP查询才会返回该参数

    port_id

    String

    • 功能说明:端口id。
    • 约束:只有绑定了的弹性公网IP查询才会返回该参数

    tenant_id

    String

    项目ID

    create_time

    String

    弹性公网IP申请时间(UTC)

    bandwidth_id

    String

    弹性公网IP对应带宽ID

    bandwidth_size

    Integer

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

    bandwidth_share_type

    String

    • 功能说明:弹性公网IP的带宽类型
    • 取值范围:PER,WHOLE。
      • PER:独享带宽
      • WHOLE:共享带宽
    • 约束:其中IPv6暂不支持WHOLE类型带宽。

    bandwidth_name

    String

    带宽名称。

    enterprise_project_id

    String

    • 企业项目ID。最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。
    • 创建弹性公网IP时,给弹性公网IP绑定企业项目ID。
    表4 profile字段说明

    名称

    参数类型

    说明

    order_id

    String

    订单的id

    product_id

    String

    产品的id

    region_id

    String

    region的id

    user_id

    String

    用户的id

  • 响应样例
    {
        "publicip": {
            "id": "2ec9b78d-9368-46f3-8f29-d1a95622a568",
            "status": "DOWN",
            "profile": {
              "user_id": "35f2b308f5d64441a6fa7999fbcd4321",
              "product_id": "00301-48027-0--0",
              "region_id": "xxx",
              "order_id": "xxxxxxxxx"
            },
            "type": "5_bgp",
            "public_ip_address": "161.xx.xx.12",
            "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
            "private_ip_address": "192.168.10.5",
            "create_time": "2015-07-16 04:32:50",
            "bandwidth_id": "49c8825b-bed9-46ff-9416-704b96d876a2",
            "bandwidth_share_type": "PER",
            "bandwidth_size": 10,    //EIP的带宽大小为10Mbit/s
            "bandwidth_name": "bandwidth-test",
            "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439",
            "ip_version": 4
        }
    }

状态码

请参见状态码

错误码

请参考错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区