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
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin02/remark

**Table 1** Request parameters
Name	Type	IN	Mandatory	Description
X-Auth-Token	string	header	Yes	User token obtained from IAM. For details, see Authentication.
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.

Requests

Parameter description

**Table 2** 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 >!<"&'=

Example Request

Changing an instance description to test

{
"remark":"test"
}

Responses

Response example

{}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.