Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Scaling Up Storage Space of an Instance
Updated on 2025-07-02 GMT+08:00

Scaling Up Storage Space of an Instance

Function

This API is used to scale up storage space of an instance.

Constraints

This API supports the following instance types:

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx
  • GeminiDB Redis (proxy cluster)
  • GeminiDB Redis (primary/standby)

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

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/extend-volume

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

size

Yes

Integer

Explanation:

Requested storage space

Constraints:

It must be an integer greater than the current storage space.

Values:

The maximum storage space depends on the API type and specifications.

Default value:

N/A

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:

N/A

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

Response Parameters

Status code: 202

Table 4 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 when a yearly/monthly instance is created.

Values:

N/A

Example Request

  • URI example
    POST https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/extend-volume
  • Scaling up storage space of an instance to 550 GB
    {
      "size" : 550
    }

Example Response

Status code: 202

Accepted

Example response for a pay-per-use instance:

{
  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
}

Example response for a yearly/monthly instance:

{
  "order_id" : "CS20070721568OVO9"
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.