Updated on 2024-01-12 GMT+08:00

Changing a Floating IP Address

Function

This API is used to change the floating IP address of a DB instance.

  • Before calling an API, you need to understand the API in Authentication.

Constraints

The floating IP address cannot be changed if the DB instance is in any of the following statuses: creating, rebooting, upgrading, changing instance class, creating users, or deleting users.

URI

  • URI format

    PUT /v3/{project_id}/instances/{instance_id}/ip

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

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

    instance_id

    Yes

    Specifies the DB instance ID.

Request

Parameter description
Table 2 Parameters

Parameter

Mandatory

Type

Description

new_ip

Yes

String

Indicates the floating IP address.

Example Request

Changing the floating IP address of a DB instance

{
     "new_ip": "192.168.0.1"
}

Response

  • Normal response

    Parameter

    Description

    workflowId

    Workflow ID.

  • Example normal response
    {
        "workflowId":"83abc7bc-2c70-4534-8565-351187b37715"
    }

Status Code

Error Code

For details, see Error Codes.