创建通道
功能介绍
本接口用于创建通道。
-
创建通道时,需指定通道类型(普通、高级)、分区数量。
-
一个账号默认最多可以创建10个高级通道分区和50个普通通道分区,可提交工单增加配额。
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/streams
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
stream_name |
是 |
String |
通道名称。 通道名称由字母、数字、下划线和中划线组成,长度为1~64字符。 最大长度:64 |
partition_count |
是 |
Integer |
分区数量。 分区是DIS数据通道的基本吞吐量单位。 |
stream_type |
否 |
String |
通道类型。
枚举值:
|
data_type |
否 |
String |
源数据类型。
缺省值:BLOB。 枚举值:
|
data_duration |
否 |
Integer |
数据保留时长。 取值范围:24~72。 单位:小时。 空表示使用缺省值。 缺省值:24 |
auto_scale_enabled |
否 |
Boolean |
是否开启自动扩缩容。
默认不开启。 缺省值: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 |
数据的压缩类型,目前支持:
默认不压缩。 枚举值:
|
tags |
否 |
Array of Tag objects |
通道标签列表。 |
sys_tags |
否 |
Array of SysTag objects |
通道企业项目列表。 |
响应参数
无
请求示例
创建通道
POST https://{Endpoint}/v2/{project_id}/streams { "stream_name" : "newstream", "partition_count" : 3, "data_duration" : 24 }
响应示例
无
SDK代码示例
SDK代码示例如下。
Java
创建通道
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
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 CreateStreamSolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); DisClient client = DisClient.newBuilder() .withCredential(auth) .withRegion(DisRegion.valueOf("<YOUR REGION>")) .build(); CreateStreamRequest request = new CreateStreamRequest(); CreateStreamReq body = new CreateStreamReq(); body.withDataDuration(24); body.withPartitionCount(3); body.withStreamName("newstream"); request.withBody(body); try { CreateStreamResponse response = client.createStream(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
创建通道
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
# 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"] credentials = BasicCredentials(ak, sk) client = DisClient.new_builder() \ .with_credentials(credentials) \ .with_region(DisRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateStreamRequest() request.body = CreateStreamReq( data_duration=24, partition_count=3, stream_name="newstream" ) response = client.create_stream(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
创建通道
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dis.NewDisClient( dis.DisClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateStreamRequest{} dataDurationCreateStreamReq:= int32(24) request.Body = &model.CreateStreamReq{ DataDuration: &dataDurationCreateStreamReq, PartitionCount: int32(3), StreamName: "newstream", } response, err := client.CreateStream(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
201 |
Created |
错误码
请参见错误码。