Updating a Floating IP Address

Function

This API is used to update a floating IP address.

During the update, the ID of the floating IP address must be provided in the URL.

If port_id is left blank, the floating IP address has been unbound from the port.

This API has the following constraints:

If a floating IP address that you are binding is in the error state, unbind the IP address first.
Do not associate a port that has a floating IP address associated to another floating IP address. You must first disassociate the port from the IP address and then associate it with another IP address.

URI

PUT /v2.0/floatingips/{floatingip_id}

Table 1 describes the parameters.

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
floatingip_id	Yes	String	Specifies the floating IP address ID. This parameter is not required when you assign a floating IP address. This parameter is mandatory when you query, update, or delete a floating IP address.

Request Message

**Table 2** Request header parameter
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.

**Table 3** Request parameter
Parameter	Type	Mandatory	Description
floatingip	floatingip object	Yes	Specifies the floating IP address list. For details, see Table 4.

**Table 4** **floatingip** objects
Parameter	Mandatory	Type	Description
port_id	No	String	Specifies the port ID.

Response Message

**Table 5** Response parameter
Parameter	Type	Description
floatingip	floatingip object	Specifies the floating IP address list. For details, see Table 6.

**Table 6** **floatingip** objects
Attribute	Type	Description
status	String	Specifies the floating IP address status. The value can be ACTIVE, DOWN, or ERROR. DOWN indicates that the floating IP address has not been bound. ACTIVE indicates that the floating IP address has been bound. ERROR indicates that the floating IP address is abnormal.
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.
dns_domain	String	Specifies the DNS domain.

Example:

Example request 1 (Binding a floating IP address to a port)

PUT https://{Endpoint}/v2.0/floatingips/b997e0d4-3359-4c74-8f88-bc0af81cd5a2 
 
{
    "floatingip": {
           "port_id": "f91f5763-c5a2-4458-979d-61e48b3c3fac"
    }
}

Example response 1 (Binding a floating IP address to a port)

{
    "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": "192.168.10.3",
        "floating_ip_address": "88.88.215.205",
        "port_id": 00587256-27e3-489b-96bf-ea80c1da4aeb,
        "created_at": "2018-09-20T02:10:02",
        "updated_at": "2018-09-20T02:10:07"
    }
}

Example request 2 (Unbinding a floating IP address from a port)

PUT https://{Endpoint}/v2.0/floatingips/b997e0d4-3359-4c74-8f88-bc0af81cd5a2

{
    "floatingip": {
        "port_id": null
    }
}

Example response 2 (Unbinding a floating IP address from a port)

{
    "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:07"
    }
}