Help Center/ Document Database Service/ API Reference (Ally Region)/ APIs V3.0 (Recommended)/ DB Instance Management/ Changing an Instance Description
Updated on 2026-01-08 GMT+08:00
View PDF
Share

Changing an Instance Description

API Description

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

Restrictions

Description of deleted instances cannot be modified.

URI

  • URI format

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/remark

Table 1 Path parameters

Name

Type

IN

Mandatory

Description

project_id

string

path

Yes

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

instance_id

string

path

Yes

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.

Request Parameters

Table 2 Request header parameters

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

remark

Yes

String

Instance remarks

The length cannot exceed 64 characters. The carriage return character and the following special characters are not supported >!<"&'=
  • Request example 
    {
"remark":"test"
}

Response Parameters

Example response 
{}

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.

Parent topic: DB Instance Management