Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Instance Management/ Modifying a Storage Autoscaling Policy
Updated on 2025-10-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Modifying a Storage Autoscaling Policy

Function

This API is used to modify a storage autoscaling policy. Before calling this API:

Calling Method

For details, see Calling APIs.

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 Policies 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

    Dependency

    gaussdbformysql:instance:modifyStorageSize

    Permission_management

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>
    • gaussdb:instance:modify
    • gaussdb:instance:modifyStorageSize

    -

URI

PUT /v3/{project_id}/instances/{instance_id}/storage/auto-expand-policy

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

switch_option

No

Boolean

Definition

Whether to enable an autoscaling policy.

Range

  • true: enabled

  • false: disabled

limit_size

No

Integer

Definition

Limit of storage (GB) that can be automatically scaled up to. The value must be a multiple of 10.

Range

10–Maximum storage

Example: 500

trigger_available_percent

No

Integer

Definition

Percentage of available storage. The storage will be automatically scaled up if the available storage drops to or below the value of this parameter.

Range

  • 10

  • 15

  • 20

step_percent

No

Integer

Definition

Scaling step when the storage is scaled by percentage.

Range

5–50

Response Parameters

Status code: 200

Success.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Modifying a storage autoscaling policy

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/storage/auto-expand-policy

{
  "switch_option" : true,
  "limit_size" : 500,
  "trigger_available_percent" : 10,
  "step_percent" : 20
}

Example Response

Status code: 200

Success.

{ }

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Instance Management