Updated on 2025-12-15 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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • 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

    rds:instance:getAutoEnlargePolicy

    read

    instance

    g:EnterpriseProjectId

    g:ResourceTag/<tag-key>

    rds:instance:list

    -

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

    Definition

    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

    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

  • 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

    Definition

    Whether to enable autoscaling.

    Range

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

    limit_size

    Integer

    Definition

    Upper limit for autoscaling, in GB.

    Range

    40–4000, in GB

    trigger_threshold

    Integer

    Definition

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

    Range

    Enumerated values:

    • 10
    • 15
    • 20

    step_percent

    Integer

    Definition

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

    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