Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Instance Management/ Changing DB Instance Specifications
Updated on 2023-10-18 GMT+08:00
View PDF

Changing DB Instance Specifications

Function

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

URI

POST /v3/{project_id}/instances/{instance_id}/action

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID, which is compliant with the UUID format.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Value:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

resize_flavor

Yes

MysqlResizeFlavor object

Specification change information.

is_auto_pay

No

String

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

  • true: indicates the order will be automatically paid from your account. The default value is true.
  • false: indicates the order will be manually paid.
Table 4 MysqlResizeFlavor

Parameter

Mandatory

Type

Description

spec_code

Yes

String

Specification code.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

job_id

String

Job ID for changing DB instance specifications. This parameter is returned only when you change the specifications of a pay-per-use DB instance.

order_id

String

Order ID. This parameter is returned only when DB instances are billed at a yearly/monthly basis.

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

Changing the specifications of a DB instance to 4 vCPUs and 32 GB memory

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/ba62a0b83a1b42bfab275829d86ac0fdin07/action
{
  "resize_flavor" : {
    "spec_code" : "gaussdb.mysql.xlarge.arm.8"
  }
}

Example Response

Status code: 200

Success.

{
  "job_id" : "dff1d289-4d03-4942-8b9f-463ea07c000d"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management