Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Instance Management/ Changing a DB Instance Name
Updated on 2025-03-26 GMT+08:00
View PDF

Changing a DB Instance Name

Function

This API is used to change a DB instance name. Before calling this API:

URI

PUT /v3/{project_id}/instances/{instance_id}/name

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token.

The value of X-Subject-Token in the response header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Instance name. Instances of the same type can have same names under the same tenant.

The name must start with a letter and consist of 4 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed.

is_modify_node_name

No

String

Whether to change node names synchronously. The value can be true or false. The default value is true.

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

job_id

String

Task ID for changing a DB instance name.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Changing the instance name to gaussdb-name

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/name
{
  "name" : "gaussdb-name"
}

Example Response

Status code: 200

Success.

{
  "job_id" : "0f6b6a9e-bd39-4e95-9374-e4d134e5a3d1"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management