Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ DB Instance Management/ Modifying a DB Instance Name
Updated on 2025-08-22 GMT+08:00
View PDF

Modifying a DB Instance Name

API Description

This API is used to modify a DB instance name.

Restrictions

The name of the DB instance that is being created or fails to be created cannot be modified.

URI

  • URI format

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-name

  • URI example

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

Table 1 Request parameters

Name

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

Explanation:

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

Constraints:

N/A

Value range:

N/A

Default value:

N/A

project_id

string

path

Yes

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

string

path

Yes

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

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Mandatory

    Description

    new_instance_name

    String

    Yes

    Explanation:

    New instance name. The instance name can be the same as an existing name.

    Constraints:

    The instance name must contain 4 to 64 characters and must start with a letter. It is case sensitive and can contain letters, digits, hyphens (-), and underscores (_). It cannot contain other special characters.

    Value range:

    N/A

    Default value:

    N/A

Example Request

Changing an instance name to myNewName 
{
    "new_instance_name": "myNewName"
}

Response Parameters

  • Response example 
    {}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.

Parent topic: DB Instance Management