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	The project ID of a tenant in a region.
instance_id	Yes	String	DB instance ID.

Request Parameters

**Table 2** Request header parameters
Name	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token obtained from IAM. For details, see Authentication.

Response Parameters

Status code: 200

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

**Table 4** DiskAutoExpansionPolicy
Name	Type	Description
instance_id	String	DB instance ID.
threshold	Integer	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.
step	Integer	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.

Status code: 400

**Table 5** Response body parameters
Name	Type	Description
error_code	String	Error code.
error_msg	String	Error message

Status code: 500

**Table 6** Response body parameters
Name	Type	Description
error_code	String	Error code.
error_msg	String	Error message

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 
  } 
}