Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Changing Specifications of an Instance
Updated on 2025-07-02 GMT+08:00
View PDF
Share

Changing Specifications of an Instance

Function

This API is used to change specifications of an instance.

Services will be interrupted for 5 to 10 minutes when you change specifications of an instance. Exercise caution when performing this operation.

Constraints

This API supports the following instance types:

  • GeminiDB Cassandra
  • GeminiDB Redis
  • GeminiDB Influx instances with cloud native storage

This API supports both yearly/monthly and pay-per-use instances.

This API can be used to scale up or down specifications of an instance.

The new specifications cannot be the same as the original specifications.

Specifications can be modified only when the instance status is normal.

If specifications cannot meet the requirements for running the instance, the specifications cannot be changed.

This API can be used to change specifications for two GeminiDB Redis instances between which there is a dual-active DR relationship.

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/resize

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 parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints:

N/A

Values:

N/A

Default value:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

resize

Yes

ResizeInstanceOption object

Explanation:

Target specification information.

is_auto_pay

No

String

Explanation:

Whether the order will be automatically paid after a yearly/monthly instance is created. This parameter does not affect the payment mode of automatic renewal.

Constraints:

This parameter is valid only when specifications need to be expanded.

Values:
  • true: An order is automatically paid from user's account.
  • false: An order is manually paid by a user. The default value is false.

Default value:

false
Table 4 ResizeInstanceOption

Parameter

Mandatory

Type

Description

target_spec_code

Yes

String

Explanation:

Constraints:

N/A

Values:

N/A

Default value:

N/A

Response Parameters

Status code: 202

Table 5 Response body parameters

Parameter

Type

Description

job_id

String

Explanation:

Task ID. This parameter is returned only for pay-per-use instances.

Values:

N/A

order_id

String

Explanation:

Order ID. This parameter is returned only for yearly/monthly instances.

Values:

N/A

Example Request

  • URI example 
    PUT https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/resize
  • Changing instance specifications to 16 vCPUs | 64 GB 
    {
  "resize" : {
    "target_spec_code" : "geminidb.cassandra.4xlarge.4"
  }
}

Example Response

Status code: 202

Accepted

Example response for a pay-per-use instance:

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

Example response for a yearly/monthly instance:

{
  "order_id" : "CS20070721568OVO9"
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances