Patching Databases in Batches
Function
This API is used to patch databases in batches.
Constraints
- This API supports the following types of instances:
- GeminiDB Cassandra
- GeminiDB Influx
- GeminiDB Redis
- Upgrade is triggered immediately, so patch databases during off-peak hours.
URI
POST https://{Endpoint}/v3/{project_id}/instances/db-upgrade
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Explanation: Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints: N/A Values: N/A Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Explanation: User token Constraints: N/A Values: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
instance_ids |
Yes |
Array of strings |
Explanation: IDs of instances where databases need to be patched. Constraints: Instance IDs only of the same engine can be transferred at a time. Values: A maximum of 10 instance IDs can be transferred at a time. Default value: N/A |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
upgrade_results |
Array of UpgradeResult objects |
Explanation: Batch upgrade result Values: N/A |
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
Explanation: Task ID returned only when a patch installation task is successfully submitted Values: N/A |
instance_id |
String |
Explanation: Instance ID Values: N/A |
error_code |
String |
Explanation: Error code returned only when a patch installation task fails to be submitted Values: N/A |
error_message |
String |
Explanation: Failure cause returned only when a patch installation task fails to be submitted Values: N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Explanation: Error code Values: N/A |
error_msg |
String |
Explanation: Error message Values: N/A |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Explanation: Error code Values: N/A |
error_msg |
String |
Explanation: Error message Values: N/A |
Example Request
POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/db-upgrade
Example Request
{ "instance_ids" : [ "046287aae57843b1a7bc61b7a8812f41in13", "3d1e04f49efa473a8c7eaf07ed7ff870in13" ] }
Example Response
Status code: 202
Accepted
{ "upgrade_results" : [ { "instance_id" : "046287aae57843b1a7bc61b7a8812f41in13", "job_id" : "e4616470-733d-41de-a9b0-a260709293d3" }, { "instance_id" : "3d1e04f49efa473a8c7eaf07ed7ff870in13", "error_code" : "DBS.200011", "error_message" : "The status of DB instance does not allow the operation." } ] }
Status Codes
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