文档首页> 数据接入服务 DIS> API参考> API说明> 通道管理> 更新通道信息
更新时间：2024-02-05 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新通道信息

功能介绍

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

调用方法

请参见如何调用API。

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

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"
}

响应示例

无

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
    		 
    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 UpdateStreamSolution {

    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();
        UpdateStreamRequest request = new UpdateStreamRequest();
        UpdateStreamReq body = new UpdateStreamReq();
        body.withDataDuration(48);
        body.withStreamName("stz_test");
        request.withBody(body);
        try {
            UpdateStreamResponse response = client.updateStream(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());
        }
    }
}

  • 更新通道类型

     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
    		 
    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 UpdateStreamSolution {

    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();
        UpdateStreamRequest request = new UpdateStreamRequest();
        UpdateStreamReq body = new UpdateStreamReq();
        body.withDataType(UpdateStreamReq.DataTypeEnum.fromValue("JSON"));
        body.withStreamName("stz_test");
        request.withBody(body);
        try {
            UpdateStreamResponse response = client.updateStream(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
    		 
    # coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = disClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(disRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateStreamRequest()
        request.body = UpdateStreamReq(
            data_duration=48,
            stream_name="stz_test"
        )
        response = client.update_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)

  • 更新通道类型

     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
    		 
    # coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = disClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(disRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateStreamRequest()
        request.body = UpdateStreamReq(
            data_type="JSON",
            stream_name="stz_test"
        )
        response = client.update_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
    		 
    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.UpdateStreamRequest{}
	dataDurationUpdateStreamReq:= int32(48)
	request.Body = &model.UpdateStreamReq{
		DataDuration: &dataDurationUpdateStreamReq,
		StreamName: "stz_test",
	}
	response, err := client.UpdateStream(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

  • 更新通道类型

     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
    		 
    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.UpdateStreamRequest{}
	dataTypeUpdateStreamReq:= model.GetUpdateStreamReqDataTypeEnum().JSON
	request.Body = &model.UpdateStreamReq{
		DataType: &dataTypeUpdateStreamReq,
		StreamName: "stz_test",
	}
	response, err := client.UpdateStream(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码

描述

204

正常返回

错误码

请参见错误码。

父主题： 通道管理
分享：

    相关文档

    相关产品