接口功能介绍
企业分支监控
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
GET /v4/sdwan/hq2branch-monitor/list
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| edgeBranchID | 是 | String | 互联ID | 3a5644b2-e9c4-11eb-b46f-005056898fe0 |
请求参数
请求header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码('800为成功，900为失败) ，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| totalCount | 否 | Integer | 总数 | 1 | |
| currentCount | 否 | Integer | 当前页数量 | 1 | |
| result | 否 | Array of Objects | 返回列表 | result | |
| message | 否 | String | message | ||
| code | 否 | String | code | 200 |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| delay | 否 | String | 时延（时延、抖动、丢包率三者相加等于100） | 20 | |
| jitter | 否 | String | 抖动（时延、抖动、丢包率三者相加等于100） | 40 | |
| packetLoss | 否 | String | 丢包率（时延、抖动、丢包率三者相加等于100） | 40 | |
| timestamp | 否 | String | 时间戳 | 2021-12-12 00:00:00 |
请求示例
请求url
/v4/sdwan/hq2branch-monitor/list?edgeBranchID=3a5644b2-e9c4-11eb-b46f-005056898fe0
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"message": "",
"totalCount": 1,
"currentCount": 1,
"code": "200",
"result": [
{
"delay": "20",
"jitter": "40",
"packetLoss": "40",
"timestamp": "2021-12-12 00:00:00"
}
]
}，
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
