Changing a DB Instance Name¶
Function¶
This API is used to change a DB instance name. Before calling this API:
Learn how to authorize and authenticate it.
Obtain the required region and endpoint.
URI¶
URI format
PUT https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/name
Example
Parameter description
Table 1 Parameter description¶ Name
Type
Mandatory
Description
project_id
String
Yes
Project ID of a tenant in a region.
To obtain this value, see Obtaining a Project ID.
instance_id
String
Yes
DB instance ID.
Request Parameters¶
Parameter | Mandatory | Type | Description |
|---|---|---|---|
X-Auth-Token | No | String | User token. |
X-Language | No | String | Language. |
Content-Type | Yes | String | MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type. |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
name | Yes | String | DB instance name. Instances of the same type can have same names under the same tenant. The value consists of 4 to 64 characters and starts with a letter. It is case-sensitive and contains only letters, digits, hyphens (-), and underscores (_). |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
|---|---|---|
job_id | String | ID of the task for changing a DB instance name. |
Status code: 400
Parameter | Type | Description |
|---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Status code: 500
Parameter | Type | Description |
|---|---|---|
error_code | String | Error code. |
error_msg | String | Error message. |
Example Request¶
Changing a DB Instance Name
POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/name
{
"name" : "gaussdb-name"
}
Example Response¶
Status code: 200
Success.
{
"job_id" : "0f6b6a9e-bd39-4e95-9374-e4d134e5a3d1"
}
Status Code¶
For details, see Status Codes.
Error Code¶
For details, see Error Codes.