物模型使用 ¶

设置设备的属性 ¶

功能介绍 ¶

调用该接口为指定设备设置属性值。

URI ¶

POST /v1.0/openapi/setDeviceProperty

请求参数 ¶

请求Header参数

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

请求Body参数

参数	是否必选	参数类型	描述
deviceId	是	String	参数说明：设备ID。
item	是	Object	参数说明：要设置的属性信息，例如，标识符为Switch的开关属性，数据类型为Bool，设置值为1（开）{"Switch":1}。

响应参数 ¶

公共参数

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

请求示例 ¶

json

curl --location 'http://127.0.0.1:58081/v1.0/openapi/setDeviceProperty' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY5MzY1ODMxMiwiaXNzIjoiaHVtbWluZ2JpcmQiLCJuYmYiOjE2OTMzOTgxMTJ9.n6ZnMwI4u2cdjOMCNztJvM-RGjEO5_GYaiPpffsoRl8' \
--header 'Content-Type: application/json' \
--data '{
    "deviceId": "85010108",
    "item": {
        "Breaker_control": 0
    }
}'

响应示例 ¶

json

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

调用设备的服务 ¶

调用该接口调用设备服务

URI ¶

GET /v1.0/openapi/invokeThingService

请求参数 ¶

请求Header参数

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

请求Body参数

参数	是否必选	参数类型	描述
deviceId	是	String	参数说明：设备ID。
code	是	String	参数说明：服务唯一标识符。
inputParams	是	Object	参数说明：输入参数。

响应参数 ¶

公共参数

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

详情

参数	参数类型	描述
code	Array	参数说明：服务唯一标识符。
outputParams	String	参数说明：服务输出参数。

请求示例 ¶

json

curl --location 'http://127.0.0.1:58081/v1.0/openapi/invokeThingService' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY5MDYxODI1MywiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjkwMzU4MDUzfQ.uxkcN0SRucW72bcLMguXB8OeQURKmQrE2UBG9Hm7J_U' \
--header 'Content-Type: application/json' \
--data '{
    "deviceId": "7161087",
    "code": "StartPushStreaming",
    "inputParams": {
        "stream": "chan1"
    }
}'

响应示例 ¶

json

{
  "success": true,
  "errorCode": 0,
  "errorMsg": "success",
  "result": {
    "code": "service",
    "outputParams": {
      "ss": "123"
    }
  }
}

查询设备实时属性数据 ¶

调用该接口查询设备实时属性数据

URI ¶

GET /v1.0/openapi/queryDeviceEffectivePropertyData

请求参数 ¶

请求Header参数

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

路径参数

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

响应参数 ¶

公共参数

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

详情

参数	参数类型	描述
propertyInfo	Array	参数说明：属性列表。
propertyInfo.code	String	参数说明：属性唯一标识符。
propertyInfo.value	Any	参数说明：属性值。
propertyInfo.time	Integer	参数说明：响应时间。

请求示例 ¶

json

curl --location 'http://127.0.0.1:58081/v1.0/openapi/queryDeviceEffectivePropertyData?deviceId=85010108&codes=electric_fra' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY5MzY1ODMxMiwiaXNzIjoiaHVtbWluZ2JpcmQiLCJuYmYiOjE2OTMzOTgxMTJ9.n6ZnMwI4u2cdjOMCNztJvM-RGjEO5_GYaiPpffsoRl8'

响应示例 ¶

json

{
    "success": true,
    "errorCode": 0,
    "errorMsg": "success",
    "result": {
        "propertyInfo": [
            {
                "code": "electric_fra",
                "value": "34.1",
                "time": 1693466491259
            }
        ]
    }
}

查询设备的属性历史数据 ¶

调用该接口查询指定设备事件历史数据

URI ¶

GET /v1.0/openapi/queryDevicePropertyData

请求参数 ¶

请求Header参数

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

路径参数

参数	是否必选	参数类型	描述
deviceId	是	String	参数说明：设备ID，用于唯一标识一个设备，在物联网平台创建设备后由平台分配获得。
code	是	String	参数说明：属性唯一标识符。
range	是	Array	参数说明：要查询的属性记录的开始与结束时间，取值为毫秒值时间戳。
page	否	Integer	参数说明：第几页（默认1）。
pageSize	否	Integer	参数说明：每页显示的条数（默认10）。

响应参数 ¶

公共参数

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

详情

参数	参数类型	描述
list	Array	参数说明：产品列表。
list.value	Any	参数说明：设备上报具体属性值。
list.time	Integer	参数说明：上报时间。
total	Integer	参数说明：消息总数。
page	Integer	参数说明：页面数。
pageSize	Integer	参数说明：每页显示的条数。

请求示例 ¶

json

curl --location 'http://127.0.0.1:58081/v1.0/openapi/queryDevicePropertyData?code=ShootInterval&range=1690358888548&range=1690362488548&deviceId=7161087' \
--header 'x-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY5MDYxODI1MywiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjkwMzU4MDUzfQ.uxkcN0SRucW72bcLMguXB8OeQURKmQrE2UBG9Hm7J_U'

响应示例 ¶

json

{
    "success": true,
    "errorCode": 0,
    "errorMsg": "success",
    "result": {
        "list": [
            {
                "value": 48,
                "time": 1690362483204
            },
            {
                "value": 58,
                "time": 1690362478019
            },
            {
                "value": 84,
                "time": 1690362472916
            },
            {
                "value": 54,
                "time": 1690362467815
            },
            {
                "value": 87,
                "time": 1690362462743
            },
            {
                "value": 48,
                "time": 1690362457653
            },
            {
                "value": 25,
                "time": 1690362452565
            },
            {
                "value": 67,
                "time": 1690362447456
            },
            {
                "value": 27,
                "time": 1690362442353
            },
            {
                "value": 87,
                "time": 1690362437238
            }
        ],
        "total": 104,
        "page": 1,
        "pageSize": 10
    }
}

查询设备的事件历史数据 ¶

调用该接口查询指定设备事件历史数据

URI ¶

GET /v1.0/openapi/queryDeviceEventData

请求参数 ¶

请求Header参数

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

路径参数

参数	是否必选	参数类型	描述
deviceId	是	String	参数说明：设备ID，用于唯一标识一个设备，在物联网平台创建设备后由平台分配获得。
eventCode	是	String	参数说明：事件唯一标识符。
range	是	Array	参数说明：要查询的属性记录的开始与结束时间，取值为毫秒值时间戳。
page	否	Integer	参数说明：第几页（默认1）。
pageSize	否	Integer	参数说明：每页显示的条数（默认10）。

响应参数 ¶

公共参数

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

详情

参数	参数类型	描述
list	Array	参数说明：产品列表。
list.event_code	String	参数说明：事件唯一标识符。
list.event_type	String	参数说明：事件类型。
list.output_data	Integer	参数说明：上报事件数据。
list.report_time	Integer	参数说明：上报时间。
total	Integer	参数说明：消息总数。
page	Integer	参数说明：页面数。
pageSize	Integer	参数说明：每页显示的条数。

请求示例 ¶

json

curl --location 'http://127.0.0.1:58081/v1.0/openapi/queryDeviceEventData?code=LowBatteyEvent&range=1690358888548&range=1690362488548&deviceId=7161087&x-token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY5MDYxODI1MywiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjkwMzU4MDUzfQ.uxkcN0SRucW72bcLMguXB8OeQURKmQrE2UBG9Hm7J_U'

响应示例 ¶

json

{
  "success": true,
  "errorCode": 0,
  "errorMsg": "success",
  "result": {
    "list": [
      {
        "event_code": "LowBatteyEvent",
        "event_type": "alert",
        "output_data": {
          "BatteryLevel": 36
        },
        "report_time": 1690362483331,
        "name": "电量低告警"
      },
      {
        "event_code": "LowBatteyEvent",
        "event_type": "alert",
        "output_data": {
          "BatteryLevel": 15
        },
        "report_time": 1690362478083,
        "name": "电量低告警"
      },
      {
        "event_code": "LowBatteyEvent",
        "event_type": "alert",
        "output_data": {
          "BatteryLevel": 6
        },
        "report_time": 1690362472949,
        "name": "电量低告警"
      },
      {
        "event_code": "LowBatteyEvent",
        "event_type": "alert",
        "output_data": {
          "BatteryLevel": 39
        },
        "report_time": 1690362467850,
        "name": "电量低告警"
      },
      {
        "event_code": "LowBatteyEvent",
        "event_type": "alert",
        "output_data": {
          "BatteryLevel": 82
        },
        "report_time": 1690362462775,
        "name": "电量低告警"
      },
      {
        "event_code": "LowBatteyEvent",
        "event_type": "alert",
        "output_data": {
          "BatteryLevel": 22
        },
        "report_time": 1690362457692,
        "name": "电量低告警"
      },
      {
        "event_code": "LowBatteyEvent",
        "event_type": "alert",
        "output_data": {
          "BatteryLevel": 17
        },
        "report_time": 1690362452597,
        "name": "电量低告警"
      },
      {
        "event_code": "LowBatteyEvent",
        "event_type": "alert",
        "output_data": {
          "BatteryLevel": 79
        },
        "report_time": 1690362447492,
        "name": "电量低告警"
      },
      {
        "event_code": "LowBatteyEvent",
        "event_type": "alert",
        "output_data": {
          "BatteryLevel": 82
        },
        "report_time": 1690362442394,
        "name": "电量低告警"
      },
      {
        "event_code": "LowBatteyEvent",
        "event_type": "alert",
        "output_data": {
          "BatteryLevel": 95
        },
        "report_time": 1690362437281,
        "name": "电量低告警"
      }
    ],
    "total": 104,
    "page": 1,
    "pageSize": 10
  }
}

获取设备的服务记录历史数据 ¶

调用该接口查询指定设备事件历史数据

URI ¶

GET /v1.0/openapi/queryDeviceServiceData

请求参数 ¶

请求Header参数

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

路径参数

参数	是否必选	参数类型	描述
deviceId	是	String	参数说明：设备ID，用于唯一标识一个设备，在物联网平台创建设备后由平台分配获得。
code	是	String	参数说明：服务唯一标识符。
range	是	Array	参数说明：要查询的属性记录的开始与结束时间，取值为毫秒值时间戳。
page	否	Integer	参数说明：第几页（默认1）。
pageSize	否	Integer	参数说明：每页显示的条数（默认10）。

响应参数 ¶

公共参数

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

详情

规则引擎

函数

物模型使用 ¶

设置设备的属性 ¶

功能介绍 ¶

URI ¶

请求参数 ¶

响应参数 ¶

请求示例 ¶

响应示例 ¶

调用设备的服务 ¶

URI ¶

请求参数 ¶

响应参数 ¶

请求示例 ¶

响应示例 ¶

查询设备实时属性数据 ¶

URI ¶

请求参数 ¶

响应参数 ¶

请求示例 ¶

响应示例 ¶

查询设备的属性历史数据 ¶

URI ¶

请求参数 ¶

响应参数 ¶

请求示例 ¶

响应示例 ¶

查询设备的事件历史数据 ¶

URI ¶

请求参数 ¶

响应参数 ¶

请求示例 ¶

响应示例 ¶

获取设备的服务记录历史数据 ¶

URI ¶

请求参数 ¶

响应参数 ¶