Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Upgrading Minor Version
Updated on 2025-07-02 GMT+08:00
View PDF
Share

Upgrading Minor Version

Function

This API is used to upgrade the minor version of an instance.

Constraints

  • This API supports the following types of instances:
    • GeminiDB Cassandra
    • GeminiDB Influx
    • GeminiDB Redis
  • This API is not available to frozen or abnormal instances.
  • This API is not available if there are abnormal instance nodes.
  • View field patch_available in the result returned by the API for querying instance details and check whether a minor version upgrade is supported.
  • Perform an upgrade during off-peak hours.

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/db-upgrade

Table 1 URI parameters

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

instance_id

Yes

String

Explanation:

Instance 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

Response Parameters

Status code: 202

Table 3 Response body parameter

Parameter

Type

Description

job_id

String

Explanation:

Task ID.

Values:

N/A

Example Requests

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

Example Responses

Status code: 202

Accepted

{
  "job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances