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

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

Table 1 Path parameters

Name

Type

IN

Mandatory

Description

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.

Request Parameters

Table 2 Request header parameters

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token
Table 3 Parameter description

Parameter

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.
  • Request example 
    {
    "node_id": "52a4c096bb1f455d8d866956a959519eno02",
    "new_ip": "192.168.0.133"
}

Response Parameters

  • Parameter description
    Table 4 Parameter description

    Parameter

    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.
  • Example response 
    {
     "job_id":"3711e2ad-5787-49bc-a47f-3f0b066af9f5",
     "node_id":"52a4c096bb1f455d8d866956a959519eno02",
     "new_ip":"192.168.0.133"
 }

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.

Parent topic: DB Instance Management