Querying the Autoscaling Policy of Storage Space

Function

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

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auto-enlarge-volume-policy

**Table 1** Path parameters
Name	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	String	Definition DB instance ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Name	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Name	Type	Description
switch_option	String	Definition Whether to enable autoscaling. Range on: Autoscaling will be enabled for storage space. off: Autoscaling will be disabled for storage space. The default value is on.
policy	Object	Definition Autoscaling policies for storage space. For details, see Table 4. Range N/A

**Table 4** DiskAutoExpansionPolicy
Name	Type	Description
instance_id	String	Definition DB instance ID. Range N/A
threshold	Integer	Definition Threshold to trigger autoscaling. If the used storage exceeds this threshold, autoscaling is triggered. The value can be 80, 85, or 90. The default threshold is 90, indicating that autoscaling is enabled when the used storage space exceeds 90% of total storage space. This parameter of a cluster instance applies to each shard in the instance. Range 80, 85, and 90
step	Integer	Definition Autoscaling increment (s%). The value can be 10, 15, or 20, and the default value is 10. After autoscaling is triggered, your storage will automatically scale up by s% (in increments of 10 GB) of your allocated storage. If your account balance is insufficient, autoscaling will fail. Range 10, 15, and 20
size	Integer	Definition Maximum capacity of auto scaling. When the maximum capacity is reached, auto scaling is not triggered. Range If an instance has fewer than 8 vCPUs, the maximum storage that can be autoscaled up to is 5,000 GB. If an instance has 8 or more vCPUs, the maximum storage that can be autoscaled up to is 10,000 GB.

Status code: 400

**Table 5** Response body parameters
Name	Type	Description
error_code	String	Definition Error code. Range N/A
error_msg	String	Definition Error message Range N/A

Status code: 500

**Table 6** Response body parameters
Name	Type	Description
error_code	String	Definition Error code. Range N/A
error_msg	String	Definition Error message Range N/A

Example Request

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/93e4b3eda14349b1b870f72829bc3b9bin02/auto-enlarge-volume-policy

Example Response

Status code: 200
Success
{    "switch_option" : "on",
     "policy" : {  
       "instance_id" : "93e4b3eda14349b1b870f72829bc3b9bin02", 
       "threshold" : 90,   
       "step" : 10,   
       "size" : 5000  
     } 
}