Updated on 2025-04-01 GMT+08:00

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

Table 1 URI parameter

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

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

Constraints:

N/A

Values:

N/A

Default value:

N/A

Table 3 Request body parameters

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

Table 4 Response body parameter

Parameter

Type

Description

upgrade_results

Array of UpgradeResult objects

Explanation:

Batch upgrade result

Values:

N/A

Table 5 UpgradeResult

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

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Explanation:

Error code

Values:

N/A

error_msg

String

Explanation:

Error message

Values:

N/A

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Explanation:

Error code

Values:

N/A

error_msg

String

Explanation:

Error message

Values:

N/A

Example Request

URI example
POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/db-upgrade

Example Request

Patching databases in batches
{ 
   "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.