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.
Calling Method¶
For details, see Calling APIs.
URI¶
GET /v2/{project_id}/streams
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID |
Parameter | Mandatory | Type | Description |
---|---|---|---|
limit | No | Integer | The maximum number of DIS streams to list in a single API call 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¶
Parameter | Mandatory | Type | Description |
---|---|---|---|
X-Auth-Token | Yes | String | User token. It 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
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
Default: false |
stream_info_list | Array of StreamInfo objects | Stream details |
Parameter | Type | Description |
---|---|---|
stream_name | String | Stream name |
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.
Enumeration values:
|
stream_type | String | Stream type
Enumeration values:
|
data_type | String | Source data type.
Default value: BLOB Enumeration values:
|
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.
By default, auto scaling 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 |
Parameter | Type | Description |
---|---|---|
key | String | Tag key.
Minimum: 1 Maximum: 36 |
value | String | Value.
Minimum: 0 Maximum: 43 |
Parameter | Type | Description |
---|---|---|
key | String | Tag key.
|
status | String | Enumeration values:
|
value | String | Value. The value is the enterprise project ID, which needs to be obtained on the enterprise management page.
|
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.