Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ DB Instance Management/ Configuring an Autoscaling Policy for Storage Space
Updated on 2024-12-02 GMT+08:00
View PDF
Share

Configuring an Autoscaling Policy for Storage Space

Function

This API is used to configure an autoscaling policy for storage space.

Constraints

  • For yearly/monthly instances, the system bills new storage space automatically by default. Autoscaling is available only when your account balance is sufficient.
  • Replica set and cluster instances with read replicas do not support this function.

URI

  • URI format

    PUT /v3/{project_id}/instances/auto-enlarge-volume-policies

  • URI example

    https://dds.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/auto-enlarge-volume-policies

    Table 1 Path parameters

    Name

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Name

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM. For details, see Authentication.
Table 3 Request body parameters

Name

Type

Mandatory

Description

switch_option

String

No

Whether to enable autoscaling.

  • on: Autoscaling will be enabled for storage space.
  • off: Autoscaling will be disabled for storage space.

    The default value is on.

policies

Array of objects

Yes

Autoscaling policies for storage space.

You can set autoscaling policies for up to 10 instances. For details, see Table 4.
Table 4 DiskAutoExpansionPolicy

Name

Type

Mandatory

Description

instance_id

String

Yes

DB instance ID.

threshold

Integer

No

Threshold to trigger autoscaling. If the used storage exceeds this threshold, autoscaling is triggered. The value can be 80, 85, or 90. The default threshold is 90, indicating that autoscaling is enabled when the used storage space exceeds 90% of total storage space. This parameter of a cluster instance applies to each shard in the instance.

step

Integer

No

Autoscaling increment (s%). The value can be 10, 15, or 20, and the default value is 10. After autoscaling is triggered, your storage will automatically scale up by s% (in increments of 10 GB) of your allocated storage. If your account balance is insufficient, autoscaling will fail.

Response Parameters

Status code: 400

Table 5 Response body parameters

Name

Type

Description

error_code

String

Error code.

error_msg

String

Error message

Status code: 500

Table 6 Response body parameters

Name

Type

Description

error_code

String

Error code.

error_msg

String

Error message

Status code: default

Table 7 Response body parameters

Name

Type

Description

error_code

String

Error code.

error_msg

String

Error message

Example Request

Configure an autoscaling policy for the instance whose ID is 93e4b3eda14349b1b870f72829bc3b9bin02. Set the threshold for triggering autoscaling to 90% and the autoscaling increment to 10%.

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/auto-enlarge-volume-policies

{ 
  "policies" : [ { 
    "instance_id" : "93e4b3eda14349b1b870f72829bc3b9bin02", 
    "threshold" : 90, 
    "step" : 10 
  } ] 
}

Disable autoscaling for the instance whose ID is 93e4b3eda14349b1b870f72829bc3b9bin02.

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/auto-enlarge-volume-policies

{ 
  "policies" : [ { 
    "instance_id" : "93e4b3eda14349b1b870f72829bc3b9bin02" 
  } ], 
  "switch_option" : "off" 
}

Example Response

Status code: 200

OK.

{ }

Status Code

Status Code

Description

200

OK.

400

Client error.

500

Server error.

default

Client or server error.

Error Code

For details, see Error Code.

Parent topic: DB Instance Management