Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ DB Instance Management/ Changing an Instance Description
Updated on 2025-10-24 GMT+08:00
View PDF

Changing an Instance Description

API Description

This API is used to modify the description of an instance.

Constraints

Description of deleted instances cannot be modified.

URI

  • URI format

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

  • URI example

    https://dds.ap-southeast-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/remark

Table 1 Path parameters

Name

Mandatory

Type

IN

Description

project_id

Yes

string

path

Explanation:

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

instance_id

Yes

string

path

Explanation:

Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Name

Mandatory

Type

IN

Description

X-Auth-Token

Yes

string

header

Definition

User token obtained from IAM. For details, see Authentication.

Constraints

N/A

Range

N/A

Default value:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

remark

Yes

String

Explanation:

Instance remarks

Constraints:

The length cannot exceed 64 characters. The carriage return character and the following special characters are not supported >!<"&'=

Value range:

N/A

Default value:

N/A

Example Requests

Changing an instance description to test 
{
"remark":"test"
}

Response Parameters

Example Responses 
{}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.

Parent topic: DB Instance Management