站点链路质量
更新时间：2021-12-29 17:07:36
适用产品
连接组网
接口描述
站点链路质量
- 调用URL： https://open.chinanetcenter.com/api/siteTunnel/qualityChart
- 调用方法：GET
推荐使用 Open API在线调试
Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试
请求参数
Params 参数
| 参数名称 | 描述 |
|---|---|
*siteNameString | 站点名称
该参数必须指定时，查询指定的站点数据 |
*startTimeString | 1、查询的开始时间，格式：yyyy-mm-ddThh:mm:ss 或 yyyy-mm-ddThh:mm
2、必须小于当前时间和endtime
3、startTime和endTime相差不能超过31天（可联系技术支持调整）
4、只能查询最近半年内数据 |
*endTimeString | 1、查询的结束时间，格式：yyyy-mm-ddThh:mm:ss或 yyyy-mm-ddThh:mm
2、必须小于当前时间，大于starttime
3、startTime和endTime相差不能超过31天（可联系技术支持调整）
4、只能查询最近半年内数据 |
返回参数
Body 参数
| 参数名称 | 描述 |
|---|---|
returnCodeInteger | 接口状态码 |
returnMsgString | 接口信息 |
contentSiteQualityChartResponseContent | 响应内容 |
siteNameString | 站点名称 |
siteIdLong | 站点 ID |
tunnelList | 站点下的隧道质量数据 |
tunnelNameString | 链路名称 |
tunnelIdLong | 链路 ID |
statusInteger | 链路状态0–未知，1–在线，2-离线，3-未上报，4-挂起 |
timeStampList | 时间戳 |
timeDataList | 时间分片 |
rttList | 时延 |
lossList | 丢包率 |
mdevList | 抖动 |
错误码
| 错误代码（code） | 描述（message） | HTTP状态码 | 语义 |
|---|---|---|---|
| 4001 | 非法时间参数 | 400 | 非法时间参数 |
| 4002 | 时间参数不能为空 | 400 | 时间参数不能为空 |
| 4003 | 开始时间不能早于半年前 | 400 | 开始时间不能早于半年前 |
| 4004 | 开始与结束时间不能相差超过x天 | 400 | 开始与结束时间不能相差超过x天 |
| 4005 | 开始时间不能大于结束时间 | 400 | 开始时间不能大于结束时间 |
| 4006 | 开始结束时间必须小于当前时间 | 400 | 开始结束时间必须小于当前时间 |
| 5001 | 站点名称不能为空 | 400 | 站点名称不能为空 |
| 5002 | 站点不存在 | 400 | 站点不存在 |
示例
JSON
- 请求示例 复制成功
#!/bin/bash username="example_username" apiKey="example_apiKey" date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"` password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64` siteName="autotest_owned_initial01" startTime="2021-12-03T15:16" endTime="2021-12-03T16:16" curl -i --url "http://10.8.218.160/api/siteTunnel/qualityChart?siteName=$siteName&startTime=$startTime&endTime=$endTime" \ -X "GET" \ -u "$username:$password" \ -H "Date: $date"
- 返回示例 复制成功
{ "returnCode":"1", "returnMsg" : "success", "content":{ "siteName": "北京总部", "siteId": 740317625433843, "tunnel":[ { "tunnelName":"北京-BJ_SJC1--262-1", "tunnelId": 238473, "status": 1, "timeStamp":[1638322140000,1638322200000], "timeData":["2021-10-31 22:05","2021-10-31 22:10"], "rtt":[13.45, 11.25], "loss":[0.1, 0], "mdev":[3.5, 4.2] }, { "tunnelName":"北京-BJ_SJC1--262-2", "tunnelId": 238475, "status": 1, "timeStamp":[1638322140000,1638322200000], "timeData":["2021-10-31 22:05","2021-10-31 22:10"], "rtt":[13.45, 11.25], "loss":[0.1, 0], "mdev":[3.5, 4.2] }] } }
本篇文档内容对您是否有帮助？
有帮助
我要反馈