Configuring an Autoscaling Policy

Function

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

If available storage drops to a specified threshold or 10 GB, your storage will autoscale by 15% (in increments of 10 GB) of your allocated storage.

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.

• Before calling this API, obtain the required region and endpoint.

Constraints

• This API is only available to RDS for MySQL 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.

• 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

• Parameter description

  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

• URI example

  PUT https://rds.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/3d39c18788b54a919bab633874c159dfin01/disk-auto-expansion

• Request example

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

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.

last updated: 2024-11-14 08:39 UTC - commit: f56365719e781224dbc063c31e4cf80643481650