更新时间:2024-03-05 GMT+08:00

查询弹性IP

功能介绍

查询指定弹性IP

URI

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

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

名称

是否必选

说明

project_id

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

publicip_id

弹性IP唯一标识

请求消息

  • 请求参数

  • 请求样例
    Get https://{Endpoint}/v1/{project_id}/publicips/{publicip_id}

响应消息

  • 响应参数
    表2 响应参数

    名称

    参数类型

    说明

    publicip

    publicip object

    弹性IP对象,请参见表3

    表3 publicip字段说明

    名称

    参数类型

    说明

    id

    String

    弹性IP唯一标识

    status

    String

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

    type

    String

    • 功能说明:弹性IP的类型
    • 约束:
      • 必须是系统具体支持的类型
      • publicip_id为IPv4端口,所以"publicip_type"字段未给定时,默认为5_bgp。

    private_ip_address

    String

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

    port_id

    String

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

    tenant_id

    String

    项目ID

    create_time

    String

    弹性IP申请时间(UTC)

    格式:yyyy-MM-dd HH:mm:ss

    bandwidth_id

    String

    弹性IP对应带宽ID

    bandwidth_size

    Integer

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

    bandwidth_share_type

    String

    • 功能说明:弹性IP的带宽类型
    • 取值范围:PER,WHOLE。
      • PER:独享带宽
      • WHOLE:共享带宽

    alias

    String

    弹性公网IP名称

    public_border_group

    String

    功能说明:表示中心站点资源或者边缘站点资源。

    取值范围:

    • center
    • 边缘站点名称

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

  • 响应样例
    {
        "publicip": {
            "id": "2ec9b78d-9368-46f3-8f29-d1a95622a568",
            "status": "DOWN",
            "alias": "tom",
            "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
            "ip_version": 4
        }
    }

状态码

请参见状态码

错误码

请参考错误码