Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Scaling Storage Space of an Instance
Updated on 2025-12-04 GMT+08:00
View PDF
Share

Scaling Storage Space of an Instance

Function

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

Constraints

This API supports the following instances:

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

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

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • 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

    Dependencies

    gaussdbfornosql:instance:updateVolume

    Write

    instance *
    • g:ResourceTag/<tag-key>
    • g:EnterpriseProjectId

    nosql:instance:modifyStorageSize

    -

URI

PUT /v3/{project_id}/instances/{instance_id}/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

Definition

User token

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

Constraints

N/A

Range

N/A

Default value:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

size

Yes

Integer

Definition

Requested storage space in GB. The value is an integer.

Constraints

To scale up storage, ensure the new storage space is greater than the current one.

To scale down storage, ensure the new storage space is at least 1.25 times more than the used space and rounded up.

Range

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

Default value:

N/A

is_auto_pay

No

Boolean

Definition

Whether the order is automatically paid from your account when you scale up the storage of a yearly/monthly instance. This parameter does not affect the payment mode of automatic renewal.

Constraints

N/A

Range

  • 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: 200

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 storage space of a yearly/monthly instance is scaled.

Values:

N/A

Example Requests

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

Example Responses

Status code: 200

Successful response

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.

Parent topic: Instances