Updated on 2026-01-23 GMT+08:00

Modifying the Automatic Disk Storage Expansion Configuration

Function

This API is used to modify the automatic disk storage expansion configuration covering whether this feature is enabled, the threshold, increase, and upper limit.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/instances/{instance_id}/auto-volume-expand

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

auto_volume_expand_enable

Yes

Boolean

Definition

Whether to enable automatic disk storage expansion.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

expand_threshold

No

Integer

Definition

Threshold for triggering automatic disk storage expansion.

Constraints

N/A

Range

20%–80%

Default Value

N/A

max_volume_size

No

Integer

Definition

Upper limit of automatic disk storage expansion.

Constraints

  • Must be divisible by 100.

  • Must be less than the number of nodes multiplied by 30,000.

  • Must be greater than the current disk size of the instance.

Range

N/A

Default Value

N/A

expand_increment

No

Integer

Definition

Proportion of each automatic disk storage expansion.

Constraints

N/A

Range

10%–100%

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

-

String

Definition

Modification result.

Range

success

Example Requests

Modifying the automatic disk storage expansion configuration

PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/auto-volume-expand

{
  "auto_volume_expand_enable" : true,
  "expand_increment" : 10,
  "expand_threshold" : 80,
  "max_volume_size" : 400
}

Example Responses

Status code: 200

Automatic disk storage expansion configuration modified.

success

Status Codes

Status Code

Description

200

Automatic disk storage expansion configuration modified.

Error Codes

See Error Codes.