Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Querying Storage Autoscaling Policies of a DB Instance

Updated on 2025-08-11 GMT+08:00

View PDF

Querying Storage Autoscaling Policies of a DB Instance

Function

This API is used to query storage autoscaling policies of a DB instance. Before calling this API:

Learn how to authenticate this API.
Obtain the required region and endpoint.

URI

GET /v3/{project_id}/instances/{instance_id}/auto-enlarge-policy

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. To obtain the value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

None

Response Parameters

**Table 2** Response body parameters
Parameter	Type	Description
switch_option	Boolean	Definition Whether to enable or disable storage autoscaling. Range N/A
limit_volume_size	Integer	Definition Maximum storage that can be automatically scaled to. Range N/A
min_volume_size	Integer	Definition Minimum storage that can be automatically scaled to. Range N/A
max_volume_size	Integer	Definition Maximum storage that the system can provide for the instance. Range N/A
trigger_available_percent	Integer	Definition Percentage of available storage. The storage will be automatically scaled up if the available storage drops to or below the value of this parameter. Range N/A
percents	Array of integers	Definition Percentages of available storage that you can choose from. Range N/A
step_size	Integer	Definition Scaling step when the storage is scaled by fixed size. Range N/A
step_percent	Integer	Definition Scaling step when the storage is scaled by percentage. Range N/A

Example Request

Querying storage autoscaling policies of a DB instance

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/cc6fd964d93f4003851dfc29d57d30a5in14/auto-enlarge-policy

Example Response

Storage autoscaling policies queried.

{ 
  "switch_option" : true, 
  "limit_volume_size" : 200, 
  "min_volume_size" : 160, 
  "max_volume_size" : 240,
  "trigger_available_percent" : 20,
  "percents": [
        20,
        25,
        50
    ],
   "step_size": 200,
   "step_percent": null
}