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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
dds:instance:updateRemark	write	instance	g:EnterpriseProjectId	dds:instance:modify	-

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** URI parameters
Name	Mandatory	Type	IN	Description
project_id	Yes	string	path	Definition Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	string	path	Definition 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 Range N/A Default Value N/A

Request

**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	Definition Instance remarks Constraints The length cannot exceed 64 characters. The carriage return character and the following special characters are not supported >!<"&'= Range N/A Default Value N/A

Example Request

Changing an instance description to test

{
"remark":"test"
}

Response

Example Response

{}

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.