Help Center/ GaussDB/ API Reference/ Historical APIs/ DB Instance Management/ Changing a DB Instance Name
Updated on 2025-08-11 GMT+08:00
View PDF
Share

Changing a DB Instance Name

Function

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

This API will be unavailable on March 31, 2025. You are advised to switch workloads to the new API (Changing a DB Instance Name) before then.

URI

PUT /gaussdb/v3/{project_id}/instances/{instance_id}/name
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Definition

Project ID of a tenant in a region.

To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

Instance ID.

Request Parameters

Table 2 Request parameters

Parameter

Mandatory

Type

Description

name

Yes

String

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

The name must consist of 4 to 64 characters and start with a letter. It can contain only letters (case-sensitive), digits, hyphens (-), and underscores (_).

Response Parameters

Table 3 Response parameters

Parameter

Type

Description

job_id

String

Task ID for changing the instance name.

Example Request

https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/name
{
  "name": "instance-name"
}

Example Response

{
	"job_id": "2b414788a6004883a02390e2eb0ea227"
}

Status Code

Error Codes

For details, see Error Codes.

Parent topic: DB Instance Management