Changing a Private IP Address

API Description

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

Restrictions

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 https://{Endpoint}/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** Request parameters
Name	Type	IN	Mandatory	Description
X-Auth-Token	string	header	Yes	User token obtained from IAM. For details, see Authentication.
project_id	string	path	Yes	Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.
instance_id	string	path	Yes	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.

Requests

Parameter description

**Table 2** Parameter description
Name	Type	Mandatory	Description
new_ip	String	Yes	The new IP address, which must be in an available VPC CIDR block. Only IPv4 is supported.
node_id	String	Yes	The node ID.

Example Request

Changing the private IP address of a DB instance, including new_ip and node_id

{
    "node_id": "52a4c096bb1f455d8d866956a959519eno02",
    "new_ip": "192.168.0.133"
}

Responses

Parameter description

**Table 3** Parameter description
Name	Type	Mandatory	Description
job_id	String	Yes	The workflow ID.
node_id	String	Yes	The node ID.
new_ip	String	Yes	The new private IP address.

Response example

{
     "job_id":"3711e2ad-5787-49bc-a47f-3f0b066af9f5",
     "node_id":"52a4c096bb1f455d8d866956a959519eno02",
     "new_ip":"192.168.0.133"
 }

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.