Querying a Floating IP Address
Function
This API is used to query details about a specified floating IP address, including the floating IP address status, ID of the router to which the floating IP address belongs, and external network ID of the floating IP address.
URI
GET /v2.0/floatingips/{floatingip_id}
Request Message
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of X-Subject-Token in the response header is the user token. |
Response Message
|
Parameter |
Type |
Description |
|---|---|---|
|
floatingip |
floatingip object |
Specifies the floating IP address list. For details, see Tabela 3. |
|
Attribute |
Type |
Description |
|---|---|---|
|
status |
String |
Specifies the floating IP address status. The value can be ACTIVE, DOWN, or ERROR.
|
|
id |
String |
Specifies the floating IP address ID. |
|
project_id |
String |
Specifies the project ID. |
|
floating_ip_address |
String |
Specifies the floating IP address. |
|
floating_network_id |
String |
Specifies the external network ID. |
|
router_id |
String |
Specifies the ID of the belonged router. |
|
port_id |
String |
Specifies the port ID. |
|
fixed_ip_address |
String |
Specifies the private IP address of the associated port. |
|
tenant_id |
String |
Specifies the project ID. |
|
dns_name |
String |
Specifies the DNS name. This parameter is available only in the CN South-Guangzhou region. |
|
dns_domain |
String |
Specifies the DNS domain. This parameter is available only in the CN South-Guangzhou region. |
|
created_at |
String |
Specifies the time when the floating IP address was created. UTC time is used. Format: yyyy-MM-ddTHH:mm:ss |
|
updated_at |
String |
Specifies the time when the floating IP address was updated. UTC time is used. Format: yyyy-MM-ddTHH:mm:ss |
Example:
Example request
GET https://{Endpoint}/v2.0/floatingips/1a3a2818-d9b4-4a9c-8a19-5252c499d1cd
Example response
{
"floatingip": {
"id": "1a3a2818-d9b4-4a9c-8a19-5252c499d1cd",
"status": "DOWN",
"router_id": null,
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
"fixed_ip_address": null,
"floating_ip_address": "99.99.99.84",
"port_id": null,
"created_at": "2017-10-19T12:21:28",
"updated_at": "2018-07-30T12:52:13"
}
}
