文档首页> 数据接入服务 DIS> API参考> API说明> 监控管理> 查询通道监控
更新时间：2022-10-20 GMT+08:00
查看PDF

查询通道监控

功能介绍

本接口用于查询指定通道的监控数据。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

stream_name

是

String

通道名称。

最大长度：60
表2 Query参数

参数

是否必选

参数类型

描述

label

否

String

通道监控指标。（label与label_list必须二选一，label_list与label同时存在时，以label_list为准）

  • total_put_bytes_per_stream：总输入流量（Byte）

  • total_get_bytes_per_stream：总输出流量（Byte）

  • 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：因流控拒绝的下载请求次数 （个）

枚举值：

  • 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

否

String

使用label用逗号拼接组成，用于批量查询多个label的指标。（label与label_list必须二选一，label_list与label同时存在时，以label_list为准）

start_time

是

Long

监控开始时间点，10位时间戳。

end_time

是

Long

监控结束时间点，10位时间戳。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

metrics

Metrics object

数据对象。

metrics_list

Array of Metrics objects

监控数据对象列表。
表5 Metrics

参数

参数类型

描述

dataPoints

Array of DataPoint objects

监控数据。

label

String

监控指标。
表6 DataPoint

参数

参数类型

描述

timestamp

Long

时间戳。

value

Long

时间戳对应的监控值。

请求示例

查询通道监控数据

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

响应示例

无

状态码

状态码

描述

200

正常返回

错误码

请参见错误码。

父主题： 监控管理