Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ DB Instance Management/ Changing the Description of a DB Instance
Updated on 2026-02-04 GMT+08:00
View PDF
Share

Changing the Description of a DB Instance

Function

This API is used to change the description of a DB instance.

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 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

rds:instance:updateRemark

write

instance

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

rds:instance:modify

-

URI

  • URI format

    PUT /v3/{project_id}/instances/{instance_id}/alias

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    Constraints

    The value cannot be empty.

    Range

    To obtain the value, see Obtaining a Project ID.

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    The value cannot be empty.

    Range

    You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances.

    Default Value

    N/A

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

alias

No

String

Definition

Instance description.

Constraints

N/A

Range

The value consists of 0 to 64 characters, including letters, digits, periods (.), underscores (_), and hyphens (-).

If this parameter is not specified or is set to null, the original description of the instance will be deleted.

Default Value

N/A

Example Request

Change the description of a DB instance.

PUT https://{endpoint}/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/alias

{
     "alias": "alias-test"
}

Response

  • Normal response
    Table 3 Parameters

    Parameter

    Type

    Description

    resp

    String

    Definition

    Calling result.

    Range

    successful: The API is successfully called.
  • Normal response 
    {
    "resp": "successful"
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: DB Instance Management