Querying Private IP Address Details
Function
This API is used to query details about a private IP address using the specified ID.
URI
GET /v1/{project_id}/privateips/{privateip_id}
Table 1 describes the parameters.
Parameter | Mandatory | Description |
---|---|---|
project_id | Yes | Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. |
privateip_id | Yes | Specifies the ID of the private IP address, which uniquely identifies the private IP address. |
Request Parameters
None
Example Request
GET https://{Endpoint}/v1/{project_id}/privateips/d600542a-b231-45ed-af05-e9930cb14f78
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
{"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"}}
Status Code
See Status Codes.
Error Code
See Error Codes.
- Function
- URI
- Request Parameters
- Example Request
- Response Parameters
- Example Response
- Status Code
- Error Code