告警API
公共请求信息
Header参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| X-Authorization | string | true | 请求认证头部，认证规则详见 鉴权认证。标准格式：Bearer ${Access_token} |
| Accept | string | true | 请设置为 application/json |
| Content-Type | string | true | 请设置为 application/json |
HTTP响应状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
| 400 | 参数错误 |
| 401 | 验证不通过，请参考 鉴权认证 生成认证信息 |
业务错误码
| 状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
| 400 | PARAM_ERROR | 参数错误 | 请根据接口返回的错误描述检查参数，参数需按API文档字段填写说明填写 |
| 401 | SIGN_ERROR | 签名错误 | 权限检验异常，请详细参考文档 |
| 403 | NO_AUTH | 无权限 | 请前往平台申请此接口相关权限 |
| 429 | FREQUENCY_LIMITED | 频率超限 | 请求频率超限，请降低请求接口频率 |
| 500 | SYSTEM_ERROR | 系统错误 | 系统异常，请用相同参数重新调用 |
告警实体信息
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| petId | string(36) | true | 【动物id】预警关联的宠物 |
| score | string(32) | false | 【预警分数】0~10 之间，分数越高代表越严重 |
| remark | string(32) | false | 【备注】 |
| status | integer | true | 【预警状态】0 预警中 1 已结束 |
添加告警
接口说明
请求方式：【POST】/api/petAlert/save
请求域名：【主域名】https://iot.seismi.co
Body 参数
json内容规范参考上述 告警实体，传入对应的字段添加即可。
应答参数
200 OK
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| code | integer | true | 业务状态码 |
| msg | string(32) | true | 应答信息 |
删除告警
接口说明
请求方式：【DELETE】/api/petAlert/${id}，id为系统内的告警编号
请求域名：【主域名】https://iot.seismi.co
应答参数
200 OK
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| code | integer | true | 业务状态码 |
| msg | string(32) | true | 应答信息 |
请求示例
添加告警
curl 示例
POST
curl -X POST \
https://iot.seismi.co/api/petAlert/save \
-H "X-Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIi..." \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"petId" : "2d2f9906-a3d2-4996-bbb2-fdb5f9b7e9ac",
"score" : 8.7,
"remark" : "test",
"status" : 0
}'
应答示例
200 OK
{
"code" : "200",
"msg" : "success",
"data" : {}
}
删除告警
curl 示例
DELETE
curl -X DELETE \
https://iot.seismi.co/api/petAlert/a6c62ed7-198e-45c3-8578-762710d5b044 \
-H "X-Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIi..." \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
应答示例
200 OK
{
"code" : "200",
"msg" : "success",
"data" : {}
}