更新时间:2022-03-23 GMT+08:00
分享

创建通道

功能介绍

本接口用于创建通道。

  • 创建通道时,需指定通道类型(普通、高级)、分区数量。

  • 一个账号账号默认最多可以创建10个高级通道分区和50个普通通道分区,可提交工单增加配额。

调试

您可以在API Explorer中调试该接口。

URI

POST /v2/{project_id}/streams

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

stream_name

String

通道名称。

通道名称由字母、数字、下划线和中划线组成,长度为1~64字符。

最大长度:64

partition_count

Integer

分区数量。

分区是DIS数据通道的基本吞吐量单位。

stream_type

String

通道类型。

  • COMMON:普通通道,表示1MB带宽。

  • ADVANCED:高级通道,表示5MB带宽。

枚举值:

  • COMMON

  • ADVANCED

data_type

String

源数据类型。

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

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

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

缺省值:BLOB。

枚举值:

  • BLOB

  • JSON

  • CSV

data_duration

Integer

数据保留时长。

取值范围:24~72。

单位:小时。

缺省值:24。

空表示使用缺省值。

最大值:168

缺省值:24

auto_scale_enabled

Boolean

是否开启自动扩缩容。

  • true:开启自动扩缩容。

  • false:关闭自动扩缩容。

默认不开启。

缺省值:false

auto_scale_min_partition_count

Long

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

最小值:1

auto_scale_max_partition_count

Integer

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

data_schema

String

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

csv_properties

CSVProperties object

CSV 格式数据的相关属性,比如分隔符 delimiter

compression_format

String

数据的压缩类型,目前支持:

  • snappy

  • gzip

  • zip

默认不压缩。

枚举值:

  • snappy

  • gzip

  • zip

tags

Array of Tag objects

通道标签列表。

sys_tags

Array of SysTag objects

通道企业项目列表。

表4 CSVProperties

参数

是否必选

参数类型

描述

delimiter

String

数据分隔符。

表5 Tag

参数

是否必选

参数类型

描述

key

String

键。

  • 不能为空。

  • 对于同一资源键值唯一。

  • 字符集:A-Z,a-z , 0-9,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。

最小长度:1

最大长度:36

value

String

值。

  • 长度不超过43个字符。

  • 字符集:A-Z,a-z , 0-9,‘.’,‘-’,‘_’,UNICODE字符(\u4E00-\u9FFF)。

  • 只能包含数字、字母、中划线“-”、下划线“_”。

最小长度:0

最大长度:43

表6 SysTag

参数

是否必选

参数类型

描述

key

String

键。

  • 不能为空。

  • 值必须为_sys_enterprise_project_id。

枚举值:

  • _sys_enterprise_project_id

value

String

值,对应的是企业项目ID,需要在企业管理页面获取。

  • 36位UUID。

响应参数

请求示例

创建通道

POST https://{Endpoint}/v2/{project_id}/streams

{
  "stream_name" : "newstream",
  "partition_count" : 3,
  "data_duration" : 24
}

响应示例

状态码

状态码

描述

201

Created

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读