Querying Partition Monitoring Data¶

Function¶

This API is used to query the monitoring data of a specified partition of a stream.

For details, see Calling APIs.

GET /v2/{project_id}/streams/{stream_name}/partitions/{partition_id}/metrics

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
stream_name	Yes	String	Stream name Maximum: 60
partition_id	Yes	String	Partition ID.Two partition ID formats are available:- shardId-0000000000- 0For example, if a stream has three partitions, the partition IDs are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002.

**Table 2** Query Parameters¶
Parameter	Mandatory	Type	Description
label	No	String	Partition monitoring metric. (Either label or label_list must be specified. If both label_list and label exist, label_list is used.) total_put_bytes_per_partition: total input traffic in a partition (byte) total_get_bytes_per_partition: total output traffic in a partition (byte) total_put_records_per_partition: total number of input records in a partition total_get_records_per_partition: total number of output records in a partition Enumeration values: total_put_bytes_per_partition total_get_bytes_per_partition total_put_records_per_partition total_get_records_per_partition
label_list	No	String	List of labels separated by commas (,) to query multiple labels in batches. (Either label or label_list must be specified. If both label_list and label exist, label_list is used.)
start_time	Yes	Long	Monitoring start time, which is a 10-digit timestamp
end_time	Yes	Long	Monitoring end time, which is a 10-digit timestamp

**Table 3** Request header 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.

Status code: 200

**Table 4** Response body parameters¶
Parameter	Type	Description
metrics	Metrics object	Data object

**Table 5** Metrics¶
Parameter	Type	Description
dataPoints	Array of DataPoint objects	Monitoring data
label	String	Monitoring metric

**Table 6** DataPoint¶
Parameter	Type	Description
timestamp	Long	Timestamp
value	Long	Monitoring value corresponding to the timestamp

Querying Partition Monitoring Data

GET https://{Endpoint}/v2/{project_id}/streams/{stream_name}/partitions/{partition_id}/metrics

None

Status Code	Description
200	Normal response

last updated: 2025-01-27 10:23 UTC - commit: 90a70290da03409ec489fa6c4ae2059aaf4365fe