文档首页/ 分布式消息服务Kafka版/ API参考/ API V2(推荐)/ 规格变更管理/ 修改磁盘自动扩容配置 - UpdateVolumeExpansionConfig
更新时间:2025-12-26 GMT+08:00
分享

修改磁盘自动扩容配置 - UpdateVolumeExpansionConfig

功能介绍

该接口用于修改磁盘自动扩容配置,包含磁盘自动扩容是否开启、扩容阈值、扩容步长,以及扩容上限的配置。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

String

参数解释

实例ID。获取方法如下:调用“查询所有实例列表”接口,从响应体中获取实例ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

project_id

String

参数解释

项目ID,获取方式请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

auto_volume_expand_enable

Boolean

参数解释

是否开启磁盘自动扩容。

约束限制

不涉及。

取值范围

  • true:开启磁盘自动扩容。

  • false:关闭磁盘自动扩容。

默认取值

不涉及。

expand_threshold

Integer

参数解释

触发磁盘自动扩容的阈值。

约束限制

不涉及。

取值范围

20%-80%。

默认取值

不涉及。

max_volume_size

Integer

参数解释

磁盘自动扩容的上限值。

约束限制

  • 能被100整除。

  • 大于当前实例磁盘容量,且小于节点数*30000。

取值范围

不涉及。

默认取值

不涉及。

expand_increment

Integer

参数解释

每次磁盘自动扩容的比例。

约束限制

不涉及。

取值范围

10%-100%。

默认取值

不涉及。

响应参数

状态码:204

修改自动磁盘扩容配置成功。

请求示例

修改磁盘自动扩容配置。

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
}

响应示例

SDK代码示例

SDK代码示例如下。

 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());
        }
    }
}
 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)
 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

204

修改自动磁盘扩容配置成功。

错误码

请参见错误码

相关文档