Help Center/ Distributed Message Service for Kafka/ API Reference/ APIs V2 (Recommended)/ Specification Modification Management/ Querying the Automatic Disk Storage Expansion Configuration
Updated on 2025-11-19 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Automatic Disk Storage Expansion Configuration

Function

This API is used to query 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.

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, no identity policy-based permission required for calling this API.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

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

project_id

Yes

String

Definition:

Project ID. For details, see Obtaining a Project ID.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

auto_volume_expand_enable

Boolean

Definition:

Whether to enable automatic disk storage expansion.

Range:

  • true: Yes

  • false: No

expand_threshold

Integer

Definition:

Threshold for triggering automatic disk storage expansion.

Range:

20%–80%

max_volume_size

Integer

Definition:

Upper limit of automatic disk storage expansion.

Range:

N/A

expand_increment

Integer

Definition:

Proportion of each automatic disk storage expansion.

Range:

10%–100%

Example Requests

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

Example Responses

Status code: 200

Automatic disk storage expansion configuration queried.

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

Status Codes

Status Code

Description

200

Automatic disk storage expansion configuration queried.

Error Codes

See Error Codes.

Parent Topic: Specification Modification Management