接口功能介绍
查询监控项
接口约束
无
URI
GET /v4/sdwan/alarm-items/list
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| serialNumbers | 是 | String | sn列表，多个盒子用逗号分割 | G65GBCS210540452 |
请求参数
请求header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码('800为成功，900为失败)，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| result | 否 | Array of Objects | 获取盒子的监控项 | result | |
| totalCount | 否 | Integer | 总数量 | ||
| currentCount | 否 | Integer | 当前页数量 |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| alarmItemName | 否 | String | 监控项名称 | internet_out | |
| alarmItemUnit | 否 | String | 监控项单位 | kbps | |
| alarmItemDescription | 否 | String | 监控项描述 | Internet流出 |
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"result": [
{
"alarmItemName": "internet_out",
"alarmItemUnit": "kbps",
"alarmItemDescription": "Internet流出"
}
],
"totalCount": 1,
"currentCount": 1
}
}
状态码
| StatusCode | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| AlarmItems.PatternCheck.NotValid | 请求参数无效 |
| AlarmItems.SdwanSdwan.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
