Batch Changing Instance Specifications

Function

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

Learn how to authenticate it.
Obtain the required region and endpoint.

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:instance:modifySpec	Permission_management	-	gaussdbformysql:FlavorType	gaussdb:instance:modify gaussdb:instance:modifySpec	-

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 zh-cn 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", "bef6afj0-fig3-0ldb-y638-93kad7e748g3" ]
}

Order IDs returned for batch changing specifications of yearly/monthly instances
```
{
  "order_ids" : [ "CS2603051716XW8DS", "CS2603051203YBU2H" ]
}
```