Updated on 2026-08-04 GMT+08:00

Changing an Instance Description

Scenarios

If multiple DDS instances exist, you may find it difficult to distinguish and identify each instance. DDS allows you to add a description to each instance name, helping you distinguish them more easily.

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and a project.
  3. Click in the upper left corner of the page and choose Databases > Document Database Service.
  4. On the Instances page, locate the instance you wish to edit the description for and click in the Description column to edit the instance description. Then, click OK.

    Alternatively, click the target instance to go to the Basic Information page. In the DB Information area, click in the Description field to edit the instance description. To submit the change, click .

    The instance description can contain up to 64 characters, excluding carriage return characters and special characters >!<"&'=

  5. View the results on the Instances page.

Related APIs

API

Description

Changing an Instance Description

Modifies the description of an instance.