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 this API, learn how to authenticate it.
• Before calling this API, learn about the request header parameters.

Authorization Information

Constraints

• 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	Definition Project ID of a tenant in a region. Constraints The value cannot be empty. Range To obtain the value, see Obtaining a Project ID. Default Value N/A
  instance_id	Yes	Definition Instance ID. Constraints The value cannot be empty. Range You can obtain the value of this parameter from id in Table 4 by calling the API for querying DB instances. Default Value N/A

Request

Example Request

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin01/disk-auto-expansion

{
  "switch_option" : true,
  "limit_size" : 4000,
  "trigger_threshold" : 10
}

{
  "switch_option" : true,
  "limit_size" : 4000,
  "trigger_threshold" : 10,
  "step_percent" : 20
}

Response

• Example normal response

  None

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.