Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Instance Management/ Batch Changing Instance Specifications
Updated on 2026-07-16 GMT+08:00

Batch Changing Instance Specifications

Function

This API is used to change instance specifications in batches. Before calling this API:

Constraints

  • For batch specification changes, the original specifications, billing mode, instance type, AZ type, AZs, and kernel version of the instances must be consistent.

  • Specifications of serverless instances cannot be changed in batches.

  • Specifications of a maximum of 50 instances can be changed at a time.

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:modifySpec

    Permission_management

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    • gaussdb:instance:modify
    • gaussdb:instance:modifySpec

    -

    -

    gaussdbformysql:FlavorType

URI

POST /v3/{project_id}/instances/batch/flavor

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

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

application/json

Default Value

application/json

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us: English

  • zh-cn: Chinese

Default Value

en-us

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

instance_ids

Yes

Array of strings

Definition

IDs of the instances whose specifications are to be changed in batches.

To obtain this value, see Querying DB Instances.

Constraints

N/A

Range

Each instance ID contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

spec_code

Yes

String

Definition

Specification code.

To obtain this value, see the response parameter spec_code in Querying Database Specifications.

Constraints

N/A

Range

N/A

Default Value

N/A

is_auto_pay

No

String

Definition

Whether the order will be automatically paid when the specifications of yearly/monthly instances are changed in batches.

Constraints

N/A

Range

  • true (default value): The order will be automatically paid from your account.

  • false: The order will be manually paid.

Default Value

true

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

job_ids

Array of strings

Definition

IDs of the tasks for batch changing instance specifications. This parameter is only returned for pay-per-use instances.

order_ids

Array of strings

Definition

IDs of the orders for batch changing instance specifications. This parameter is only returned for yearly/monthly instances.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Batch changing the instance specifications to 4 vCPUs and 32 GB memory

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/batch/flavor

{
  "instance_ids" : [ "ba62a0b83a1b42bfab275829d86ac0fdin07", "61a4ea66210545909d74a05c27a7179ein07" ],
  "spec_code" : "gaussdb.mysql.xlarge.arm.4"
}

Example Response

Status code: 200

Success.

  • Task IDs returned for batch changing specifications of pay-per-use instances
    {
      "job_ids" : [ "aef6a470-fb63-4d5b-b644-12ead7e019b3", "bef6af00-0ab3-0adb-a638-93aad7e74843" ]
    }
  • Order IDs returned for batch changing specifications of yearly/monthly instances

    {
      "order_ids" : [ "CS2603051716XW8DS", "CS2603051203YBU2H" ]
    }

SDK Sample Code

The SDK sample code is as follows.

Batch changing the instance specifications to 4 vCPUs and 32 GB memory

 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
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 BatchChangeInstanceSpecificationSolution {

    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();
        BatchChangeInstanceSpecificationRequest request = new BatchChangeInstanceSpecificationRequest();
        BatchChangeInstanceSpecificationRequestBody body = new BatchChangeInstanceSpecificationRequestBody();
        List<String> listbodyInstanceIds = new ArrayList<>();
        listbodyInstanceIds.add("ba62a0b83a1b42bfab275829d86ac0fdin07");
        listbodyInstanceIds.add("61a4ea66210545909d74a05c27a7179ein07");
        body.withSpecCode("gaussdb.mysql.xlarge.arm.4");
        body.withInstanceIds(listbodyInstanceIds);
        request.withBody(body);
        try {
            BatchChangeInstanceSpecificationResponse response = client.batchChangeInstanceSpecification(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());
        }
    }
}

Batch changing the instance specifications to 4 vCPUs and 32 GB memory

 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
# 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 = BatchChangeInstanceSpecificationRequest()
        listInstanceIdsbody = [
            "ba62a0b83a1b42bfab275829d86ac0fdin07",
            "61a4ea66210545909d74a05c27a7179ein07"
        ]
        request.body = BatchChangeInstanceSpecificationRequestBody(
            spec_code="gaussdb.mysql.xlarge.arm.4",
            instance_ids=listInstanceIdsbody
        )
        response = client.batch_change_instance_specification(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Batch changing the instance specifications to 4 vCPUs and 32 GB memory

 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
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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := gaussdb.GaussDBClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := gaussdb.NewGaussDBClient(hcClient)

    request := &model.BatchChangeInstanceSpecificationRequest{}
	var listInstanceIdsbody = []string{
        "ba62a0b83a1b42bfab275829d86ac0fdin07",
	    "61a4ea66210545909d74a05c27a7179ein07",
    }
	request.Body = &model.BatchChangeInstanceSpecificationRequestBody{
		SpecCode: "gaussdb.mysql.xlarge.arm.4",
		InstanceIds: listInstanceIdsbody,
	}
	response, err := client.BatchChangeInstanceSpecification(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.