# 查询私有IP列表 - ListPrivateips #### 功能介绍 查询指定子网下的私有IP列表。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=VPC&version=v2&api=ListPrivateips)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-vpc/vpc_permission_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | vpc:privateIps:list | List | privateIp \* | - | - | - | #### URI GET /v1/{project_id}/subnets/{subnet_id}/privateips 样例： ``` GET https://{Endpoint}/v1/{project_id}/subnets/{subnet_id}/privateips?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d ``` 参数说明请参见[表1]。 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID，获取项目ID请参见[获取项目ID](https://support.huaweicloud.com/api-vpc/vpc_api_0011.html)。 | | subnet_id | 是 | String | 私有IP所在子网的唯一标识 如果您使用管理控制台，此值即为子网详情中的"网络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\~2000条（limit默认值2000）资源记录。 | | limit | 否 | Integer | 分页查询每页返回的记录个数，取值范围为0\~2000，默认值2000。 limit需要和marker配合使用，详细规则请见marker的参数说明。 | #### 请求参数 无 #### 请求示例 ``` GET https://{Endpoint}/v1/{project_id}/subnets/{subnet_id}/privateips ``` #### 响应参数 表2请求参数 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | privateips | Array of [privateip] objects | 私有IP列表对象，请参见[表3]。 | 表3privateip字段说明 | 名称 | 参数类型 | 说明 | |:---|:---|:---| | 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 | #### 响应示例 ``` { "privateips": [ { "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" }, { "status": "DOWN", "id": "d600542a-b231-45ed-af05-e9930cb14f79", "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", "device_owner": "", "ip_address": "192.168.1.12" } ] } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-vpc/vpc_api_0002.html)。 #### 错误码 请参考[错误码](https://support.huaweicloud.com/api-vpc/vpc_api_0003.html)。