Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ DB Instance Management/ Changing a Private IP Address
Updated on 2025-10-24 GMT+08:00
View PDF

Changing a Private IP Address

API Description

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

Constraints

  • This operation cannot be performed on frozen or abnormal instances.
  • An in-use IP address cannot be used as the new private IP address of a DB instance.
  • Changing the private IP address will cause the original database connection address to become invalid. If an EIP has been bound to the DB instance, do not unbind the EIP when the private IP address is being changed.
  • This operation is not allowed if connection address switchover is enabled.
  • Currently, only the IPv4 address is supported.

URI

  • URI format

    POST /v3/{project_id}/instances/{instance_id}/modify-internal-ip

  • URI example

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-internal-ip

Table 1 Path parameters

Name

Mandatory

Type

IN

Description

project_id

Yes

string

path

Explanation:

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

instance_id

Yes

string

path

Explanation:

Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Name

Mandatory

Type

IN

Description

X-Auth-Token

Yes

string

header

Definition

User token obtained from IAM. For details, see Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Parameter description

Name

Type

Mandatory

Description

new_ip

String

Yes

Definition

New IP address.

Range

  • It must be in an available VPC CIDR block.
  • Only IPv4 addresses are supported.

Range

N/A

Default Value

N/A

node_id

String

Yes

Definition

The node ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Requests

Changing the private IP address of a DB instance, including new_ip and node_id 
{
    "node_id": "52a4c096bb1f455d8d866956a959519eno02",
    "new_ip": "192.168.0.133"
}

Response Parameters

  • Parameter description
    Table 4 Parameter description

    Name

    Type

    Mandatory

    Description

    job_id

    String

    Yes

    Definition

    Task ID.

    Range

    N/A

    node_id

    String

    Yes

    Definition

    The node ID.

    Range

    N/A

    new_ip

    String

    Yes

    Definition

    The new private IP address.

    Range

    N/A
  • Example Responses 
    {
     "job_id":"3711e2ad-5787-49bc-a47f-3f0b066af9f5",
     "node_id":"52a4c096bb1f455d8d866956a959519eno02",
     "new_ip":"192.168.0.133"
 }

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.

Parent topic: DB Instance Management