Updated on 2025-08-22 GMT+08:00

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

Explanation:

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

Constraints:

N/A

Value range:

N/A

Default value:

N/A

project_id

string

path

Yes

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

string

path

Yes

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

  • Parameter description
    Table 2 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 Request

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

Response Parameters

Response example
{}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.