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

查询通道列表

功能介绍

本接口用户查询当前租户创建的所有通道。

查询时，需要指定从哪个通道开始返回通道列表和单次请求需要返回的最大数量。

URI

GET /v2/{project_id}/streams

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

单次请求返回通道列表的最大数量。

取值范围：1~100。

默认值：10。

最小值：1

最大值：100

缺省值：10

start_stream_name

否

String

从该通道开始返回通道列表，返回的通道列表不包括此通道名称。

如果需要分页查询，第一页查询时不传该字段。返回结果has_more_streams为true时，进行下一页查询，start_stream_name传入第一页查询结果的最后一条通道名称。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total_number

Long

当前租户所有通道数量。

stream_names

Array of strings

满足当前请求条件的通道名称的列表。

has_more_streams

Boolean

是否还有更多满足条件的通道。

  • true：是

  • false：否

缺省值：false

stream_info_list

Array of StreamInfo objects

通道列表详情。
表5 StreamInfo

参数

参数类型

描述

stream_name

String

通道名称。

create_time

Long

通道创建的时间，13位时间戳。

retention_period

Integer

数据保留时长，单位是小时。

status

String

通道的当前状态。

  • CREATING：创建中

  • RUNNING：运行中

  • TERMINATING：删除中

  • TERMINATED：已删除

枚举值：

  • CREATING

  • RUNNING

  • TERMINATING

  • FROZEN

stream_type

String

通道类型。

  • COMMON：普通通道，表示1MB带宽。

  • ADVANCED：高级通道，表示5MB带宽。

枚举值：

  • COMMON

  • ADVANCED

data_type

String

源数据类型。

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

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

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

缺省值：BLOB。

枚举值：

  • BLOB

  • JSON

  • CSV

partition_count

Integer

分区数量。

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

auto_scale_enabled

Boolean

是否开启自动扩缩容。

  • true：开启自动扩缩容。

  • false：关闭自动扩缩容。

默认不开启。

缺省值：false

auto_scale_min_partition_count

Integer

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

最小值：1

auto_scale_max_partition_count

Integer

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

tags

Array of Tag objects

通道标签列表。

sys_tags

Array of SysTag objects

通道企业项目列表。
表6 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
表7 SysTag

参数

参数类型

描述

key

String

键。

  • 不能为空。

  • 值必须为_sys_enterprise_project_id。

枚举值：

  • _sys_enterprise_project_id

value

String

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

  • 36位UUID。

请求示例

查询通道列表

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

响应示例

状态码： 200

正常返回

{
  "total_number" : 1,
  "stream_names" : [ "newstream" ],
  "stream_info_list" : [ {
    "stream_id" : "8QM3Nt9YTLOwtUVYJhO",
    "stream_name" : "newstream",
    "create_time" : 1593569685875,
    "retention_period" : 24,
    "status" : "RUNNING",
    "stream_type" : "COMMON",
    "data_type" : "BLOB",
    "partition_count" : 1,
    "tags" : [ ],
    "auto_scale_enabled" : false,
    "auto_scale_min_partition_count" : 0,
    "auto_scale_max_partition_count" : 0
  } ],
  "has_more_streams" : false
}

状态码

状态码

描述

200

正常返回

错误码

请参见错误码。

父主题： 通道管理