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
- 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
Name |
Mandatory |
Type |
Description |
---|---|---|---|
alias |
No |
String |
The value consists of 0 to 64 characters, including letters, digits, periods (.), underscores (_), and hyphens (-). If this parameter is not specified or is set to null, the original description of the instance will be deleted. |
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" }
- Abnormal response
For details, see Abnormal Request Results.
Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
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