文档首页 > > API参考> API说明> 查询通道监控信息

查询通道监控信息

分享
更新时间: 2020/07/03 GMT+08:00

功能介绍

本接口用于查询通道监控信息。

查询通道监控消息时,需指定通道名称,监控指标和监控的开始、结束时间点。

URI

  • URI格式

    GET /v2/{project_id}/streams/{stream_name}/metrics?label={label}&label_list={label_list}&start_time={start_time}&end_time={end_time}

  • 参数说明

    无。

请求

  • 请求样例
    label请求:
    GET https://{endpoint}/v2/{project_id}/streams/stream_test/metrics?label=total_put_records_per_stream&start_time=1534917441&end_time=1534921041 
    label_list请求:
    GET https://{endpoint}/v2/{project_id}/streams/stream_test/metrics?label_list=total_put_bytes_per_stream,total_put_records_per_stream&start_time=1534917441&end_time=1534921041 
  • 参数说明
    表1 参数说明

    名称

    是否必选

    类型

    说明

    stream_name

    String

    需要查询的通道名称。

    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:因流控拒绝的下载请求次数 (个)

    label_list

    String

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

    start_time

    Long

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

    end_time

    Long

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

响应

  • 响应样例

    label查询

    {
      "metrics": {
        "dataPoints": [
        {
          "timestamp": 1533200460,
          "value": 2760
        },
        {
          "timestamp": 1533200340,
          "value": 3575
        }
        ],
        "label": "total_put_records_per_stream"
      }
    }

    label_list查询:

    {
    	"metrics_list": [{
    		"label": "total_put_bytes_per_stream",
    		"dataPoints": [{
    			"timestamp": 1575537840,
    			"value": 81111040
    		}, {
    			"timestamp": 1575536640,
    			"value": 92160000
    		}]
    	}, {
    		"label": "total_put_records_per_stream",
    		"dataPoints": [{
    			"timestamp": 1575537840,
    			"value": 7921
    		}, {
    			"timestamp": 1575536640,
    			"value": 9000
    		}]
    	}]
    }

  • 参数说明
    表2 响应参数说明

    参数名

    类型

    说明

    metrics

    Metrics

    监控数据对象。

    metrics_list

    List<Metrics>

    监控数据对象列表。

    表3 Metrics参数说明

    参数名

    类型

    说明

    dataPoints

    List<DataPoint>

    通道监控数据。

    label

    String

    通道监控指标。

    • 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:因流控拒绝的下载请求次数 (个)
    表4 DataPoint参数说明

    参数名

    类型

    说明

    timestamp

    Long

    时间戳。

    value

    Long

    时间戳对应的监控值。

响应码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问