Changing a DB Instance Name
Function
This API is used to change an instance name. Before calling this API:
- Learn how to authenticate this API.
URI
PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/name
| Name | Mandatory | Description |
|---|---|---|
| project_id | Yes | Explanation: Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Restrictions: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None |
| instance_id | Yes | Instance ID. |
Request Parameters
| Name | Mandatory | Type | Description |
|---|---|---|---|
| name | Yes | String | DB instance name. Instances can have same names under the same tenant. The name must consist of 4 to 64 characters and start with a letter. It can contain only letters (case-sensitive), digits, hyphens (-), and underscores (_). |
Response Parameters
| Name | Type | Description |
|---|---|---|
| job_id | String | Task ID for changing the instance name. |
Example Request
PUT https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/name
{
"name": "instance-name"
} Example Response
{
"job_id": "2b414788a6004883a02390e2eb0ea227"
} Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.