api接口文档格式

其他接口 查询可用区信息 查询产品规格列表 查询维护时间窗时间段 查询实例在CES的监控层级关系 父主题： API V1

查看更多 →

USB模式切换 REST URL格式 访问方法 URI POST https://ip/action.cgi?ActionID=WEB_SaveCfgParamAPI 接口功能 USB模式切换 接口说明 启用此项后，大屏USB接口的使用模式将跟随当前系统自动切换 响应数据 参见表1、表2

查看更多 →

其他接口 查询可用区信息 查询产品规格列表 查询维护时间窗时间段 父主题： API V1

查看更多 →

切换到windows系统 REST URL格式 访问方法 URI POST https://ip/action.cgi?ActionID=WEB_SwitchWindows 接口功能 本接口用于从安卓系统切换至windows系统。 接口说明 当前终端处于安卓系统表1下时,调用本接口可切换至Window

查看更多 →

清理在线任务 表1 获取投屏码信息 REST URL格式 访问方法 URI DELETE https://ip/v1/om/device/tasks 接口功能 清理在线任务 接口说明 第三方APP调用清理在线任务接口关闭所有在线应用 响应数据 参见表2 参数 参数名称 可选/必选/条件必选

查看更多 →

预测接口 功能介绍 线上预测接口。 URI POST 服务部署成功后返回的预测地址。 请求消息 请求参数请参见表1 请求参数说明。 表1 请求参数说明 参数名称 是否必选 参数类型 说明 rec_num 否 Integer 请求返回数量，默认返回50条。 user_id 是 String

查看更多 →

召集会议 接口名称 WEB_ScheduleConfAPI 功能描述 从终端召集会议时，调用该接口。召集会议响应消息是MSG_SITECALL_RSP。 应用场景 从终端发起召集会议。呼叫时选择的线路类型和带宽必须满足WEB_RequestCallTypeDataAPI和WEB_

查看更多 →

导出配置文件 接口名称 configAPI 功能描述 终端配置导出到本地计算机上时调用该接口。 应用场景 支持将终端配置导出到本地计算机上，以xml格式的文件存放，configAPI为要导出的文件名称，和 "WEB_SettingExportAPI" 配合使用。"WEB_SettingExportAPI"

查看更多 →

其他接口 查询产品规格 查询维护时间窗时间段 查询租户配额 查询单个主维度下子维度监控对象列表 查询主维度信息列表 查询可用区信息 父主题： API V2

查看更多 →

停止人脸检测 表1 停止人脸检测 REST URL格式 访问方法 URI POST /v1/ai/face-detection/stop 接口功能 停止人脸检测功能 接口说明 本接口调用后，人脸检测功能停止 响应数据 参见表2、表3 参数 参数名称 可选/必选/条件必选 参数类型

查看更多 →

获取投屏码信息 表1 获取投屏码信息 REST URL格式 访问方法 URI GET https://ip/v1/cast/code 接口功能 本接口用于获取当前设备的投屏码 接口说明 查询当前设备的投屏码 响应数据 参见表2 参数 参数名称 可选/必选/条件必选 参数类型 位置

查看更多 →

其他接口 查询维护时间窗时间段 查询可用区信息 查询产品规格列表 查询实例在CES的监控层级关系 父主题： API V2（推荐）

查看更多 →

其他接口 查询维护时间窗时间段 查询可用区信息 查询产品规格列表 父主题： API V2（推荐）

查看更多 →

开始人脸检测 表1 开启人脸检测 REST URL格式 访问方法 URI POST /v1/ai/face-detection/start 接口功能 开始人脸检测功能 接口说明 本接口调用后，开启人脸检测 响应数据 参见表2、表3 参数 参数名称 可选/必选/条件必选 参数类型 位置

查看更多 →

扫描wifi 表1 扫描wifi REST URL格式 访问方法 URI GET https://ip/v1/om/network/wifi/scan 接口功能 扫描wifi信息 接口说明 用于第三方扫描设备的无线网络信息 响应数据 参见表2, 表3 参数 NA 请求消息 Header:

查看更多 →

切换到Android系统并拉起应用 REST URL格式 访问方法 URI POST https://ip/action.cgi?ActionID=WEB_SwitchAndroidWithPackage 接口功能 切换到android系统时可以调用该接口 接口说明 接口用于切换到Android系统并将应用拉起到前台

查看更多 →

通过以下辅助接口可以获取相关参数。数据获取的接口大部分为C语言与C++通用的接口，C++专用的接口在函数格式中进行了说明。 获取Device数目 获取第一个DeviceID 获取第一个GraphID 获取下一个DeviceID 获取下一个GraphID 获取Engine指针 获取Graph的GraphId

查看更多 →

通过以下辅助接口可以获取相关参数。数据获取的接口大部分为C语言与C++通用的接口，C++专用的接口在函数格式中进行了说明。 获取Device数目 获取第一个DeviceID 获取第一个GraphID 获取下一个DeviceID 获取下一个GraphID 获取Engine指针 获取Graph的GraphId

查看更多 →

查询wifi列表 表1 查询wifi列表 REST URL格式 访问方法 URI GET https://ip/v1/om/network/wifi 接口功能 查询wifi列表 接口说明 查询Wi-Fi列表信息，包括SSID号、信道、安全类型、MAC地址、信号强度。 响应数据 参见表2

查看更多 →

设置NTP信息 表1 设置NTP信息 REST URL格式 访问方法 URI PUT https://ip/v1/om/config 接口功能 用于第三方设置设备的NTP配置信息 接口说明 设置NTP配置信息，包括NTP状态、NTP设置方式、NTP服务器地址 响应数据 参见表2, 表3 参数

查看更多 →

30s，30s之后失效。 设备消息上报 API 说明 设备消息上报 在设备无法按照产品模型中定义的属性格式进行数据上报时，可调用此接口将设备的自定义数据上报给平台。 设备属性上报 API 说明 设备属性上报 用于设备按产品模型中定义的格式将属性数据上报给平台。 网关上报子设备属性

查看更多 →

查询NTP信息 表1 查询NTP配置信息 REST URL格式 访问方法 URI POST https://ip/v1/om/config 接口功能 用于第三方查询NTP配置信息 接口说明 查询NTP配置信息，包括NTP状态、NTP设置方式、NTP服务器地址 响应数据 参见表2, 表3 参数

查看更多 →

函数格式 uint32_t GetDynamicInputEdgeIndex() const; 功能说明 获取SetDynamicInputEdgeIndex设置的模型输入对应的输出边的下标。 参数说明 无。 返回值 参数名 类型 描述 - uint32_t 模型输入对应的输出边的下标。

查看更多 →

查询白板标注状态 表1 查询白板标注状态 REST URL格式 访问方法 URI GET https://ip/v1/whiteboard/annotation/status 接口功能 查询白板标注状态 接口说明 本接口调用后，可查询白板标注状态 响应数据 参见表2，表3 表2 返回值

查看更多 →

其他接口 查询产品规格列表 查询主维度信息列表 查询单个主维度下子维度监控对象列表 查询租户的试用权限 查询租户配额 查询维护时间窗时间段 查询可用区信息 父主题： 历史API（即将下线）

查看更多 →

函数格式 void SetAxSwapSwitch(bool axSwapSwitch = false); 功能说明 设置CSC色域转换前，GBA->ARGB或者YUVA->AYUV交换开关。 参数说明 参数名 输入/输出 类型 描述 axSwapSwitch 输入 bool t

查看更多 →

函数格式 void SetRbuvSwapSwitch(bool rbuvSwapSwitch = false); 功能说明 设置CSC色域转换前，R通道与B通道交换开关，或者U通道与V通道交换开关。 参数说明 参数名 输入/输出 类型 描述 rbuvSwapSwitch 输入 bool

查看更多 →

函数格式 void SetDynamicInputIndex(uint32_t dynamicInputIndex = 0); 功能说明 指定对于模型的第几个原始输入做AIPP处理。 参数说明 参数名 输入/输出 类型 描述 dynamicInputIndex 输入 uint32_t

查看更多 →

URL格式 访问方法 URI GET /v1/ai/face-detection/picture?id={id} 接口功能 获取人脸检测图片。在收到消息MSG_AI_FACE_DETECTION_RESULT后，根据消息体中人脸识别ID获取对应的图像数据。 接口说明 本接口调用后

查看更多 →

函数格式 AIStatus SetInputFormat(AippInputFormat inputFormat); 功能说明 用于设置模型的原始输入的类型。 参数说明 参数名 输入/输出 类型 描述 inputFormat 输入 AippInputFormat 模型原始输入类型。

查看更多 →

关闭摄像机 表1 关闭摄像机 REST URL格式 访问方法 URI POST https://ip/v1/camera/close 接口功能 关闭摄像机 接口说明 调用此接口关闭摄像机 响应数据 参见表2，表3 参数 NA 请求消息 Header: Cookie: SessionID=xxx

查看更多 →

结束白板标注 表1 结束白板标注 REST URL格式 访问方法 URI POST https://ip/v1/whiteboard/annotation/stop 接口功能 结束白板标注 接口说明 本接口调用后，可结束白板标注 响应数据 参见表2，表3 表2 返回值 参数 类型

查看更多 →

函数格式 AIStatus SetDtcPixelMean(int16_t dtcPixelMeanChn0 = 0, int16_t dtcPixelMeanChn1 = 0, int16_t dtcPixelMeanChn2 = 0, int16_t dtcPixelMeanChn3

查看更多 →

连接wifi 表1 连接wifi REST URL格式 访问方法 URI PUT https://ip/v1/om/network/wifi/connect 接口功能 连接某个Wi-Fi热点 接口说明 用于第三方连接某个Wi-Fi热点 响应数据 参见表2,表3 参数 参数名称 可选/必选/条件必选

查看更多 →

不保存wifi 表1 不保存wifi REST URL格式 访问方法 URI DELETE https://ip/v1/om/network/wifi/remove 接口功能 断开某个Wi-Fi热点并删除密码 接口说明 用于第三方断开某个Wi-Fi热点并删除密码 响应数据 参见表2

查看更多 →

设置WI-FI状态 表1 设置Wi-Fi状态 REST URL格式 访问方法 URI PUT https://ip/v1/om/config 接口功能 设置Wi-Fi状态信息，包括启用/禁用Wi-Fi客户端，启用/禁用Wi-Fi网络优先。 接口说明 用于第三方设置Wi-Fi的状态 响应数据 参见表2

查看更多 →

设备侧MQTT接口差异说明 本章节描述物联网平台设备侧MQTT接口新版本和老版本的具体差异。 老版本（即V3版本）设备侧MQTT接口指设备侧MQTT接口参考，新版本（即V5版本）设备侧MQTT接口指设备侧MQTT接口参考。 请求访问地址 v3版本接口请求访问地址 v5版本请求访问地址

查看更多 →

函数格式 AIStatus SetCropParams(bool cropSwitch, int32_t cropStartPosW, int32_t cropStartPosH, int32_t cropSizeW, int32_t cropSizeH, uint32_t batch_index

查看更多 →