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

Configuring an Autoscaling Policy

Function

This API is used to configure autoscaling for a DB instance. You will be billed for the new storage.

If available storage drops to a specified threshold or 10 GB, your storage will autoscale by 20% (in increments of 10 GB) of your allocated storage. If you have customized an autoscaling increment, the storage will autoscale by the specified increment. To customize an autoscaling increment, contact customer service.

Autoscaling up the storage of a read replica does not affect that of the primary instance. The new storage space of the read replica after autoscaling must be no less than that of the primary 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.
  • Your account balance must be greater than or equal to $0 USD. If your account balance is insufficient, autoscaling will fail.
  • This API is only available to RDS for MySQL and RDS for PostgreSQL instances whose storage type is cloud SSDs or extreme SSDs and storage space is at least 40 GB.
  • Storage autoscaling is unavailable when the instance is in any of the following statuses: changing instance class, upgrading a minor version, migrating the standby instance, and rebooting.
  • If a yearly/monthly instance has pending orders, it will not be autoscaled.
  • The storage space can be autoscaled up only when your instance status is Available or Storage full. The maximum allowed storage is 4,000 GB.

URI

  • URI format

    PUT /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

Table 2 Parameters

Parameter

Mandatory

Type

Description

switch_option

Yes

Boolean

Whether to enable autoscaling.

  • true: indicates that autoscaling will be enabled.
  • false: indicates that autoscaling will be disabled.

limit_size

No

Integer

Upper limit for autoscaling, in GB. This parameter is mandatory when switch_option is set to true.

The value ranges from 40 GB to 4,000 GB and must be no less than the current storage of the instance.

trigger_threshold

No

Integer

Threshold to trigger autoscaling. If the available storage drops to this threshold or 10 GB, autoscaling is triggered. This parameter is mandatory when switch_option is set to true.

Enumerated values:

  • 10
  • 15
  • 20

step_percent

No

Integer

Autoscaling increment. It is the percentage of allocated storage that is automatically scaled up each time. This parameter is mandatory when switch_option is set to true and autoscaling increment customization is enabled.

Value range: 5% to 50%

Example Request

Configure a storage autoscaling policy for a DB instance, with the trigger threshold set to 10% or 10 GB and upper limit to 4,000 GB.
PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin01/disk-auto-expansion

{
  "switch_option" : true,
  "limit_size" : 4000,
  "trigger_threshold" : 10
}
Configure a storage autoscaling policy for a DB instance, with the trigger threshold set to 10% or 10 GB, upper limit to 4,000 GB, and autoscaling increment to 20%.
{
  "switch_option" : true,
  "limit_size" : 4000,
  "trigger_threshold" : 10,
  "step_percent" : 20
}

Response

Status Code

Error Code

For details, see Error Codes.