Changing a DB Instance Description

Function

This API is used to change a DB instance description.

Constraints

This API supports PostgreSQL only.

URI

  • URI format

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/alias

  • Example

    https://rds.cn-north-1.myhuaweicloud.com/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/alias

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    instance_id

    Yes

    Specifies the DB instance ID.

Request

  • Parameter description
    Table 2 Parameter description

    Name

    Mandatory

    Type

    Description

    alias

    Yes

    String

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

  • Request example
    {
         "alias": "alias-test"
    }

Response

  • Normal response
    Table 3 Parameter description

    Name

    Type

    Description

    resp

    String

    Returns successful if the invoking is successful.

  • Normal response
    {
        "resp": "successful"
    }

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.