更新时间:2024-02-05 GMT+08:00
分享

查看通道详情

功能介绍

本接口用于查询指定通道的详情。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/streams/{stream_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

stream_name

String

需要查询的通道名称。

最大长度:60

表2 Query参数

参数

是否必选

参数类型

描述

start_partitionId

String

从该分区值开始返回分区列表,返回的分区列表不包括此分区。 必须将“start_partitionId”的值设置为“shardId-0000000xxx”格式,xxx为要查询的通道分区Id。

limit_partitions

Integer

单次请求返回的最大分区数。

最小值:1

最大值:1000

缺省值:100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

stream_name

String

通道名称。

create_time

Long

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

last_modified_time

Long

通道最近一次修改的时间,13位时间戳。

status

String

通道的当前状态。

  • CREATING:创建中

  • RUNNING:运行中

  • TERMINATING:删除中

  • TERMINATED:已删除

枚举值:

  • CREATING

  • RUNNING

  • TERMINATING

  • FROZEN

stream_type

String

通道类型。

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

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

枚举值:

  • COMMON

  • ADVANCED

partitions

Array of PartitionResult objects

通道的分区列表。

has_more_partitions

Boolean

是否还有更多满足请求条件的分区。

  • 是:true。

  • 否:false。

retention_period

Integer

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

stream_id

String

通道唯一标示符。

data_type

String

源数据类型。

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

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

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

缺省值:BLOB。

枚举值:

  • BLOB

  • JSON

  • CSV

data_schema

String

用于描述用户JSON、CSV格式的源数据结构,采用Avro Schema的语法描述。Avro介绍您也可以点击这里查看。

compression_format

String

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

  • snappy

  • gzip

  • zip

默认不压缩。

枚举值:

  • snappy

  • gzip

  • zip

csv_properties

CSVProperties object

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

writable_partition_count

Integer

可写分区总数量(只包含ACTIVE状态的分区)。

readable_partition_count

Integer

可读分区总数量(包含ACTIVE与DELETED状态的分区)。

update_partition_counts

Array of UpdatePartitionCount objects

扩缩容操作记录列表。

tags

Array of Tag objects

通道的标签列表。

sys_tags

Array of SysTag objects

通道的企业项目。

auto_scale_enabled

Boolean

是否开启自动扩缩容。

  • true:开启自动扩缩容。

  • false:关闭自动扩缩容。

默认不开启。

auto_scale_min_partition_count

Integer

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

auto_scale_max_partition_count

Integer

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

表5 PartitionResult

参数

参数类型

描述

status

String

分区的当前状态。

  • CREATING:创建中

  • ACTIVE:可用

  • DELETED:删除中

  • EXPIRED:已过期

枚举值:

  • CREATING

  • ACTIVE

  • DELETED

  • EXPIRED

partition_id

String

分区的唯一标识符。

hash_range

String

分区的可能哈希键值范围。

sequence_number_range

String

分区的序列号范围。

parent_partitions

String

父分区。

表6 CSVProperties

参数

参数类型

描述

delimiter

String

数据分隔符。

表7 UpdatePartitionCount

参数

参数类型

描述

create_timestamp

Long

扩缩容操作执行时间戳,13位时间戳。

src_partition_count

Integer

扩缩容操作前分区数量。

target_partition_count

Integer

扩缩容操作后分区数量。

result_code

Integer

扩缩容操作响应码。

result_msg

Integer

扩缩容操作响应信息。

auto_scale

Boolean

本次扩缩容操作是否为自动扩缩容。

  • true:自动扩缩容。

  • false:手动扩缩容。

表8 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

表9 SysTag

参数

参数类型

描述

key

String

键。

  • 不能为空。

  • 值必须为_sys_enterprise_project_id。

status

String

枚举值:

  • _sys_enterprise_project_id

value

String

值。

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

  • 36位UUID。

请求示例

查看通道详情

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

响应示例

状态码: 200

正常返回

{
  "stream_id" : "8QM3Nt9YTLOwtUVYJhO",
  "stream_name" : "newstream",
  "create_time" : 1593569685875,
  "last_modified_time" : "1599050091026,",
  "retention_period" : 24,
  "status" : "RUNNING",
  "stream_type" : "COMMON",
  "data_type" : "BLOB",
  "writable_partition_count" : 1,
  "readable_partition_count" : 1,
  "tags" : [ ],
  "auto_scale_enabled" : false,
  "auto_scale_min_partition_count" : 0,
  "auto_scale_max_partition_count" : 0,
  "partitions" : [ {
    "status" : "ACTIVE",
    "partition_id" : "shardId-0000000000",
    "hash_range" : "[0 : 9223372036854775807]",
    "sequence_number_range" : "[289911 : 289927]"
  } ],
  "has_more_partitions" : false
}

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

    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();
        ShowStreamRequest request = new ShowStreamRequest();
        request.withStartPartitionId("<start_partitionId>");
        request.withLimitPartitions(<limit_partitions>);
        try {
            ShowStreamResponse response = client.showStream(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
# 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 = ShowStreamRequest()
        request.start_partition_id = "<start_partitionId>"
        request.limit_partitions = <limit_partitions>
        response = client.show_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
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.ShowStreamRequest{}
	startPartitionIdRequest:= "<start_partitionId>"
	request.StartPartitionId = &startPartitionIdRequest
	limitPartitionsRequest:= int32(<limit_partitions>)
	request.LimitPartitions = &limitPartitionsRequest
	response, err := client.ShowStream(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

正常返回

错误码

请参见错误码

分享:

    相关文档

    相关产品