Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Instance Management/ Modifying the Description of a DB Instance
Updated on 2025-07-11 GMT+08:00
View PDF

Modifying the Description of a DB Instance

Function

This API is used to modify the description of a DB instance. 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, which is compliant with the UUID format.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. To obtain this value, call the IAM API for obtaining a user token.

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

Constraints:

N/A

Range:

N/A

Default value:

N/A

X-Language

No

String

Definition:

Request language type.

Constraints:

N/A

Range:

  • en-us

  • zh-cn

Default value:

en-us
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: 200

Success.

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

Modifying 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