观远 BI

订阅预警相关API

创建于 2023-04-23 / 最近更新于 2023-04-23 / 2614
字体: [默认] [大] [更大]

1. 订阅预警相关API 概述

Public API,是指观远数据为系统集成提供的标准化开放接口。系统集成,通常是指将各个分离的设备(如个人电脑)、系统、功能和信息等集成到相互关联的、统一和协调的系统之中,使资源达到充分共享,实现集中、高效、便利的管理。系统集成实现的关键在于解决系统之间的互连和互操作性问题,是一个多厂商、多协议和面向各种应用的体系结构。

观远数据提供一套简便的验证机制,来供私有化部署用户进行外部系统和账户对接集成,实现集中、高效、便利的管理。本文将为您详细介绍观远数据为您提供的与订阅预警相关的 Public API。

2. 订阅预警相关API 列表速览

目前,与订阅预警相关的 Public API 共包含2个,列表如下:

序号接口描述PATH适用版本
1
启用/关闭订阅接口/public-api/schedule/:scId/enabled5.6.0及以上
2启用/关闭预警接口/public-api/alert/:alertId/enabled5.6.0及以上

3. 订阅预警相关API 具体说明

3.1 启用/关闭订阅接口

3.1.1 接口简介

请求方式:POST

请求地址:/public-api/schedule/:scId/enabled

3.1.2 参数说明

参数名参数值说明Location类型是否必填备注
token应用TokenBodyString在观远平台中获得
enabled

true 开启

false 关闭

BodyBoolean--
scId

订阅ID

发送历史链接上有

urlString--

3.1.3 请求与响应示例

POST Body Sample:

{
   "token":"w5356207c49b34a5ba4b67d1",
   "enabled":true
}

Response Sample:

{
   "result": "ok",
   "response": "success"
}

3.1.4 报错原因

报错示例对应原因
invalid tokentoken错误或遗漏
NOT_FOUND.noScheduleForScIdscld错误

status:404

message:" "

未找到对应接口,请检查是否调用地址拼写正确,请求方法是否为POST

3.2 启用/关闭预警接口

3.2.1 接口简介

请求方式: POST

请求地址:/public-api/alert/:alertId/enabled

3.2.2 参数说明

参数名参数值说明Location类型是否必填备注
token应用TokenBodyString在观远平台中获得
enabled

true 开启

false 关闭

BodyBoolean--
alertId


预警ID

卡片预警发送历史链接上有,数据集预警页面右击-检查中查看

urlString--

3.2.3 请求与响应示例

POST Body Sample:

{
   "token":"w5356207c49b34a5ba4b67d1",
   "enabled":true
}

Response Sample:

{
   "result": "ok",
   "response": "success"
}

3.2.4 报错原因

报错示例对应原因
invalid tokentoken错误或遗漏
NOT_FOUND.noScheduleForScIdscld错误

status:404

message:" "

未找到对应接口,请检查是否调用地址拼写正确,请求方法是否为POST

2 人点赞过