Updated on 2025-12-08 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.

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

PUT /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

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:

  • The value must be divisible by 100.

  • Greater than the current instance disk capacity and less than the Number of nodes × 30,000.

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

SDK Sample Code

The SDK sample code is as follows.

Modifying the automatic disk storage expansion configuration

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.kafka.v2.region.KafkaRegion;
import com.huaweicloud.sdk.kafka.v2.*;
import com.huaweicloud.sdk.kafka.v2.model.*;


public class UpdateVolumeExpansionConfigSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        KafkaClient client = KafkaClient.newBuilder()
                .withCredential(auth)
                .withRegion(KafkaRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateVolumeExpansionConfigRequest request = new UpdateVolumeExpansionConfigRequest();
        request.withInstanceId("{instance_id}");
        AlterAutoVolumeExpandConfig body = new AlterAutoVolumeExpandConfig();
        body.withExpandIncrement(10);
        body.withMaxVolumeSize(400);
        body.withExpandThreshold(80);
        body.withAutoVolumeExpandEnable(true);
        request.withBody(body);
        try {
            UpdateVolumeExpansionConfigResponse response = client.updateVolumeExpansionConfig(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Modifying the automatic disk storage expansion configuration

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkkafka.v2.region.kafka_region import KafkaRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkkafka.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = KafkaClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(KafkaRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateVolumeExpansionConfigRequest()
        request.instance_id = "{instance_id}"
        request.body = AlterAutoVolumeExpandConfig(
            expand_increment=10,
            max_volume_size=400,
            expand_threshold=80,
            auto_volume_expand_enable=True
        )
        response = client.update_volume_expansion_config(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Modifying the automatic disk storage expansion configuration

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    kafka "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kafka/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := kafka.NewKafkaClient(
        kafka.KafkaClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateVolumeExpansionConfigRequest{}
	request.InstanceId = "{instance_id}"
	expandIncrementAlterAutoVolumeExpandConfig:= int32(10)
	maxVolumeSizeAlterAutoVolumeExpandConfig:= int32(400)
	expandThresholdAlterAutoVolumeExpandConfig:= int32(80)
	request.Body = &model.AlterAutoVolumeExpandConfig{
		ExpandIncrement: &expandIncrementAlterAutoVolumeExpandConfig,
		MaxVolumeSize: &maxVolumeSizeAlterAutoVolumeExpandConfig,
		ExpandThreshold: &expandThresholdAlterAutoVolumeExpandConfig,
		AutoVolumeExpandEnable: true,
	}
	response, err := client.UpdateVolumeExpansionConfig(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Automatic disk storage expansion configuration modified.

Error Codes

See Error Codes.