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.
- Obtain the required region and endpoint.
URI
PUT /v3/{project_id}/instances/{instance_id}/name
Name |
Mandatory |
Description |
---|---|---|
project_id |
Yes |
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 |
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
Name |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Definition DB instance name. Instances can have same names under the same tenant. Constraints N/A Range The name can contain 4 to 64 characters and must start with a letter. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed. Default Value N/A |
Response Parameters
Name |
Type |
Description |
---|---|---|
job_id |
String |
Definition Task ID for changing the instance name. Range N/A |
Example Request
PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/name { "name": "instance-name" }
Example Response
{ "job_id": "2b414788a6004883a02390e2eb0ea227" }
Status Codes
- Normal
- Abnormal
For details, see Status Codes.
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot