Updated on 2024-09-04 GMT+08:00

Querying an Autoscaling Policy

Function

This API is used to query the storage autoscaling policy of a DB instance.

Constraints

  • This API is in OBT. To use this API, contact customer service.
  • This API is only available to instances using cloud SSDs or extreme SSDs.

URI

  • URI format

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

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Explanation:

    Project ID of a tenant in a region.

    For details about how to obtain the project ID, see Obtaining a Project ID.

    Constraints:

    N/A

    Value range:

    N/A

    Default value:

    N/A

    instance_id

    Yes

    String

    Explanation:

    Instance ID.

    Constraints:

    N/A

    Value range:

    N/A

    Default value:

    N/A

Request

  • Parameter description

    None

  • URI example
    GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin011/disk-auto-expansion

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    switch_option

    Boolean

    Explanation:

    Whether to enable autoscaling.

    Value range:

    • true: Enable storage autoscaling.
    • false: Disable storage autoscaling.

    limit_size

    Integer

    Explanation:

    Upper limit for autoscaling, in GB.

    Value range:

    0–4000, in GB

    trigger_threshold

    Integer

    Explanation:

    Threshold to trigger autoscaling. If the available storage drops to this threshold or 10 GB, autoscaling is triggered.

    Value range:

    Enumerated values:

    • 10
    • 15
    • 20

    step_percent

    Integer

    Explanation:

    Autoscaling increment. It is the percentage of allocated storage that is automatically scaled up each time.

    Value range:

    5%–50%

  • Example normal response
    Query the autoscaling policy with autoscaling increment customization enabled.
    { 
      "switch_option" : true,
      "limit_size" : 4000,
      "trigger_threshold" : 10,
      "step_percent" : 30
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code