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

Changing the Description of a DB Instance

Function

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

URI

  • URI format

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

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

alias

No

String

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.

Example Request

Change the description of a DB instance.

{
     "alias": "alias-test"
}

Response

  • Normal response
    Table 3 Parameters

    Parameter

    Type

    Description

    resp

    String

    Returns successful if the invoking is successful.
  • Normal response 
    {
    "resp": "successful"
}

Status Code

Error Code

For details, see Error Codes.

Parent Topic: DB Instance Management