设备管理 ¶

创建设备 ¶

功能介绍 ¶

调用该接口创建设备。

URI ¶

POST /v1.0/openapi/device

请求参数 ¶

请求Header参数

参数	是否必选	参数类型	描述
x-token	是	String	参数说明：用户Token。通过认证鉴权接口获取用户Token，接口返回的“access_token”就是用户Token。简要的获取方法样例请参见认证鉴权。

请求Body参数

参数	是否必选	参数类型	描述
name	是	String	参数说明：设备名称。
product_id	是	String	参数说明：产品ID。
description	否	String	参数说明：设备描述

响应参数 ¶

公共参数

参数	参数类型	描述
success	Bool	参数说明：是否调用成功。
errorCode	Integer	参数说明：调用失败时，返回的错误码，更多信息，请参见状态码。
errorMsg	String	参数说明：调用失败时，返回的出错信息。
result	Object	参数说明：具体结果。

请求示例 ¶

json

curl --location 'http://127.0.0.1:58081/v1.0/openapi/device' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY4ODE5NzM0OSwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjcwMDUyMzQ5fQ.NEBjrUrkSabtMuZjo4bzB3rzOT-zZ1YKxILLthFQ2wQ' \
--header 'Content-Type: application/json' \
--data '{
    "name": "device-003",
    "product_id": "0215210",
    "description": "设备描述"
}'

响应示例 ¶

json

{
    "success": true,
    "errorCode": 0,
    "errorMsg": "success",
    "result": []
}

查询设备 ¶

功能介绍 ¶

调用该接口查询指定设备的详细信息。

URI ¶

GET /v1.0/openapi/device/{deviceId}

请求参数 ¶

请求Header参数

参数	是否必选	参数类型	描述
x-token	是	String	参数说明：用户Token。通过认证鉴权接口获取用户Token，接口返回的“access_token”就是用户Token。简要的获取方法样例请参见认证鉴权。

路径参数

参数	是否必选	参数类型	描述
deviceId	是	String	参数说明：设备ID，用于唯一标识一个设备，在物联网平台创建设备后由平台分配获得。

响应参数 ¶

公共参数

参数	参数类型	描述
success	Bool	参数说明：是否调用成功。
errorCode	Integer	参数说明：调用失败时，返回的错误码，更多信息，请参见状态码。
errorMsg	String	参数说明：调用失败时，返回的出错信息。
result	Object	参数说明：具体结果。

详情

参数	参数类型	描述
id	String	参数说明：设备ID，用于唯一标识一个设备，在物联网平台创建产品后由平台分配获得。
name	String	参数说明：设备名称。
platform	String	参数说明：设备平台。
status	String	参数说明：状态 `在线、离线、未激活、禁用`。
description	String	参数说明：设备描述。
product_id	String	参数说明：设备产品ID。
product_name	String	参数说明：设备产品名称。
last_online_time	Integer	参数说明：最后一次在线时间。
created_at	Integer	参数说明：创建时间。

请求示例 ¶

json

curl --location 'http://127.0.0.1:58081/v1.0/openapi/device/4701805' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY4ODE5NzM0OSwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjcwMDUyMzQ5fQ.NEBjrUrkSabtMuZjo4bzB3rzOT-zZ1YKxILLthFQ2wQ'

响应示例 ¶

json

{
    "success": true,
    "errorCode": 0,
    "errorMsg": "success",
    "result": {
        "id": "4701805",
        "name": "device-003",
        "platform": "本地",
        "status": "未激活",
        "description": "设备描述",
        "product_id": "0215210",
        "product_name": "断路器",
        "last_online_time": 0,
        "created_at": 1686616800436
    }
}

设备列表 ¶

功能介绍 ¶

调用该接口查询设备列表。

URI ¶

GET /v1.0/openapi/devices

请求参数 ¶

请求Header参数

参数	是否必选	参数类型	描述
x-token	是	String	参数说明：用户Token。通过认证鉴权接口获取用户Token，接口返回的“access_token”就是用户Token。简要的获取方法样例请参见认证鉴权。

请求Query参数

参数	是否必选	参数类型	描述
name	否	String	参数说明：设备名字，支持模糊搜索。
platform	否	String	参数说明：设备平台。
product_id	否	String	参数说明：产品ID。
status	否	String	参数说明：设备状态。
page	否	Integer	参数说明：第几页（默认1）。
pageSize	否	Integer	参数说明：每页显示的条数（默认10）。

响应参数 ¶

公共参数

参数	参数类型	描述
success	Bool	参数说明：是否调用成功。
errorCode	Integer	参数说明：调用失败时，返回的错误码，更多信息，请参见状态码。
errorMsg	String	参数说明：调用失败时，返回的出错信息。
result	Object	参数说明：具体结果。

详情

参数	参数类型	描述
list	Array	参数说明：设备列表。
list.id	String	参数说明：设备ID，用于唯一标识一个设备，在物联网平台创建产品后由平台分配获得。
list.name	String	参数说明：设备名称。
list.platform	String	参数说明：设备平台。
list.status	String	参数说明：设备状态。
list.description	String	参数说明：设备描述。
list.product_id	String	参数说明：设备产品ID。
list.product_name	String	参数说明：设备产品名称。
list.last_online_time	Integer	参数说明：设备最后一次在线时间。
list.created_at	Integer	参数说明：创建时间。
total	Integer	参数说明：设备总数。
page	Integer	参数说明：页面数。
pageSize	Integer	参数说明：每页显示的条数。

请求示例 ¶

json

curl --location 'http://127.0.0.1:58081/v1.0/openapi/devices' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY4ODE5NzM0OSwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjcwMDUyMzQ5fQ.NEBjrUrkSabtMuZjo4bzB3rzOT-zZ1YKxILLthFQ2wQ'

响应示例 ¶

json

{
    "success":true,
    "errorCode":0,
    "errorMsg":"success",
    "result":{
        "list":[
            {
                "id":"0869909",
                "name":"device-003",
                "platform":"本地",
                "status":"未激活",
                "description":"设备描述",
                "product_id":"0215210",
                "product_name":"断路器",
                "last_online_time":0,
                "created_at":1686617396794
            }
        ],
        "total":1,
        "page":1,
        "pageSize":10
    }
}

更新设备 ¶

功能介绍 ¶

调用该接口修改指定设备的信息。

URI ¶

UPDATE /v1.0/openapi/device/{deviceId}

请求参数 ¶

请求Header参数

参数	是否必选	参数类型	描述
x-token	是	String	参数说明：用户Token。通过认证鉴权接口获取用户Token，接口返回的“access_token”就是用户Token。简要的获取方法样例请参见认证鉴权。

请求Body参数

参数	是否必选	参数类型	描述
name	否	String	参数说明：产品名称。
description	否	String	参数说明：产品描述。

响应参数 ¶

公共参数

参数	参数类型	描述
success	Bool	参数说明：是否调用成功。
errorCode	Integer	参数说明：调用失败时，返回的错误码，更多信息，请参见状态码。
errorMsg	String	参数说明：调用失败时，返回的出错信息。
result	Object	参数说明：具体结果。

请求示例 ¶

json

curl --location --request PUT 'http://127.0.0.1:58081/v1.0/openapi/device/4701805' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY4ODE5NzM0OSwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjcwMDUyMzQ5fQ.NEBjrUrkSabtMuZjo4bzB3rzOT-zZ1YKxILLthFQ2wQ' \
--header 'Content-Type: application/json' \
--data '{
    "name": "device-004",
    "description":"设备描述"
}'

响应示例 ¶

json

{
    "success": true,
    "errorCode": 0,
    "errorMsg": "success",
    "result": []
}

删除设备 ¶

功能介绍 ¶

调用该接口删除指定设备。

URI ¶

DELETE /v1.0/openapi/device/{deviceId}

请求参数 ¶

请求Header参数

参数	是否必选	参数类型	描述
x-token	是	String	参数说明：用户Token。通过认证鉴权接口获取用户Token，接口返回的“access_token”就是用户Token。简要的获取方法样例请参见认证鉴权。

路径参数

参数	是否必选	参数类型	描述
deviceId	是	String	参数说明：设备ID，用于唯一标识一个设备，在物联网平台创建产品后由平台分配获得。

响应参数 ¶

公共参数

参数	参数类型	描述
success	Bool	参数说明：是否调用成功。
errorCode	Integer	参数说明：调用失败时，返回的错误码，更多信息，请参见状态码。
errorMsg	String	参数说明：调用失败时，返回的出错信息。
result	Object	参数说明：具体结果。

请求示例 ¶

json

curl --location --request DELETE 'http://127.0.0.1:58081/v1.0/openapi/device/4701805' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY3MDU1NTQ4OCwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjY5OTQ5Njg4fQ.XoIDb3pM0wcb1CxXknHEU82Df4zCvAvoptX57RIvsN8'

响应示例 ¶

json

{
    "success": true,
    "errorCode": 0,
    "errorMsg": "success",
    "result": []
}

规则引擎

函数

设备管理 ¶

创建设备 ¶

功能介绍 ¶

URI ¶

请求参数 ¶

响应参数 ¶

请求示例 ¶

响应示例 ¶

查询设备 ¶

功能介绍 ¶

URI ¶

请求参数 ¶

响应参数 ¶

请求示例 ¶

响应示例 ¶

设备列表 ¶

功能介绍 ¶

URI ¶

请求参数 ¶

响应参数 ¶

请求示例 ¶

响应示例 ¶

更新设备 ¶

功能介绍 ¶

URI ¶

请求参数 ¶

响应参数 ¶

请求示例 ¶

响应示例 ¶

删除设备 ¶

功能介绍 ¶

URI ¶

请求参数 ¶

响应参数 ¶

请求示例 ¶

响应示例 ¶