主题
接口描述
批量异常节点信息
注:请勿一次性查询过多节点,该接口最多返回100个异常节点的异常信息
请求路径
GET
/v1/vendoralertnode
请求参数
名称 | 类型 | 位置 | 必须 | 描述 |
---|---|---|---|---|
Authorization | string | header | 是 | 鉴权 token |
nodeIds | string | form | 否 | 节点ID,有多个节点ID则用“,”分隔 |
vendorIds | string | form | 否 | 矿主ID,有多个矿主ID则用“,”分割,如果是查自己名下的节点可不传 |
返回值
名称 | 类型 | 描述 |
---|---|---|
items | []NodeAlertInfo | 节点异常信息数据 |
NodeAlertInfo
名称 | 类型 | 描述 |
---|---|---|
nodeId | string | 节点ID |
items | []AlertInfo | 该节点的异常信息列表 |
AlertInfo
名称 | 类型 | 描述 |
---|---|---|
vendorId | int | 矿主ID |
type | string | 异常类型 |
typeCn | string | 异常类型(中文说明) |
startTime | int | 异常时间(毫秒) |
desc | string | 异常详情 |
suggest | string | 期待动作 |
status | string | 异常状态, firing:告警中 |
请求示例
http://niulinkcloud-example/v1/vendoralertnode?vendorIds=1
返回值示例
json
正常请求:
http code 200 OK
{
"items": [
{
"nodeId": "0c9e4cf68c267336e40b7b02b27a1a4f",
"items": [
{
"vendorId": 1,
"type": "area",
"typeCn": "用户上报值与系统检测值不一致",
"startTime": 1714113605303,
"desc": "上报值: 天津-天津, 检测值: 浙江-杭州",
"suggest": "点击前往节点编辑页面进行调整",
"status": "firing"
},
]
}
]
}
异常请求:
http code 4xx/5xx
{
"code": 4000001,
"desc": ""
}
错误码列表
错误码 | 描述 |
---|---|
401 | 鉴权失败 |
4000001 | 参数有误, 描述中会包含详细信息 |
4000002 | 节点未查找到 |
4000005 | 节点状态异常 |
4000009 | 流程动作非法 |
如接口返回错误码未列举,可在错误码总览中查找