Updated on 2026-09-22 GMT+08:00

Patching Databases in Batches

Function

This API is used to patch databases in batches.

Constraints

This API supports the following instances:
- GeminiDB Cassandra
- GeminiDB Influx
- GeminiDB Redis

Upgrade is triggered immediately, so patch databases during off-peak hours.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:instance:batchUpgradeDatabaseVersion	write	-	-	nosql:instance:batchUpgradeDatabaseVersion	-

URI

POST /v3/{project_id}/instances/db-upgrade

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
instance_ids	Yes	Array of strings	Definition IDs of instances where databases need to be patched. To obtain the value, call the Querying Instances and Details API. Constraints Instance IDs only of the same engine can be transferred at a time. A maximum of 10 instance IDs can be transferred at a time.

Response Parameters

Status code: 202

**Table 4** Response body parameters
Parameter	Type	Description
upgrade_results	Array of UpgradeResult objects	Definition Batch upgrade result

**Table 5** UpgradeResult
Parameter	Type	Description
job_id	String	Definition Task ID returned only when a patch installation task is successfully submitted Range N/A
instance_id	String	Definition Instance ID Range N/A
error_code	String	Definition Error code returned only when a patch installation task fails to be submitted Range N/A
error_message	String	Definition Failure cause returned only when a patch installation task fails to be submitted Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code Range N/A
error_msg	String	Definition Error message Range N/A

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code Range N/A
error_msg	String	Definition Error message Range N/A

Example Requests

Patching databases in batches

POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/db-upgrade

{ 
   "instance_ids" : [ "046287aae57843b1a7bc61b7a8812f41in13", "3d1e04f49efa473a8c7eaf07ed7ff870in13" ] 
 }

Example Responses

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.

Parent topic: Instances