Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Instance Management/ Upgrading Minor Versions of Instances in Batches
Updated on 2026-01-05 GMT+08:00

Upgrading Minor Versions of Instances in Batches

Function

This API is used to upgrade minor versions of instances in batches. Before calling this API:

Calling Method

For details, see Calling APIs.

Authorization Information

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

  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • 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

    Dependency

    gaussdbformysql:instance:upgrade

    Permission_management

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    • gaussdb:instance:modify
    • gaussdb:instance:upgrade

    -

URI

POST /v3/{project_id}/instances/database-version/upgrade

Table 1 URI parameter

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. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

databases_instance_infos

Yes

Array of UpgradeDatabasesSingleInstance objects

Definition

Instances to be upgraded in batches.

Constraints

N/A

delay

Yes

String

Definition

Whether to delay the upgrade.

Constraints

N/A

Range

  • true: The upgrade will be delayed.

  • false: The upgrade will not be delayed.

Default Value

N/A

Table 4 UpgradeDatabasesSingleInstance

Parameter

Mandatory

Type

Description

current_version

Yes

String

Definition

Current kernel version of the instance.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameter

Parameter

Type

Description

resp

String

Definition

API calling results.

Range

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Upgrading minor versions of instances in batches

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/database-version/upgrade

{
  "databases_instance_infos" : [ {
    "current_version" : "2.0.48.231200",
    "instance_id" : "6754902da1f447269c6979b0590102a5in07"
  } ],
  "delay" : false
}

Example Response

Status code: 200

Success.

{
  "resp" : "success"
}

SDK Sample Code

The SDK sample code is as follows.

Upgrading minor versions of instances in batches

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.gaussdb.v3.region.GaussDBRegion;
import com.huaweicloud.sdk.gaussdb.v3.*;
import com.huaweicloud.sdk.gaussdb.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class BatchUpgradeDatabasesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchUpgradeDatabasesRequest request = new BatchUpgradeDatabasesRequest();
        BatchUpgradeDatabasesRequestBody body = new BatchUpgradeDatabasesRequestBody();
        List<UpgradeDatabasesSingleInstance> listbodyDatabasesInstanceInfos = new ArrayList<>();
        listbodyDatabasesInstanceInfos.add(
            new UpgradeDatabasesSingleInstance()
                .withCurrentVersion("2.0.48.231200")
                .withInstanceId("6754902da1f447269c6979b0590102a5in07")
        );
        body.withDelay("false");
        body.withDatabasesInstanceInfos(listbodyDatabasesInstanceInfos);
        request.withBody(body);
        try {
            BatchUpgradeDatabasesResponse response = client.batchUpgradeDatabases(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Upgrading minor versions of instances in batches

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkgaussdb.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = BatchUpgradeDatabasesRequest()
        listDatabasesInstanceInfosbody = [
            UpgradeDatabasesSingleInstance(
                current_version="2.0.48.231200",
                instance_id="6754902da1f447269c6979b0590102a5in07"
            )
        ]
        request.body = BatchUpgradeDatabasesRequestBody(
            delay="false",
            databases_instance_infos=listDatabasesInstanceInfosbody
        )
        response = client.batch_upgrade_databases(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Upgrading minor versions of instances in batches

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    gaussdb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/gaussdb/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := gaussdb.NewGaussDBClient(
        gaussdb.GaussDBClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.BatchUpgradeDatabasesRequest{}
	var listDatabasesInstanceInfosbody = []model.UpgradeDatabasesSingleInstance{
        {
            CurrentVersion: "2.0.48.231200",
            InstanceId: "6754902da1f447269c6979b0590102a5in07",
        },
    }
	request.Body = &model.BatchUpgradeDatabasesRequestBody{
		Delay: "false",
		DatabasesInstanceInfos: listDatabasesInstanceInfosbody,
	}
	response, err := client.BatchUpgradeDatabases(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.