Querying Stream Monitoring Data¶
Function¶
This API is used to query the monitoring data of specified streams.
URI¶
GET /v2/{project_id}/streams/{stream_name}/metrics
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID. |
stream_name | Yes | String | Name of the stream. Maximum: 60 |
Parameter | Mandatory | Type | Description |
---|---|---|---|
label | No | String | Stream monitoring metric (Either label or label_list must be specified. If they are both specified, label_list prevails.)
Enumeration values:
|
label_list | No | String | List of labels separated by commas (,) to query multiple labels in batches. (Either label or label_list must be set. If both label_list and label exist, label_list prevails.) |
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. |
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 |
---|---|---|
metrics | Metrics object | Data object. |
metrics_list | Array of Metrics objects | List of monitored data objects. |
Parameter | Type | Description |
---|---|---|
dataPoints | Array of DataPoint objects | Monitoring data. |
label | String | Metric. |
Parameter | Type | Description |
---|---|---|
timestamp | Long | Timestamp. |
value | Long | Monitoring value corresponding to the timestamp. |
Example Requests¶
Querying Stream Monitoring Data
GET https://{Endpoint}/v2/{project_id}/streams/{stream_name}/metrics
Example Responses¶
None
Status Codes¶
Status Code | Description |
---|---|
200 | Normal response. |
Error Codes¶
See Error Codes.