# 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

Table 1 Path parameters
Parameter | Mandatory | Type | Description
--- | --- | --- | ---
project_id | Yes | String | Project ID.
stream_name | Yes | String | Name of the stream. Maximum: 60

Table 2 Query parameters
Parameter | Mandatory | Type | Description
--- | --- | --- | ---

label

No

String

Stream monitoring metric. (Either label or label_list must be specified. If both label_list and label are specified, label_list prevails.)

- total_put_bytes_per_stream: total input traffic (byte)

- total_get_bytes_per_stream: total output traffic (byte)

- total_put_records_per_stream: total number of input records

- total_get_records_per_stream: total number of output records

- total_put_req_latency: average processing time of upload requests (millisecond)

- total_get_req_latency: average processing time of download requests (millisecond)

- total_put_req_suc_per_stream: number of successful upload requests

- total_get_req_suc_per_stream: number of successful download requests

- traffic_control_put: number of rejected upload requests due to flow control

- traffic_control_get: number of rejected download requests due to flow control

Enumeration values:

- total_put_bytes_per_stream

- total_get_bytes_per_stream

- total_put_records_per_stream

- total_get_records_per_stream

- total_put_req_latency

- total_get_req_latency

- total_put_req_suc_per_stream

- total_get_req_suc_per_stream

- traffic_control_put

- traffic_control_get

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

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 (value of X-Subject-Token in the response header).

#### Response Parameters

Status code: 200

Table 4 Response body parameters
Parameter | Type | Description
--- | --- | ---
metrics | Metrics object | Data object.
metrics_list | Array of Metrics objects | List of monitored data objects.

Table 5 Metrics
Parameter | Type | Description
--- | --- | ---
dataPoints | Array of DataPoint objects | Monitoring data.
label | String | Metric.

Table 6 DataPoint
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.

Parent topic: Monitoring Management