Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Instances/ Configuring an Autoscaling Policy for Storage Space
Updated on 2025-07-29 GMT+08:00
View PDF
Share

Configuring an Autoscaling Policy for Storage Space

Function

This API is used to configure an autoscaling policy for storage space.

Constraints

  • This API supports GeminiDB Cassandra and GeminiDB Redis instances.
  • This API supports both pay-per-use and yearly/monthly instances.
  • For yearly/monthly instances, the system bills new storage space automatically by default.
  • Autoscaling is available only when your account balance is sufficient.
  • If the instance status is not normal, autoscaling of storage space cannot be configured.

URI

PUT https://{Endpoint}/v3/{project_id}/instances/disk-auto-expansion

Table 1 URI parameter

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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

Constraints:

N/A

Values:

N/A

Default value:

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

instance_ids

Yes

Array of strings

Explanation:

IDs of instances for which storage autoscaling is enabled

Constraints:

A maximum of 50 instances are supported.

Values:

N/A

Default value:

N/A

switch_option

No

String

Explanation:

Whether autoscaling is enabled. The value can be:

Constraints:

N/A

Values:

  • on: Storage autoscaling is enabled.
  • off: Storage autoscaling is disabled.

Default value:

on

policy

No

diskAutoExpansionPolicy object

Explanation:

Autoscaling policies for storage space.

Constraints:

N/A

Values:

N/A

Default value:

N/A
Table 4 diskAutoExpansionPolicy

Parameter

Mandatory

Type

Description

threshold

No

Integer

Explanation:

Threshold for triggering autoscaling.

Constraints:

N/A

Values:

  • The value of a GeminiDB Cassandra instance can be 80, 85, or 90.
  • The value of a GeminiDB Redis instance can be 60, 65, 70, 75, 80, 85, or 90.

Default value:

  • The default threshold of a GeminiDB Cassandra instance is 90, which indicates autoscaling is enabled when the used storage exceeds 90% of total storage or the available storage is less than 10 GB.
  • The default threshold of a GeminiDB Redis instance is 80, which indicates autoscaling is enabled when the used storage exceeds 80% of total storage.

step

No

Integer

Explanation:

Autoscaling step (s%).

Constraints:

NOTE:
  • GeminiDB Cassandra instances
    • If the autoscaling step is not a multiple of 10, round it up.
    • The value after the decimal point is rounded. The minimum step is 100 GB by default.
  • GeminiDB Redis instances
    • The value after the decimal point is rounded. The minimum step is 1 GB by default.
  • If there is insufficient balance in your account, storage space may fail to be scaled up for yearly/monthly instances.

Values:

  • GeminiDB Cassandra instances
    • The value can be 10, 15, or 20, and the default value is 10.
    • After autoscaling is enabled, storage space will increase by s% automatically.
  • GeminiDB Redis instances
    • The value can be 10, 15, or 20, and the default value is 20.
    • When the storage usage is greater than 98%: If the total storage is less than 600 GB, the storage usage after autoscaling (used storage space/total storage space) will be less than 85%. If the total storage is greater than or equal to 600 GB, the system automatically scales up the storage space by over 90 GB.

Default value:

10

size

No

Integer

Explanation:

Storage limit in GB that autoscaling can increase storage space to.

Constraints:

  • GeminiDB Cassandra instances
  • GeminiDB Redis instances

Values:

N/A

Default value:

N/A

Response Parameters

Status code: 204

No response parameters

Example Request

  • Enabling the autoscaling policy of storage space
    • URI example 
      PUT https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/disk-auto-expansion
    • Enabling autoscaling for storage space (Set threshold to 90, step to 10, and size to 600.) 
      { 
  "instance_ids" : [ "93e4b3eda14349b1b870f72829bc3b9bin06" ], 
  "policy" : { 
    "threshold" : 90, 
    "step" : 10, 
    "size" : 600 
  } 
}
  • Disabling the autoscaling policy of storage space
    • URI example 
      PUT https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/disk-auto-expansion
    • Disabling the autoscaling policy of storage space 
      {
    "instance_ids": [
        "93e4b3eda14349b1b870f72829bc3b9bin06"
    ],
    "switch_option": "off"
}

Example Response

Status code: 204

No content

{ }

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances