Updated on 2025-12-09 GMT+08:00

Querying the Auto Scaling Policy of a DB Instance

Function

This API is used to query the auto scaling policy of a DB instance.

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 role/policy-based authorization, see Permissions and Supported Actions for details on 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:listAll

read

-

-

rds:instance:list

-

Constraints

This API is supported for RDS for MySQL only.

URI

  • URI format

    GET /v3/{project_id}/instances/{instance_id}/auto-scaling/policy

  • Parameter description
    Table 1 Parameters

    Parameter

    Type

    Mandatory

    Description

    project_id

    String

    Yes

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

    instance_id

    String

    Yes

    Definition

    Instance ID.

    Constraints

    N/A

    Range

    N/A

    Default Value

    N/A

Request

None

Example Request

Query the auto scaling policy of a DB instance.
GET https://{Endpoint}//v3/54623db08b174c858ba779d2aa7923a3/instances/aa650a108f034e83b24486fd1ff7be2fin01/auto-scaling/policy

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    instance_id

    String

    Definition

    Instance ID.

    Range

    N/A

    status

    String

    Definition

    Whether auto scaling is enabled.

    Range

    • ON: Auto scaling is enabled.
    • OFF: Auto scaling is disabled.

    monitor_cycle

    Integer

    Definition

    Observation window, in seconds.

    Range

    N/A

    silence_cycle

    Integer

    Definition

    Silent period, in seconds.

    Range

    N/A

    enlarge_threshold

    Integer

    Definition

    Threshold for triggering auto scale-up, in percentage.

    Range

    N/A

    max_flavor

    String

    Definition

    Maximum specifications.

    Range

    N/A

    reduce_enabled

    String

    Definition

    Whether auto scale-down is enabled.

    Range

    • ON: Auto scale-down is enabled.
    • OFF: Auto scale-down is disabled.

    reduce_threshold

    Integer

    Definition

    Threshold for triggering auto scale-down.

    Range

    N/A

    min_flavor

    String

    Definition

    Minimum specifications.

    Range

    N/A

  • Example normal response
    {
      "instance_id": "aea4d8a8d302484ea0319f04566e48e2in01",
      "status": "ON",
      "monitor_cycle": 300,
      "silence_cycle": 300,
      "enlarge_threshold": 50,
      "min_flavor": "rds.mysql.n1.large.2.ha",
      "max_flavor": "rds.mysql.n1.4xlarge.2.ha",
      "reduce_enabled": "ON",
      "reduce_threshold": 30
    }

Status Code

Error Code

For details, see Error Codes.