Querying Stream Details
Function
This API is used to query details about a specified stream.
URI
GET /v2/{project_id}/streams/{stream_name}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
stream_name |
Yes |
String |
Stream to be queried. Maximum: 60 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
start_partitionId |
No |
String |
Name of the partition to start the partition list with. The returned partition list does not contain this partition. |
limit_partitions |
No |
Integer |
Maximum number of partitions to list in a single API call Value range: 1 to 1000 Default value: 100 Minimum: 1 Maximum: 1000 Default: 100 |
stream_id |
No |
String |
Stream ID. This parameter is mandatory for querying details of an authorized stream. |
Request 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
Parameter |
Type |
Description |
---|---|---|
stream_name |
String |
Name of the stream. |
create_time |
Long |
Time when a stream is created. The value is a 13-bit timestamp. |
last_modified_time |
Long |
Time when a stream is the most recently modified. The value is a 13-bit timestamp. |
status |
String |
Current status of the stream
Enumeration values:
|
stream_type |
String |
Stream type
Enumeration values:
|
partitions |
Array of PartitionResult objects |
A list of partitions that comprise the DIS stream. |
has_more_partitions |
Boolean |
Whether there are more matching partitions
|
retention_period |
Integer |
Period for storing data in units of hours. |
stream_id |
String |
Unique identifier of the stream. |
data_type |
String |
Source data type
Default value: BLOB Enumeration values:
|
data_schema |
String |
Source data structure that defines JSON and CSV formats. It is described in the syntax of the Avro schema. For details about Avro, go to http://avro.apache.org/docs/current/#schemas. |
compression_format |
String |
Data compression type. The following types are available:
Data is not compressed by default. Enumeration values:
|
csv_properties |
CSVProperties object |
Attributes of data in CSV format, such as delimiter. |
writable_partition_count |
Integer |
Total number of writable partitions (including partitions in ACTIVE state only). |
readable_partition_count |
Integer |
Total number of readable partitions (including partitions in ACTIVE and DELETED state). |
update_partition_counts |
Array of UpdatePartitionCount objects |
List of scaling operation records. |
tags |
Array of Tag objects |
List of stream tags. |
sys_tags |
Array of SysTag objects |
Enterprise project of a stream. |
auto_scale_enabled |
Boolean |
Whether to enable auto scaling
By default, this function is disabled. |
auto_scale_min_partition_count |
Integer |
Minimum number of partitions for automatic scale-down when auto scaling is enabled. |
auto_scale_max_partition_count |
Integer |
Maximum number of partitions for automatic scale-up when auto scaling is enabled. |
Parameter |
Type |
Description |
---|---|---|
status |
String |
Current status of the partition
Enumeration values:
|
partition_id |
String |
Unique identifier of the partition. |
hash_range |
String |
Possible value range of the hash key used by the partition. |
sequence_number_range |
String |
Sequence number range of the partition. |
parent_partitions |
String |
Parent partition. |
Parameter |
Type |
Description |
---|---|---|
create_timestamp |
Long |
Scaling execution timestamp, which is a 13-digit timestamp. |
src_partition_count |
Integer |
Number of partitions before scaling. |
target_partition_count |
Integer |
Number of partitions after scaling. |
result_code |
Integer |
Response code of the scaling operation. |
result_msg |
Integer |
Response to the scaling operation. |
auto_scale |
Boolean |
Whether the scaling operation is automatic
|
Parameter |
Type |
Description |
---|---|---|
key |
String |
Key
Minimum: 1 Maximum: 36 |
value |
String |
Value
Minimum: 0 Maximum: 43 |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Key
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 Stream Details
GET https://{Endpoint}/v2/{project_id}/streams/{stream_name}
Example Responses
Status code: 200
Normal response.
{ "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 }
Status Codes
Status Code |
Description |
---|---|
200 |
Normal response. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot