更新时间:2022-01-25 GMT+08:00

查询私有IP

功能介绍

指定IP的ID查询私有IP。

URI

GET /v1/{project_id}/privateips/{privateip_id}

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

名称

是否必选

说明

project_id

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

privateip_id

私有IP唯一标识

请求消息

  • 请求参数

  • 请求样例
    GET https://{Endpoint}/v1/{project_id}/privateips/d600542a-b231-45ed-af05-e9930cb14f78

响应

  • 响应参数
    表2 响应参数

    名称

    参数类型

    说明

    privateip

    Object

    私有IP对象,请参见表3

    表3 privateip字段说明

    名称

    参数类型

    说明

    status

    String

    • 功能说明:私有IP的状态
    • 取值范围:
      • ACTIVE:活动的
      • DOWN:不可用

    id

    String

    私有IP标识

    subnet_id

    String

    分配IP的子网标识

    tenant_id

    String

    项目ID

    device_owner

    String

    • 功能说明:私有IP的使用者,空表示未使用
    • 取值范围:network:dhcp,network:router_interface_distributed,compute:xxx(xxx对应具体的可用区名称,例如compute:aa-bb-cc表示是被可用区aa-bb-cc上的ECS使用),neutron:VIP_PORT
    • 约束:此处的取值范围只是本服务支持的类型,其他类型未做标注

    ip_address

    String

    申请到的私有IP

  • 响应样例
    {
        "privateip": 
            {
                "status": "DOWN",
                "id": "d600542a-b231-45ed-af05-e9930cb14f78",
                "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd",
                "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
                "device_owner": "",
                "ip_address": "192.168.1.11"
            }
    }

状态码

请参见状态码

错误码

请参考错误码