文档首页> 数据接入服务 DIS> API参考> API说明> 通道管理> 更新通道信息
更新时间：2022-10-20 GMT+08:00
查看PDF

更新通道信息

功能介绍

本接口用于更新指定通道的通道信息。

URI

PUT /v3/{project_id}/streams/{stream_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

stream_name

是

String

需要变更分区数量的通道名称。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

stream_name

是

String

待更新的通道名称。

最大长度：64

data_duration

否

Integer

数据保留时长。

取值范围：24~72。

单位：小时。

缺省值：24。

空表示使用缺省值。

最大值：168

缺省值：24

data_type

否

String

源数据类型。

  • BLOB：存储在数据库管理系统中的一组二进制数据。

  • JSON：一种开放的文件格式，以易读的文字为基础，用来传输由属性值或者序列性的值组成的数据对象。

  • CSV：纯文本形式存储的表格数据，分隔符默认采用逗号。

缺省值：BLOB。

枚举值：

  • BLOB

  • JSON

  • CSV

data_schema

否

String

用于描述用户JSON、CSV格式的源数据结构，采用Avro Schema的语法描述。

auto_scale_enabled

否

Boolean

是否开启自动扩缩容。

  • true：开启自动扩缩容。

  • false：关闭自动扩缩容。

默认不开启。

缺省值：false

枚举值：

  • true

  • false

auto_scale_min_partition_count

否

Long

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

最小值：1

auto_scale_max_partition_count

否

Long

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

响应参数

无

请求示例

  • 更新通道生命周期

    PUT https://{Endpoint}/v3/{project_id}/streams/{stream_name}

{
  "stream_name" : "stz_test",
  "data_duration" : 48
}

  • 更新通道类型

    PUT https://{Endpoint}/v3/{project_id}/streams/{stream_name}

{
  "stream_name" : "stz_test",
  "data_type" : "JSON"
}

响应示例

无

状态码

状态码

描述

204

正常返回

错误码

请参见错误码。

父主题： 通道管理