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.
- 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.
Request Message
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
floatingip |
floatingip object |
Yes |
Specifies the floating IP address list. For details, see Table 3. |
Response Message
Parameter |
Type |
Description |
---|---|---|
floatingip |
floatingip object |
Specifies the floating IP address list. For details, see Table 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 Request
- Unbind a floating IP address from a port.
PUT https://{Endpoint}/v2.0/floatingips/b997e0d4-3359-4c74-8f88-bc0af81cd5a2 { "floatingip": { "port_id": null } }
- Bind a floating IP address to a port. The port ID is f91f5763-c5a2-4458-979d-61e48b3c3fac.
PUT https://{Endpoint}/v2.0/floatingips/b997e0d4-3359-4c74-8f88-bc0af81cd5a2 { "floatingip": { "port_id": "f91f5763-c5a2-4458-979d-61e48b3c3fac" } }
Example Response
Status code: 200
(The floating IP address is unbound from the port.)
{ "floatingip": { "id": "b997e0d4-3359-4c74-8f88-bc0af81cd5a2", "status": "DOWN", "router_id": null, "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", "fixed_ip_address": null, "floating_ip_address": "88.88.215.205", "port_id": null, } }
(The floating IP address is bound to the port.)
{ "floatingip": { "id": "b997e0d4-3359-4c74-8f88-bc0af81cd5a2", "status": "DOWN", "router_id": null, "tenant_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": "f91f5763-c5a2-4458-979d-61e48b3c3fac", } }
Status Code
See Status Codes.
Error Code
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot