Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Database Security/ Changing a Floating IP Address
Updated on 2025-12-09 GMT+08:00
View PDF
Share

Changing a Floating IP Address

Function

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:instance:modifyIp

write

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

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

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

new_ip

Yes

String

Definition

Indicates the floating IP address.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Request

Change the floating IP address of a DB instance.

PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/ip

{
     "new_ip": "192.168.0.1"
}

Response

  • Normal response

    Parameter

    Description

    workflowId

    Definition

    Workflow ID.

    Range

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

Status Code

Error Code

For details, see Error Codes.

Parent topic: Database Security