Assigning a Floating IP Address
Function
When assigning a floating IP address, you need to obtain the external network ID floating_network_id of the floating IP address.
You can use GET /v2.0/networks?router:external=True or run the neutron net-external-list command to obtain the UUID of the external network required for assigning a floating IP address.
URI
POST /v2.0/floatingips
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. |
|
Parameter |
Type |
Mandatory |
Description |
|---|---|---|---|
|
floatingip |
floatingip object |
Yes |
Specifies the floating IP address list. For details, see Tabela 3. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
floating_ip_address |
No |
String |
Specifies the floating IP address. |
|
floating_network_id |
Yes |
String |
Specifies the external network ID. You can only use fixed external network. You can use GET /v2.0/networks?router:external=True or GET /v2.0/networks?name={floating_network} or run the neutron net-external-list mode command to obtain information about the external network. |
|
port_id |
No |
String |
Specifies the port ID. |
|
fixed_ip_address |
No |
String |
Specifies the private IP address of the associated port. |
Response Message
|
Parameter |
Type |
Description |
|---|---|---|
|
floatingip |
floatingip object |
Specifies the floating IP address list. For details, see Tabela 5. |
|
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. |
|
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. |
Example:
Example request
POST https://{Endpoint}/v2.0/floatingips
{
"floatingip": {
"floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975"
}
}
Example response
{
"floatingip": {
"id": "b997e0d4-3359-4c74-8f88-bc0af81cd5a2",
"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": "88.88.215.205",
"port_id": null,
"created_at": "2018-09-20T02:10:02",
"updated_at": "2018-09-20T02:10:02"
}
}