Querying Streams¶

Function¶

This API is used to query all the streams created by the current tenant.

During query, you need to specify the stream from which the stream list is returned and the maximum number of streams returned in a single request.

URI¶

GET /v2/{project_id}/streams

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters¶
Parameter	Mandatory	Type	Description
limit	No	Integer	The maximum number of DIS streams to list in a single API call Value range: 1 to 100 Default value: 10 Minimum: 1 Maximum: 100 Default: 10
start_stream_name	No	String	Name of the DIS stream to start the stream list with. The returned stream list does not contain this DIS stream name. If pagination query is required, this parameter is not transferred when you query data on the first page. If the value of has_more_streams is true, the query is performed on the next page. The value of start_stream_name is the name of the last stream in the query result of the first page.

Request Parameters¶

**Table 3** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters¶

Status code: 200

**Table 4** Response body parameters¶
Parameter	Type	Description
total_number	Long	Total number of all the DIS streams created by the current tenant.
stream_names	Array of strings	List of the streams meeting the current requests.
has_more_streams	Boolean	Whether there are more matching DIS streams true: yes false: no Default: false
stream_info_list	Array of StreamInfo objects	Stream details.

**Table 5** StreamInfo¶
Parameter	Type	Description
stream_name	String	Name of the stream.
create_time	Long	Time when the stream is created. The value is a 13-bit timestamp.
retention_period	Integer	Period for storing data in units of hours.
status	String	Current status of the stream CREATING: creating RUNNING: running TERMINATING: deleting TERMINATED: deleted Enumeration values: CREATING RUNNING TERMINATING FROZEN
stream_type	String	Stream type COMMON: a common stream with a bandwidth of 1 MB/s ADVANCED: an advanced stream with a bandwidth of 5 MB/s Enumeration values: COMMON ADVANCED
data_type	String	Source data type BLOB: a collection of binary data stored as a single entity in a database management system Default value: BLOB Enumeration values: BLOB
partition_count	Integer	Number of partitions Partitions are the base throughput unit of the DIS stream.
auto_scale_enabled	Boolean	Whether to enable auto scaling true: Auto scaling is enabled. false: Auto scaling is disabled. By default, this function is disabled. Default: false
auto_scale_min_partition_count	Integer	Minimum number of partitions for automatic scale-down when auto scaling is enabled. Minimum: 1
auto_scale_max_partition_count	Integer	Maximum number of partitions for automatic scale-up when auto scaling is enabled.
tags	Array of Tag objects	List of stream tags.
sys_tags	Array of SysTag objects	Stream enterprise projects.

**Table 6** Tag¶
Parameter	Type	Description
key	String	Key It cannot be left blank. It must be unique for each resource. It can contain uppercase and lowercase letters, digits, hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF). Minimum: 1 Maximum: 36
value	String	Value It can contain a maximum of 43 characters. It can contain uppercase and lowercase letters, digits, periods (.), hyphens (-), underscores (_), and Unicode characters (\u4E00-\u9FFF). It can only contain digits, letters, hyphens (-), and underscores (_). Minimum: 0 Maximum: 43

**Table 7** SysTag¶
Parameter	Type	Description
key	String	Key It cannot be left blank. Its value must be _sys_enterprise_project_id. Enumeration values: _sys_enterprise_project_id
value	String	Value. The value is the enterprise project ID, which needs to be obtained on the enterprise management page. It is a 36-digit UUID.

Example Requests¶

Querying Streams

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

Example Responses¶

Status code: 200

Normal response.

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

Status Codes¶

Status Code	Description
200	Normal response.

Error Codes¶

See Error Codes.

last updated: 2024-04-26 03:37