文档首页/虚拟私有云 VPC/API参考/API V1/V2/私有IP/查询私有IP - ShowPrivateip
更新时间：2025-12-23 GMT+08:00
查看PDF
分享

查询私有IP - ShowPrivateip

功能介绍

指定IP的ID查询私有IP。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    vpc:privateIps:get

    Read

    privateIp *

    • vpc:PrivateIpId
    • vpc:SubnetId
    • vpc:VpcId

    -

    -

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

privateip object

私有IP对象，请参见表3。

表3 privateip字段说明

名称

参数类型

说明

status

String

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

id

String

私有IP标识

subnet_id

String

分配IP的子网标识

如果您使用管理控制台，此值即为子网详情中的“网络ID”参数值。

tenant_id

String

项目ID

device_owner

String

  • 功能说明：私有IP的使用者，空表示未使用
  • 取值范围：

    network:dhcp DHCP服务IP地址

    network:router_interface_distributed 网关IP地址

    compute:xxx(xxx对应具体的可用区名称，例如compute:aa-bb-cc表示是被可用区aa-bb-cc上的ECS使用) 虚拟机网卡IP地址

    neutron:VIP_PORT 虚拟IP地址

    compute:subeni 辅助弹性网卡IP地址

    neutron:LOADBALANCERV2 共享ELB使用的IP地址

    neutron:LOADBALANCERV3 独享ELB使用的IP地址

    network:endpoint_interface VPC终端节点使用的IP地址

    network:nat_gateway NAT网关使用的IP地址

  • 约束：此处的取值范围只是本服务支持的类型，其他类型未做标注

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"
        }
}

状态码

请参见状态码。

错误码

请参考错误码。

父主题： 私有IP