Updated on 2024-06-07 GMT+08:00

Querying an Autoscaling Policy

Function

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

  • Before calling an API, you need to understand the API in Authentication.

Constraints

  • This API is in OBT. To use this API, contact customer service.
  • This API is only available to RDS for MySQL and RDS for PostgreSQL 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

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

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

    instance_id

    Yes

    Instance ID.

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

    Whether autoscaling is enabled.

    • true: Enabled.
    • false: Disabled.

    limit_size

    Integer

    Upper limit for autoscaling, in GB.

    trigger_threshold

    Integer

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

    step_percent

    Integer

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

    This parameter is returned only when autoscaling increment customization is enabled.

    To customize an autoscaling increment, contact customer service.

  • Example normal response

    Query the autoscaling policy with autoscaling increment customization disabled.

    { 
      "switch_option" : true,
      "limit_size" : 4000,
      "trigger_threshold" : 10
    }
    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

Error Code

For details, see Error Codes.