# 查询通道列表 - ListStreams #### 功能介绍 本接口用户查询当前租户创建的所有通道。 查询时，需要指定从哪个通道开始返回通道列表和单次请求需要返回的最大数量。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dis/dis_02_0400.html)。 #### URI GET /v2/{project_id}/streams 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | 取值范围在（1-500）之间。 单次请求返回通道列表的最大数量。 | | 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：否 | | stream_info_list | Array of [StreamInfo] objects | 通道列表详情。 | 表5StreamInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | stream_name | String | 通道名称。 | | create_time | Long | 通道创建的时间，13位时间戳。 | | retention_period | Integer | 数据保留时长，单位是小时。 | | status | String | 通道的当前状态。 - CREATING：创建中 - RUNNING：运行中 - TERMINATING：删除中 - TERMINATED：已删除 | | stream_type | String | 通道类型。 - COMMON：普通通道，表示1MB带宽。 - ADVANCED：高级通道，表示5MB带宽。 | | data_type | String | 源数据类型。 - BLOB：存储在数据库管理系统中的一组二进制数据。 - JSON：一种开放的文件格式，以易读的文字为基础，用来传输由属性值或者序列性的值组成的数据对象。 - CSV：纯文本形式存储的表格数据，分隔符默认采用逗号。 缺省值：BLOB。 | | partition_count | Integer | 分区数量。 分区是DIS数据通道的基本吞吐量单位。 | | auto_scale_enabled | Boolean | 是否开启自动扩缩容。 - true：开启自动扩缩容。 - false：关闭自动扩缩容。 默认不开启。 | | auto_scale_min_partition_count | Integer | 当自动扩缩容启用时，自动缩容的最小分片数。 | | auto_scale_max_partition_count | Integer | 当自动扩缩容启用时，自动扩容的最大分片数。 | | tags | Array of [Tag] objects | 通道标签列表。 | | sys_tags | Array of [SysTag] objects | 通道企业项目列表。 | 表6Tag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | 键。 - 不能为空，长度范围在（1-36）之间。 - 对于同一资源键值唯一。 - 字符集：A-Z，a-z ， 0-9，'-'，'_'，UNICODE字符（\\u4E00-\\u9FFF）。 | | value | String | 值。 - 长度不超过43个字符。 - 字符集：A-Z，a-z ， 0-9，'.'，'-'，'_'，UNICODE字符（\\u4E00-\\u9FFF）。 - 只能包含数字、字母、中划线"-"、下划线"_"。 | 表7SysTag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | 键。 - 不能为空。 - 值必须为_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 } ``` #### SDK代码示例 SDK代码示例如下。 #### Java ``` 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.dis.v2.region.DisRegion; import com.huaweicloud.sdk.dis.v2.*; import com.huaweicloud.sdk.dis.v2.model.*; public class ListStreamsSolution { 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); DisClient client = DisClient.newBuilder() .withCredential(auth) .withRegion(DisRegion.valueOf("")) .build(); ListStreamsRequest request = new ListStreamsRequest(); try { ListStreamsResponse response = client.listStreams(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()); } } } ``` #### Python ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdis.v2.region.dis_region import DisRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdis.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 = DisClient.new_builder() \ .with_credentials(credentials) \ .with_region(DisRegion.value_of("")) \ .build() try: request = ListStreamsRequest() response = client.list_streams(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` #### Go ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dis "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dis/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dis/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dis/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 := dis.NewDisClient( dis.DisClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). Build()) request := &model.ListStreamsRequest{} response, err := client.ListStreams(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DIS/sdk?api=ListStreams)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 正常返回 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dis/ErrorCode.html)。