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

Querying the Autoscaling Policy of Storage Space

Function

This API is used to query the autoscaling policy of storage space.

Constraints

This API supports the following instance:

  • GeminiDB Cassandra

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:getAutoExtendVolumePolicy

    Read

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

    nosql:instance:list

    -

URI

GET /v3/{project_id}/instances/{instance_id}/disk-auto-expansion

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID

Constraints

N/A

Range

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

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

policy

object

Definition

Autoscaling policy for storage space.

Range

No information is returned if the autoscaling policy is disabled.

For details, see Table 4.
Table 4 AutoEnlargePolicy

Parameter

Type

Description

threshold

Integer

Definition

Threshold for triggering autoscaling.

Range

See Table 4.

step

Integer

Definition

Scale-up step size (%)

Range

The storage is automatically scaled up by a percentage you specify. The calculated value will be rounded up to a multiple of 10. At least 100 GB is added each time by default.

NOTE:

If there is insufficient balance in your account, storage space may fail to be scaled up for yearly/monthly instances.

size

Integer

Definition

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

Range

See Table 4.

Example Requests

  • URI example 
    GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/93e4b3eda14349b1b870f72829bc3b9bin06/disk-auto-expansion
  • Example request body

    None

Example Responses

Status code: 200

Successful response

{ 
  "policy" : { 
    "threshold" : 90, 
    "step" : 10, 
    "size" : 600 
  } 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Instances