doc-exports/docs/gaussdb_mysql/api-ref/gaussdb_04_0018.html

Changing a DB Instance Name

Function

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

• Learn how to authorize and authenticate it.
• Obtain the required region and endpoint.

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	DB 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.
X-Language	No	String	Language.

Table 3 Request body parameters

Parameter	Mandatory	Type	Description
name	Yes	String	DB instance name. DB instances of the same type can have same names under the same tenant. The name consists of 4 to 64 characters and starts with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).

Response Parameters

Status code: 200

Table 4 Response body parameters

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 a DB Instance Name

PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/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: Managing DB Instances