文档首页/ 数据接入服务 DIS/ API参考/ API说明/ 通道管理/ 更新通道自动扩缩容信息
更新时间:2025-11-03 GMT+08:00
分享

更新通道自动扩缩容信息

功能介绍

本接口用于通道自动扩缩容信息。

调用方法

请参见如何调用API

URI

PUT /v2/{project_id}/streams/{stream_name}/update

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID。获取方法,请参见获取项目ID

约束限制

不涉及

取值范围

只能由英文字母和数字组成,且长度为[1-64]个字符。

默认取值

不涉及

stream_name

String

参数解释

需要变更自动扩缩容信息的通道名称。

约束限制

不涉及

取值范围

不涉及。

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。请参见认证鉴权-Token认证

约束限制

不涉及

取值范围

长度为[1-32768]个字符。

默认取值

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

auto_scale_enabled

Boolean

参数解释

是否开启自动扩缩容。

约束限制

不涉及

取值范围

  • true:开启自动扩缩容。

  • false:关闭自动扩缩容。

默认取值

false

auto_scale_min_partition_count

Long

参数解释

当自动扩缩容启用时,自动缩容的最小分片数。

约束限制

自动缩容最小分区数不可大于自动扩容最大分区数,不能小于1。

取值范围

不涉及

默认取值

不涉及

auto_scale_max_partition_count

Integer

参数解释

当自动扩缩容启用时,自动扩容的最大分片数。

约束限制

不能小于1。

取值范围

不涉及

默认取值

不涉及。

update_type

String

参数解释

更新类型,固定为“AUTO_SCALE”。

约束限制

不涉及。

取值范围

AUTO_SCALE

默认取值

AUTO_SCALE

响应参数

状态码:200

正常返回

请求示例

更新通道自动扩缩容信息。

PUT https://{Endpoint}/v2/{project_id}/streams/{stream_name}/update

{
  "auto_scale_enabled" : true,
  "auto_scale_max_partition_count" : 1,
  "auto_scale_min_partition_count" : 1,
  "update_type" : "AUTO_SCALE"
}

响应示例

状态码

状态码

描述

200

正常返回

错误码

请参见错误码

相关文档