更新时间:2024-04-15 GMT+08:00

查询弹性公网IP列表

功能介绍

查询弹性公网IP列表。

URI

GET /v1/{project_id}/publicips

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

名称

是否必选

参数类型

说明

project_id

String

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

marker

String

分页查询的起始资源ID,表示从指定资源的下一条记录开始查询。

marker需要和limit配合使用:

  • 若不传入marker和limit参数,查询结果返回第一页全部资源记录。
  • 若不传入marker参数,limit为10,查询结果返回第1~10条资源记录。
  • 若marker为第10条记录的资源ID,limit为10,查询结果返回第11~20条资源记录。
  • 若marker为第10条记录的资源ID,不传入limit参数,查询结果返回第11条及之后的所有资源记录。

limit

Integer

分页查询每页返回的记录个数,取值范围为0~intmax(2^31-1),默认值2000。

limit需要和marker配合使用,详细规则请见marker的参数说明。

请求消息

  • 请求参数

  • 请求样例
    GET https://{Endpoint}/v1/{project_id}/publicips?limit={limit}&marker={marker}

响应消息

  • 响应参数
    表2 响应参数

    名称

    参数类型

    说明

    publicips

    Array of publicips objects

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

    表3 publicips字段说明

    名称

    参数类型

    说明

    id

    String

    弹性公网IP唯一标识

    status

    String

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

    type

    String

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

    public_ip_address

    String

    IPv4时是申请到的弹性公网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)

    格式: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资源

  • 响应样例
    {
        "publicips": [
            {
                "id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
                "status": "DOWN",
                "alias": "tom",
                "type": "5_bgp",
                "public_ip_address": "161.xx.xx.9",
                "private_ip_address": "192.168.10.5",
                "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
                "create_time": "2015-07-16 04:22:32",
                "bandwidth_id": "3fa5b383-5a73-4dcb-a314-c6128546d855",
                "bandwidth_share_type": "PER",
                "bandwidth_size": 5,
                "ip_version": 4
            },
            {
                "id": "80d5b82e-43b9-4f82-809a-37bec5793bd4",
                "status": "DOWN",
                "type": "5_bgp",
                "public_ip_address": "161.xx.xx.10",
                "private_ip_address": "192.168.10.6",
                "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
                "create_time": "2015-07-16 04:23:03",
                "bandwidth_id": "a79fd11a-047b-4f5b-8f12-99c178cc780a",
                "bandwidth_share_type": "PER",
                "bandwidth_size": 5,
                "ip_version": 4
            }
        ]
    }

状态码

请参见状态码

错误码

请参考错误码