api:tunnel:get-tunnel-monitor-data

读取监控数据-GetTunnelMonitorData

1. 接口描述

指令接口名称:GetTunnelMonitorData 获取云专线监控数据。

2. 输入参数

参数名称 必选 类型 描述
tunnelId String 云专线ID。
startTime Integer unix timestamp。 默认时间为当天的“00:00:00”。
endTime Integer unix timestamp。 endTime不能小于startTime。和startTime间隔最大30天
statistic String 获取的监控数据类型,枚举为(avg, max, min) ,默认为avg
注解:GetTunnelMonitorData获取的数据,根据所选时间段不同,会返回不同的粒度,粒度如下:
0-2小时:1分钟
2小时-1天(24小时):5分钟
1天-15天:1小时
15天以上:12小时

3. 输出参数

参数名称 类型 描述 必须 
code Int 错误码,0: 成功,其他值: 失败。
message String 错误信息。
dataSet Array 云专线监控数据,每项参数可见下面 dataSet。

dataSet

参数名称 类型 描述 必须 
endpoint String 节点名称
metric String 监控指标。值为:
In: 入流量
InPkts: 入包量
Out: 出流量
OutPkts: 出包量
dataPoints Array 监控数据列表, 每项参数可见下面 dataPoints。

dataPoints

参数名称 类型 描述 必须 
timestamp Integer 时间戳
value Float 监控数据

4. 示例

请求:

https://api.syscxp.com/?Action=GetTunnelMonitorData
&tunnelId=tunnel-qs20fr
&startTime=1431505992
&endTime=1431506592
&statistic=avg
&<公共请求参数>

响应:

{
    "code": 0,
    "message": "",
    "dataSet": [
        {
            "endpoint": "node A",
            "metric": "In",
            "dataPoints": [
                {
                    "timestamp": 1499302395
                    "value": 2791914.5
                },
                {
                    "timestamp": 1499332395
                    "value": 3791914.5
                }
            ]
        }{
            "endpoint": "node A",
            "metric": "InPkts",
            "dataPoints": [
                {
                    "timestamp": 1499302395
                    "value": 568.56
                },
                {
                    "timestamp": 1499303395
                    "value": 578.56
                }
            ]
        },
        {
            "endpoint": "node B",
            "metric": "Out",
            "dataPoints": [
                {
                    "timestamp": 1499302395
                    "value": 2791914.5
                },
                {
                    "timestamp": 1499332395
                    "value": 3791914.5
                }
            ]
        }{
            "endpoint": "node B",
            "metric": "OutPkts",
            "dataPoints": [
                {
                    "timestamp": 1499302395
                    "value": 568.56
                },
                {
                    "timestamp": 1499303395
                    "value": 578.56
                }
            ]
        }
    ]
}
如有疑问请联系 技术支持

页面工具