功能介绍
查询指定子网下的私有IP列表。
调试
您可以在API Explorer中调试该接口。
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
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取项目ID请参见获取项目ID。 |
subnet_id |
是 |
String |
私有IP所在子网的唯一标识 如果您使用管理控制台,此值即为子网详情中的“网络ID”参数值。 |
marker |
否 |
String |
分页查询的起始资源ID,表示从指定资源的下一条记录开始查询。 marker需要和limit配合使用:
|
limit |
否 |
Integer |
分页查询每页返回的记录个数,取值范围为0~intmax(2^31-1),默认值2000。 limit需要和marker配合使用,详细规则请见marker的参数说明。 |
请求参数
无
请求示例
GET https://{Endpoint}/v1/{project_id}/subnets/{subnet_id}/privateips
响应参数
名称 |
参数类型 |
说明 |
---|---|---|
status |
String |
|
id |
String |
私有IP标识 |
subnet_id |
String |
分配IP的子网标识 如果您使用管理控制台,此值即为子网详情中的“网络ID”参数值。 |
tenant_id |
String |
项目ID |
device_owner |
String |
|
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" } ] }
状态码
请参见状态码。
错误码
请参考错误码。