Help Center/ Elastic Cloud Server/ API Reference/ Out-of-Date APIs/ Floating IP Address Management (OpenStack Nova APIs)/ Assigning a Floating IP Address (Discarded)
Updated on 2025-09-19 GMT+08:00
View PDF

Assigning a Floating IP Address (Discarded)

Function

This API is used to assign a floating IP address.

This API has been discarded. Use the API described in Assigning a Floating IP Address.

Constraints

You need to obtain a network resource pool that provides floating IP addresses. To do so, run GET /v2.0/networks?router:external=True or neutron net-external-list.

URI

POST /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.

For details about how to obtain the ID, see Obtaining a Project ID.

Request

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.

pool

String

No

Specifies the network resource pool that provides floating IP addresses. If it is not specified, the default resource pool is used.

Response

Table 3 describes the response parameters.

Table 3 Response parameters

Parameter

Mandatory

Type

Description

floating_ip

Yes

Object

Specifies the floating IP address. For details, see Table 4.
Table 4 floating_ip objects

Parameter

Mandatory

Type

Description

fixed_ip

Yes

String

Specifies a private IP address.

id

Yes

String

Specifies the floating IP address ID in UUID format.

instance_id

Yes

String

Specifies the ID of a bound ECS in UUID format.

ip

Yes

String

Specifies the floating IP address.

pool

Yes

String

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

Example Request

POST https://{endpoint}/v2.1/e73621affb8f44e1bc01898747ca09d4/os-floating-ips
{
    "pool": "external"
}

Example Response

{
  "floating_ip": {
    "id": "7aa2aa63-3097-4cfe-a2e4-596c301d3b1b",
    "pool": "external",
    "ip": "10.154.53.184",
    "fixed_ip": null,
    "instance_id": null
  }
}

Returned Values

See Returned Values for General Requests.