• Elastic Cloud Server

ecs
  1. Help Center
  2. Elastic Cloud Server
  3. API Reference
  4. OpenStack Nova APIs
  5. Floating IP Address Management
  6. Querying Floating IP Addresses (Discarded)

Querying Floating IP Addresses (Discarded)

Function Description

This interface is used to query floating IP addresses.

Constraints

  • This API will be discarded. You are advised to use the VPC interface "Querying Floating IP Addresses".

URI

GET /v2/{project_id}/os-floating-ips

GET /v2.1/{project_id}/os-floating-ips

Table 1 describes the parameters in the URI.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID.

Request

Request parameters

Table 2 describes the request parameters.

Table 2 Request parameters

Parameter

Type

Mandatory

Description

tenant_id

String

Yes

Specifies the tenant ID specified in the URI.

The value is in UUID format.

Response

Response parameters

Table 3 describes the response parameters.

Table 3 Response parameters

Parameter

Type

Mandatory

Description

floating_ips

List<Dict>

Yes

Specifies the floating IP addresses.

Table 4 floating_ip objects

Parameter

Type

Mandatory

Description

floating_ip

Dict

Yes

Specifies the floating IP address.

Table 5 floating_ip attributes

Parameter

Type

Mandatory

Description

fixed_ip

String

Yes

Specifies a private IP address.

id

String

Yes

Specifies the floating IP address ID in UUID format.

instance_id

String

Yes

Specifies the ID of a bound ECS in UUID format.

ip

String

Yes

Specifies the floating IP address.

pool

String

Yes

Specifies the name of a network resource pool that provides floating IP addresses.

Examples

  • Example request
    GET /v2/e73621affb8f44e1bc01898747ca09d4/os-floating-ips
    GET /v2.1/e73621affb8f44e1bc01898747ca09d4/os-floating-ips
  • Example response
    {
      "floating_ips": [
        {
          "id": "05f71f43-f3c9-47ef-ac8d-9f02aef66418",
          "pool": "external",
          "ip": "10.154.51.235",
          "fixed_ip": "192.168.1.2",
          "instance_id": "8b380f68-5057-4aa2-a33a-170b37218fa8"
        },
        {
          "id": "a25236cf-dd76-4adc-916a-f0b4a24048d3",
          "pool": "external",
          "ip": "10.154.51.237",
          "fixed_ip": null,
          "instance_id": null
        }
      ]
    }

Returned Values

See General Request Returned Values.