Changing the Description of a DB Instance

Function

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

• Before calling an API, you need to understand the API in Authentication.

URI

• URI format

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

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	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

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

  Name	Type	Description
  resp	String	Returns successful if the invoking is successful.

• Normal response

  {
      "resp": "successful"
  }

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.