Querying Private IP Addresses
Function
This API is used to query private IP addresses using search criteria and to display the private IP addresses in a list.
URI
GET /v1/{project_id}/subnets/{subnet_id}/privateips
Example:
GET https://{Endpoint}/v1/{project_id}/subnets/{subnet_id}/privateips?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d
Table 1 describes the parameters.
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. |
subnet_id | Yes | String | Specifies the unique ID of the subnet to which the private IP address belongs. If you use the management console, the value of this parameter is the Network ID value. |
marker | No | String | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. This parameter can work together with the parameter limit.
|
limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. limit can be used together with marker. For details, see the parameter description of marker. |
Request Parameters
None
Example Request
GET https://{Endpoint}/v1/{project_id}/subnets/{subnet_id}/privateips
Response Parameters
Parameter | Type | Description |
---|---|---|
status | String |
|
id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. |
subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. If you use the management console, the value of this parameter is the Network ID value. |
tenant_id | String | Specifies the project ID. |
device_owner | String |
|
ip_address | String | Specifies the assigned private IP address. |
Example Response
{"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"}]}
Status Code
See Status Codes.
Error Code
See Error Codes.
- Function
- URI
- Request Parameters
- Example Request
- Response Parameters
- Example Response
- Status Code
- Error Code