Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Instance Management/ Changing a DB Instance Description
Updated on 2023-10-18 GMT+08:00
View PDF

Changing a DB Instance Description

Function

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

URI

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

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 of a tenant in a project.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

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

Value:

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

Parameter

Mandatory

Type

Description

alias

Yes

String

Instance description.

The value can contain 0 to 64 characters, including letters, digits, periods (.), underscores (_), and hyphens (-).

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Changing the description of a DB instance to Test_alias

PUT https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/alias
{
  "alias" : "Test_alias"
}

Example Response

Status code: 200

Success.

{ }

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management