消控宝设备管理服务-阿里云帮助中心

设备详情查询

服务描述

调用该接口，通过产品key和deviceName查询设备信息。

API定义

path	版本
/fire/device/query	0.0.3

请求参数

参数	类型	是否必填	描述
productKey	String	是	产品key。
deviceName	String	是	设备名称。

返回参数

参数	类型	描述
code	Integer	产品key。
id	String	Request id。
data	JSON	不涉及。
-status	Integer	设备状态。 0：未激活 1：在线 3：离线 8：禁用。
-deviceName	String	设备名称。
-deviceAlias	String	设备别名。
-productKey	String	产品类型。
-address	String	设备地址。
-algorithms	List	不涉及。
--algorithmName	String	算法类型，见1、2、3支持类型。
--pendingTime	Integer	报警触发时长，单位秒。
--roiPosition	String	画框点集合的JSON字符串，顺时针排列，不填默认全框。 x和y代表以图片左上角为原点，按照图片实际大小取的坐标点。
--location	String	算法运行位置。 CLOUD：运行在云端。 EDGE：运行在消控宝一体机。
--runningTime	String	算法运行时间。
-- normalizeRoi	String	一体机算法画框参数，归一化画框坐标点集合的JSON字符串，顺时针排列，不填默认全框。二维数组坐标是横坐标的归一化数值，右边是纵坐标的归一化数值。

请求示例

{
    "request": {
        "apiVer": "0.0.1"
    },
    "params": {
        "productKey":"xxxwwe3wwq2",
    "deviceName":"3de3dd23xsd"
    },
    "version": "1.0"
}

返回示例

{
    "code": 200,
    "message": "success",
    "data": {
        "iotId": "asdaskd",
        "status": 0,
        "deviceName": "qqq",
        "productKey": "zzz",
        "address": "天鹅座",
        "algorithms": [
            "algorithmName": "AFK",
            "pendingTime": 900,
            "location": "CLOUD",
            "runningTime": "00:00-23:59",
            "roiPosition": "[{\"y\":714.705174488568,\"x\":696.2214199759326},{\"y\":619.2057761732851,\"x\":705.4632972322503},{\"y\":625.3670276774969,\"x\":898.0024067388689},{\"y\":716.245487364621,\"x\":898.0024067388689}]"
            ]
        },
    "id": "246da69e-40ad-4f44-955e-ac880f9867d7"
}

设备列表查询

服务描述

调用该接口，查询已经授权的所有设备信息。

API定义

path	版本
/fire/device/list	0.0.1

请求参数

参数	类型	是否必填	描述
pageNo	Integer	是	页号。
pageSize	Integer	是	页大小，最大200。

返回参数

参数	类型	描述
code	Integer	产品key。
id	String	请求ID。
data	JSON	返回的设备信息。
-total	Long	设备总数量。
-pageNo	Integer	页号。
-pageSize	Integer	页大小。
-items	List	设备信息。
--iotId	String	设备iotId。
--status	Integer	设备状态。 0：激活 1：在线 3：离线 8：禁用
--deviceName	String	设备名称。
--deviceAlias	String	设备别名。
--productKey	String	产品类型。
--address	String	设备地址。

请求示例

{
    "request": {
        "apiVer": "0.0.1"
    },
    "params": {
        "pageNo": 1,
        "pageSize": 10
    },
    "version": "1.0"
}

返回示例

{
    "code": 200,
    "message": "success",
    "data": {
        "total": 1,
        "pageNo": 1,
        "pageSize": 10,
        "items": [
            {
                "iotId": "asdaskd",
                "status": 0,
                "deviceName": "qqq",
                "productKey": "zzz",
                "address": "天鹅座"
            }
        ]
    },
    "id": "246da69e-40ad-4f44-955e-ac880f9867d7"
}