Modifying the Database Remarks of a Specified DB Instance
Function
This API is used to modify the database remarks of a specified DB instance.
- Before calling an API, you need to understand the API in Authentication.
- Before calling this API, learn about request header parameters.
Constraints
- This operation cannot be performed when the DB instance is in any of the following statuses: creating, changing instance class, changing port, or abnormal.
- The remarks will be deleted if its value is changed to an empty string or null.
URI
- Parameter description
Table 1 Parameters Parameter
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
Instance ID.
Request
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| name | Yes | String | Database name. |
| comment | No | String | Database remarks. The value can contain 1 to 512 characters. |
Example Request
POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/database/update
{
"name": "rds",
"comment": "this is a comment"
} Response
- Normal response
Table 3 Parameters Parameter
Type
Description
resp
String
Returns successful if the invoking is successful.
- Example 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.
What is your overall rating for this page?
Thank 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