Changing the Alias of a DB Instance

Function

This API is used to change the alias of a DB instance. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

Debugging

You can debug this API in API Explorer.

URI

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

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
alias	Yes	String	Definition Instance alias or remarks. Constraints N/A Range It can contain 1 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.). Default Value N/A

Response Parameters

None

Example Request

https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/cc6fd964d93f4003851dfc29d57d30a5in14/alias
{ 
  "alias" : "1234567890123456789012345678901234567890123456789012345678901234" 
}