工业边缘数采一体机接口文档

该文档阅读对象为第三方开发者，文档包含两部分：

订阅接口：第三方应用使用 MQTT 接口订阅数据，用于数据实时消费的场景。

查询接口：第三方应用使用 HTTP 接口查询数据，用于数据按需查询的场景。

术语定义

驱动（Driver）是对接具体通信协议的程序，比如modbus驱动、opcua驱动等。驱动具备上行和下行通信功能。驱动可以运行于边缘一体机，也可以运行于边缘一体机外部。

驱动编码（DriverCode）是驱动的编码系统，在项目中作为驱动的唯一标识符。

连接（Connection）是驱动和工业现场通信设备的一个通信通道，数据采集、下行控制等功能均通过该通道实现。

连接编码（ConnectionCode）是连接的编码系统，在驱动中作为连接的唯一标识符。

驱动编码（DriverCode）和连接编码（ConnectionCode）在项目中可以唯一索引到一个连接。

资产（Asset） 是工业设备、流程和设施的数字化表示，它可以是PLC、整个机床、生产线、棍床、汽车、电机等。每个资产都有与其关联的数据。例如，一套设备可能具有序列号、位置、品牌和型号以及安装日期。它还可能具有可用性、性能、质量、温度、压力等时间序列值。本产品支持空间类和设备类资产数字化管理，以及支持按空间或功能系统结构，进行资产层次管理。

资产编码（AssetCode）是资产的编码系统，在项目中作为资产的唯一标识符，方便与第三方做对接开发。

资产模板 （资产模型、资产类型 AssetTypeCode）是一个信息模板，资产可以基于模板快速创建。在每个资产模板中，用户可以配置定义业务属性、技术属性（时序）、技术指标（时序转换或聚合）、资产模板的父子关系、以及资产模板的可视模型（2D/3D)。注意：资产可以基于模板创建，也可以不依赖模板直接添加属性。

资产属性 是每个资产中包含工业数据的元数据。从数据管理的角度，资产属性分为四个类别：基础属性、管理属性、业务属性和技术属性。业务属性是具有静态特征的数据表示，例如设备生产厂家和产品规格型号，业务属性可以具有默认值，用户从资产模型创建的每个资产都包含该模型的属性默认值。技术属性是具有时序特征的数据表示，比如设备的振动频率，每个技术属性都有一个数据类型，并可以有一个单位。资产编码（AssetCode）+ 属性编码（AttributeCode）在项目中可以唯一索引到一个属性。属性名称（AttributeName）可以是utf8中文，用于控制台显示等。属性分组名称（AttributeGroupName）用于属性归类，便于展示或检索。

数采点 经过 加工公式 处理 = 属性。

订阅接口（MQTT）

订阅资产属性

• 支持的mqtt协议版本：5.0、3.1。

• MQTT topic 规范，{$AssetCode}，{$AttributeCode} 替换为具体的标识符。

#订阅某个具体的属性
usr/Module/DataDistribution/+/+/broadcast/+/+/metric/{$AssetCode}/{$AttributeCode}

#订阅某个资产Code下所有技术属性
usr/Module/DataDistribution/+/+/broadcast/+/+/metric/{$AssetCode}/#

#订阅所有技术属性
usr/Module/DataDistribution/+/+/broadcast/+/+/metric/#

#共享订阅所有技术属性，{$group-name}为共享组名称
$share/{$group-name}/usr/Module/DataDistribution/+/+/broadcast/+/+/metric/#

#注意 ：
1、通过共享订阅可以实现多个client消费侧的负载均衡
2、mqtt链接断开后重连后需要重新subscribe
3、mqtt topic支持批量订阅
4、推荐客户端开启mqtt keepalive心跳，感知网络异常，做自动重连

• 消息格式

{
    "Data":[
        {
            "AssetCode":"",
            "AttributeCode":"",
            "AttributeName":"",
            "AttributeGroupName":"",
            "Value":number/string, //bool类型数据以0，1表示，0-false，1-true。
            "Timestamp":timestamp_number,//unix时间，单位纳秒ns，如1606800979591089792。
            "Quality":number，//0代表正常, 0xc0代表连接断开，其他保留。
        }
    ]
}
注：过渡阶段，消息报文中保留了AttributeId， AssetId字段，后续会删除

• 本地127.0.0.1订阅示例（免密）

例子：订阅所有资产下的所有技术属性的变更消息
/linkedge/gateway/build/bin/mosquitto_sub -p 10883 -t usr/Module/DataDistribution/+/+/broadcast/+/+/metric/# -v 

例子：订阅资产xxx下的所有技术属性的变更消息
/linkedge/gateway/build/bin/mosquitto_sub -p 10883 -t usr/Module/DataDistribution/+/+/broadcast/+/+/metric/xxx/# -v 

例子：订阅状态告警 & 资产告警
/linkedge/gateway/build/bin/mosquitto_sub -p 10883 -t usr/Module/Alarm/+/+/broadcast/# -v

• 外部ip订阅示例（默认用户名：iottest，默认密码请联系接口人获取）

/linkedge/gateway/build/bin/mosquitto_sub -h 192.168.1.100 -p 10883 -u $username -P $password -t usr/Module/DataDistribution/+/+/broadcast/+/+/metric/# -v

• 项目部署时，建议修改默认密码，修改方式如下

备份项目中的默认配置文件
mv /linkedge/gateway/build/bin/mosquitto_passwd /linkedge/gateway/build/bin/mosquitto_passwd.bak

生成新的配置文件（username，password按需修改）
touch /linkedge/gateway/build/bin/mosquitto_passwd

/linkedge/gateway/build/bin/mosquitto_passwd -b /linkedge/gateway/build/bin/mosquitto_pwdfile  $username  $password

重启LE使得配置生效
/linkedge/gateway/build/script/iot_gateway_start.sh

订阅告警事件

包含状态告警事件和资产告警事件

• 边缘topic

# 状态告警
usr/Module/Alarm/+/+/broadcast/+/+/stateAlarm/generated // 产生
usr/Module/Alarm/+/+/broadcast/+/+/stateAlarm/recovered // 恢复
usr/Module/Alarm/+/+/broadcast/+/+/stateAlarm/handled   // 已处理
usr/Module/Alarm/+/+/broadcast/+/+/stateAlarm/ignored   // 已忽略

# 资产告警
usr/Module/Alarm/+/+/broadcast/+/+/assetAlarm/generated // 产生
usr/Module/Alarm/+/+/broadcast/+/+/assetAlarm/recovered // 恢复
usr/Module/Alarm/+/+/broadcast/+/+/assetAlarm/handled   // 已处理
usr/Module/Alarm/+/+/broadcast/+/+/assetAlarm/ignored   // 已忽略

# 注意
1、mqtt链接断开后重连后需要重新subscribe。
2、支持批量订阅topic

• 消息内容

{
  "Id": "string",
  "SrcMsgId": "string",
  "AlarmId": "string",
  "SceneId": "string",
  "Category": "string",
  "Extras": {
    "Title": {"zh": "string", "en": "string"},
    "Kind": {"code":"string","name":{"zh":"string","en":"string"}},
    "Type": {"code":"string","name":{"zh":"string","en":"string"}},
    "Level": {"code":"string","name":{"zh":"string","en":"string"},"color":"string"},
    "Content": {"zh": "string", "en": "string"},
    "Custom": {}
  },      
  "Status": "unhandled|handled|ignored",
  "CreatedAt": number,
  "RecoveredAt": number,
  "Handler": "string",
  "HandledAt": number,
  "HandledComment": "string",
  "Trigger": {
    "Objects": [{
      "AssetCode": "string"
    }],
    "Meet": true|false
  }
}

• 消息参数

• 本地127.0.0.1订阅示例

例子：订阅状态告警 & 资产告警
/linkedge/gateway/build/bin/mosquitto_sub -p 10883 -t usr/Module/Alarm/+/+/broadcast/# -v &

查询接口（HTTP）

创建认证标识

创建认证标识。认证标识用于认证下一步API调用，有效时间为30分钟。当传入已有JWEToken，此API将刷新认证标识。

• 请求语法

POST /2021-06-10/tokens

{
  "Username": "string",
  "Password": "string",
  "JWEToken": "string"
}

• 请求参数

• 响应语法

HTTP/1.1 StatusCode

{
        "JWEToken": "string"
}

• 响应参数

• 示例

$ curl -i -d '{"Username":"xxx","Password":"xxxx"}' -X POST http://localhost/2021-06-10/tokens

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Tue, 13 Oct 2020 06:42:53 GMT
Content-Length: 697

{"JWEToken":"{\"protected\":\"eyJhbGciOiJSU0EtT0FFU****YiLCJlbmMiOiJBMjU2R0NNIn0\",\"aad\":\"eyJleHAiOiIyMDIwLTEwLTEzVDE1OjEyOj****A4OjAwIiwiaWF0IjoiMjAyMC0xMC0xM1QxNDo0Mjo1MyswODowMCJ9\",\"encrypted_key\":\"bdiLa6nV88zWPkgrDrJKF1ILUbQWSo****_QWdBYM_TWvwf9uzTt8ImVFS8w22jmVtvAEnTOy0010ioYyJdwN4-PNWLcz5h2_CIPGERJJbbLX7JCZKus4JfEkOm1mGUGOrJcvtRQvVTluluRGkM47ZPiuCVtBfnJFtpm7CZOZpOITZ7MgCImyYUyPd5effcePYFaedb61Z1Bs01waVnrSXLjh4FgF994-E3qYI12wQ_cAY0Nc_bicR45J0L47AW1V6M956pakpMkbVcl6S1li6gdwAyA8sMWZeNWRPhGH8FQMQrvXEbxPyyTxhPsKkfoQhzR70p3VK_of_b7w\",\"iv\":\"xjHlTRyIyVsNlm7X\",\"ciphertext\":\"3v-59oZUzhsDgAih4EMqk9gHn49yLDxLgjJCEDFCXXNx8s-p8-IbtjV-TQ\",\"tag\":\"jqUjxKd5Xzkk41D8FzY-dQ\"}"}

连接

查询

• 请求语法

GET /2021-06-10/drivers/{DriverCode}connections/state

• 请求参数

• 响应语法

HTTP/1.1 StatusCode

{
        "ConnectionStates": [{
    "Code": "string", // 连接编码
                "State": number,         // 连接状态，-2：异常；-1：未部署；0：正常
    "AssetState": [120, 130], // 下属设备的状态，正常120，总数130        
  }]
}

• 响应参数

• 示例

资产-模板

查询

查询资产模板列表。

• 请求语法

GET /2021-06-10/assettypes

• 请求参数

• 响应语法

HTTP/1.1 StatusCode

{
    "TotalCount": number,
    "AssetTypes": [{
    "Name": "string",
        "Code": "string"                
  }]
}

• 响应参数

• 示例

curl -i -H JWEToken:"{\"protected\":\"eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlb****BMjU2R0NNIn0\",\"aad\":\"eyJleHAiOiIyMDIxLTA2LTIwVDE5OjIxOjEwKzA4OjAwIiwiaWF0IjoiMjAyMS0wNi0yMFQxODo1MToxMCsw****MCJ9\",\"encrypted_key\":\"vzrnjCa84iJSuM9Q0YIAMmgmPpcVQoyb89wL3BK0gBeU9cQp_R39lpQVi9caaPCLBYH8Sbnfck4pzdnMVEuzP4YTIXtBlBb7bYjMft5JCB_qY609SPgUux6V3K0xlEecLo8D_WRPm6zhrJUENf-a8rBE3CM_59l3WbLr_IqavNnME07b26zfcMC5z_yMRhhajDGVpzSjdHUgP5fm9MuwMDuTIPYg30vPPJfEJatGGtWAlaCYMIKHa6AVwFn3929GtKonjI4ltjgusPDanTxjSHCZUx32P3lcE6ss8N0lDNwKnA3VdUBlTf5WcAvyB1A3UjxzKcBReEEJh****9gZQ\",\"iv\":\"KxI4LVTVxeJUF7dP\",\"ciphertext\":\"v0fiVHxzryub-mZT9UKiRwBuzukDT6CTChLrWyBUjkZd3X0vaCuLKIufWQ\",\"tag\":\"t2juVpRp9E0yP0VKaD9lxg\"}" -X GET "http://11.xx.xx.72/2021-06-10/assettypes?Name=测距&Code=DL100_LASER_PD_FB&Page=1&Size=30"
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Sun, 20 Jun 2021 10:58:41 GMT
Content-Length: 82

{"TotalCount":1,"AssetTypes":[{"Code":"DL100_LASER_PD_FB","Name":"激光测距"}]}

资产-元数据

查询元数据

查询资产基础元数据。

• 请求语法

GET /2021-06-10/assets

• 请求参数

• 响应语法

HTTP/1.1 StatusCode

{
        "TotalCount": number,
        "Assets": [{
                "Code": "string",
                "Name": "string",
    "Descs": "string",
                "TypeCode": "string",
                "TypeName": "string",
                "ParentCode": "string",
                "ParentName": "string",
                "CreatedAt": number,
        }]
}

• 响应参数

• 示例

curl -i -H JWEToken:"{\"protected\":\"eyJhbGciOiJSU0EtT0FFUC0yN****JlbmMiOiJBMjU2R0NNIn0\",\"aad\":\"eyJleHAiOiIyMDIxLTA2LTIwVDE5OjIxOjEwKzA4OjAwIiwiaWF0IjoiMjAyMS0wNi0yMFQxODo1MToxMCswODo****9\",\"encrypted_key\":\"vzrnj****JSuM9Q0YIAMmgmPpcVQoyb89wL3BK0gBeU9cQp_R39lpQVi9caaPCLBYH8Sbnfck4pzdnMVEuzP4YTIXtBlBb7bYjMft5JCB_qY609SPgUux6V3K0xlEecLo8D_WRPm6zhrJUENf-a8rBE3CM_59l3WbLr_IqavNnME07b26zfcMC5z_yMRhhajDGVpzSjdHUgP5fm9MuwMDuTIPYg30vPPJfEJatGGtWAlaCYMIKHa6AVwFn3929GtKonjI4ltjgusPDanTxjSHCZUx32P3lcE6ss8N0lDNwKnA3VdUBlTf5WcAvyB1A3UjxzKcBReEEJh2k****gZQ\",\"iv\":\"KxI4LVTVxeJUF7dP\",\"ciphertext\":\"v0fiVHxzryub-mZT9UKiRwBuzukDT6CTChLrWyBUjkZd3X0vaCuLKIufWQ\",\"tag\":\"t2juVpRp9E0yP0VKaD9lxg\"}" -X GET "http://11.xx.xx.72/2021-06-10/assets?Code=DK1_1A0010RB&Page=1&Size=30"
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Sun, 20 Jun 2021 10:57:31 GMT
Content-Length: 741

{"TotalCount":4,"Assets":[{"Code":"DK1_1A0010RB1","Name":"1A0010RB1","Descs":"JY_DK1_1A0010RB1","TypeCode":"IDENT_JY_PD_FB","TypeName":"","ParentCode":"","ParentName":"","CreatedAt":1623404682182},{"Code":"DK1_1A0010RB7","Name":"1A0010RB7","Descs":"JY_DK1_1A0010RB7","TypeCode":"IDENT_JY_PD_FB","TypeName":"","ParentCode":"","ParentName":"","CreatedAt":1623404682182},{"Code":"DK1_1A0010RB","Name":"DK1_1A0010R","Descs":"JY_DK1_1A0010RB","TypeCode":"IDENT_JY_PD_FB","TypeName":"","ParentCode":"","ParentName":"","CreatedAt":1623412036990},{"Code":"DK1_1A0010RB_TM1","Name":"1A0010RB-TM1","Descs":"JY_DK1_1A0010RB-TM1","TypeCode":"DRIVE_LENZE8400PN_PD_FB","TypeName":"","ParentCode":"DK1_1A0010RB","ParentName":"","CreatedAt":1623412036990}]}

查询子资产

查询某资产下所有子资产列表。

• 请求语法

GET /2021-06-10/childassets

• 请求参数

• 响应语法

HTTP/1.1 StatusCode

{
        "TotalCount": number,
        "Assets": [{
                "Code": "string"                
  }]
}

• 响应参数

• 示例

curl -i -H JWEToken:"{\"protected\":\"eyJhbGciOiJSU0EtT0****TYiLCJlbmMiOiJBMjU2R0NNIn0\",\"aad\":\"eyJleHAiOiIyMDIxLTA2LTIwVDE5OjIxOjEwKzA4OjAwIiwiaWF0IjoiMjAyMS0wNi0yMF****o1MToxMCswODowMCJ9\",\"encrypted_key\":\"vzrnjCa84iJSuM9Q0YIAMmgmPpcVQoyb89wL3BK0gBeU9cQp_R39lpQVi9caaPCLBYH8Sbnfck4pzdnMVEuzP4YTIXtBlBb7bYjMft5JCB_qY609SPgUux6V3K0xlEecLo8D_WRPm6zhrJUENf-a8rBE3CM_59l3WbLr_IqavNnME07b26zfcMC5z_yMRhhajDGVpzSjdHUgP5fm9MuwMDuTIPYg30vPPJfEJatGGtWAlaCYMIKHa6AVwFn3929GtKonjI4ltjgusPDanTxjSHCZUx32P3lcE6ss8N0lDNwKnA3VdUBlTf5WcAvyB1A3UjxzKcBReEEJh****79gZQ\",\"iv\":\"KxI4LVTVxeJUF7dP\",\"ciphertext\":\"v0fiVHxzryub-mZT9UKiRwBuzukDT6CTChLrWyBUjkZd3X0va****IufWQ\",\"tag\":\"t2juVpRp9E0yP0VKaD9lxg\"}" -X GET "http://11.xx.xx.72/2021-06-10/childassets?Code=ACCDD"
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Sun, 20 Jun 2021 11:01:16 GMT
Content-Length: 51

{"TotalCount":1,"Assets":[{"Code":"DK1_1A0010RC"}]}

资产-技术属性-元数据

查询

查询资产技术属性元信息。

• 请求语法

GET /2021-06-10/assets/{AssetCode}/attributeinfos

• 请求参数

• 响应语法

HTTP/1.1 StatusCode

{
        "TotalCount": number,
        "AttributeInfos": [{
                "Writable": "t", // f 不可写；t 可写
                "MeasureUnit": "string",
                "MinValue": "string",
                "MaxValue": "string",
    "AssetCode": "string",
                "AttributeName": "string",
    "DataType":"Bool",
                "AttributeGroupName": "string",
    "AttributeCode": "string",
    "AttributeDescs": "string",
    "AttributeGroupDescs": "string",
    "EnumValue": "string",
    "Precision": number,
                "CreatedAt": number,
    "ModifiedAt": number
        }]
}

• 响应参数

• 示例

curl -i -H JWEToken:"{\"protected\":\"eyJhbGciOiJSU0EtT0F****LCJlbmMiOiJBMjU2R0NNIn0\",\"aad\":\"eyJleHAiOiIyMDIxLTA2LTIwVDE5OjIxOjEwKzA4OjAwIiwiaWF0IjoiMjAyMS0wNi0yMFQxODo1MToxMCsw****MCJ9\",\"encr\":\"vzrnypted_keyjCa84iJSuM9Q0YIAMmgmPpcVQoyb89wL3BK0gBeU9cQp_R39lpQVi9caaPCLBYH8Sbnfck4pzdnMVEuzP4YTIXtBlBb7bYjMft5JCB_qY609SPgUux6V3K0xlEecLo8D_WRPm6zhrJUENf-a8rBE3CM_59l3WbLr_IqavNnME07b26zfcMC5z_yMRhhajDGVpzSjdHUgP5fm9MuwMDuTIPYg30vPPJfEJatGGtWAlaCYMIKHa6AVwFn3929GtKonjI4ltjgusPDanTxjSHCZUx32P3lcE6ss8N0lDNwKnA3VdUBlTf5WcAvyB1A3UjxzKcBReEEJh2****9gZQ\",\"iv\":\"KxI4LVTVxeJUF7dP\",\"ciphertext\":\"v0fiVHxzryub-mZT9UKiRwBuzukDT6CTChLrWyBUjkZd3X0va****IufWQ\",\"tag\":\"t2juVpRp9E0yP0VKaD9lxg\"}" -X GET "http://11.xx.xx.72/2021-06-10/assets/CON1_1A001001/attributeinfos?Page=1&Size=2"
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Sun, 20 Jun 2021 11:02:37 GMT
Content-Length: 726

{"TotalCount":72,"AttributeInfos":[{"Writable":"t","MeasureUnit":"","MinValue":"","MaxValue":"","AssetCode":"CON1_1A001001","AttributeName":"Spare_0","DataType":"Bool","AttributeGroupName":"BOOL_DEMO","AttributeCode":"BOOL_DEMO.Spare_0","AttributeDescs":"Spare_0","AttributeGroupDescs":"","EnumValue":"","Precision":0,"CreatedAt":1626417324033,"ModifiedAt":1626417324033},{"Writable":"f","MeasureUnit":"","MinValue":"","MaxValue":"","AssetCode":"CON1_1A001001","AttributeName":"Spare_1","DataType":"Bool","AttributeGroupName":"BOOL_DEMO","AttributeCode":"BOOL_DEMO.Spare_1","AttributeDescs":"Spare_1","AttributeGroupDescs":"","EnumValue":"","Precision":0,"CreatedAt":1626417324033,"ModifiedAt":1626417324033}]}

资产-技术属性-数据值

查询

查询单个资产的技术属性值。

• 请求语法

GET /2021-06-10/assets/{AssetCode}/attributes

• 请求参数

• 响应语法

HTTP/1.1 StatusCode

{
        "Results": [{
                "Series": [{
                        "AssetCode": "string",
      "AttributeCode": "string",
                        "Columns": [
                                "time",
                                "value",
        "quality"
                        ],
                        "Values": [
                                [
                                        number, // 时间戳，与Columns[0]字段对应。
                                        "string"|boolean|number, // 属性值，与Columns[1]字段对应。
          number // 质量码，与Columns[2]字段对应。
                                ]                                
                        ]
                }]
        }]
}

• 响应参数

• 示例

$ curl -v -H JWEToken:"{\"protected\":\"eyJhbGciOiJSU0EtT0****YiLCJlbmMiOiJBMjU2R0NNIn0\",\"aad\":\"eyJleHAiOiIyMDIxLTAzLTI2VDE4OjU2OjM1KzA4OjAwIiwiaWF0IjoiMjAyMS0wMy0yNlQxODoyNjo****wODowMCJ9\",\"encrypted_key\":\"Xl0ZCP62O_ZXt5OSt_lkep7aEyxoY_zGwMOr0dkZR7rVWwQ-Rj3e05gj5emxLToGUgr2cqN_N8dEz5msu9Ul0hMCa-cZGM7O3N4mZHGxc8f5LXCGf4SfTWlhvnund1orOIuKBTh3vP86PgCNTaZssqWaE2B9BQ2corVn5FVtCCVdFWadTyracOLz9r2vaChUup1XOu3UoQQ9q13b1wFhEt8tdP8NqaBcyNDzHk73Clq0V6qCtdFzJeUf9aVaI87Pq2y3Nj1UY99x03BzZ8KjaRtH6smUG1x9IZm1QTDEsHWF__dGlXIQ-STKRcWwJ-rKeCTCSC6A8qbP****DFdXjQ\",\"iv\":\"2zx_4cDgzCCdNtr3\",\"ciphertext\":\"VL3v9AL1RYq40lLTZInMcCktwI2yw1L_m5x44LDtLw4txWHCkK2d90Witg\",\"tag\":\"5_Ra1Nk-GJU839EO9ujynQ\"}" -G --data-urlencode 'AttributeCodes=HMI_Control_No' --data-urlencode 'Type=last'  http://localhost/2021-06-10/assets/DK1_1B0890SL/attributes
*   Trying 127.0.0.1...
* TCP_NODELAY set
* Connected to 127.0.0.1 (127.0.0.1) port 80 (#0)
> GET /2021-06-10/assets/DK1_1B0890SL/attributes?AttributeCodes=HMI_Control_No&Type=last HTTP/1.1
> Host: 127.0.0.1
> User-Agent: curl/7.64.1
> Accept: */*
> 
< HTTP/1.1 200 OK
< Content-Type: application/json; charset=utf-8
< Date: Tue, 15 Jun 2021 18:22:16 GMT
< Content-Length: 174
< 
* Connection #0 to host 127.0.0.1 left intact
{"Results":[{"StatementId":0,"Series":[{"AssetCode":"DK1_1B0890SL","AttributeCode":"HMI_Control_No","Columns":["time","last","quality"],"Values":[[1623781332627,3443,0]]}]}]}* Closing connection 0

批量查询

查询多个资产的多个技术属性值。

• 请求语法

POST /2021-06-10/attributes/search

• 请求参数

{
        "Attributes": [{
                        "AssetCode": "string",
                        "AttributeCode": "string"
        }],
        "Since": "string",
        "Until": "string",
        "Type": "string",
        "Interval": "string",
        "Fill": "string",
        "OrderBy": "string",
        "Offset": number,
        "Limit": number
}

• 响应语法

HTTP/1.1 StatusCode

{
        "Results": [{
                "Series": [{
                        "AssetCode": "string",
      "AttributeCode": "string",
                        "Columns": [
                                "time",
                                "value",
        "quality"
                        ],
                        "Values": [
                                [
                                        number, // 时间戳，与Columns[0]字段对应。
                                        "string"|boolean|number, // 属性值，与Columns[1]字段对应。
          number // 质量码，与Columns[2]字段对应。
                                ]                                
                        ]
                }]
        }]
}

• 响应参数

• 示例

$ curl -v -H JWEToken:"{\"protected\":\"eyJhbGciOiJSU0EtT0F*W*W**NTYiLCJlbmMiOiJBMjU2R0NNIn0\",\"aad\":\"eyJleHAiOiIyMDIxLTAzLTI2VDE4OjU2OjM1KzA4OjAwIiwiaWF0IjoiMjAyMS0wMy0yNlQxODoyNjozNSswODowMCJ9\",\"encrypted_key\":\"Xl0ZCP62O_ZXt5OSt_lkep7aEyxoY_zGwMOr0dkZR7rVWwQ-Rj3e05gj5emxLToGUgr2cqN_N8dEz5msu9Ul0hMCa-cZGM7O3N4mZHGxc8f5LXCGf4SfTWlhvnund1orOIuKBTh3vP86PgCNTaZssqWaE2B9BQ2corVn5FVtCCVdFWadTyracOLz9r2vaChUup1XOu3UoQQ9q13b1wFhEt8tdP8NqaBcyNDzHk73Clq0V6qCtdFzJeUf9aVaI87Pq2y3Nj1UY99x03BzZ8KjaRtH6smUG1x9IZm1QTDEsHWF__dGlXIQ-STKRcWwJ-rKeCTCSC6A8qbPjbi4DFdXjQ\",\"iv\":\"2zx_4cDgzCCdNtr3\",\"ciphertext\":\"VL3v9AL1RYq40lLTZInMcCktwI2yw1L_m5x44LDtLw4txWHCkK2d90Witg\",\"tag\":\"5_Ra1Nk-GJU839EO9ujynQ\"}" -d '{"Attributes":[{"AssetCode":"DK1_1B0890SL","AttributeCode":"HMI_Control_No"}],"Type":"last"}'  http://localhost/2021-06-10/attributes/search
*   Trying 127.0.0.1...
* TCP_NODELAY set
* Connected to 127.0.0.1 (127.0.0.1) port 80 (#0)
> POST /2021-06-10/attributes/search HTTP/1.1
> Host: 127.0.0.1
> User-Agent: curl/7.64.1
> Accept: */*
> Content-Length: 92
> Content-Type: application/x-www-form-urlencoded
> 
* upload completely sent off: 92 out of 92 bytes
< HTTP/1.1 200 OK
< Content-Type: application/json; charset=utf-8
< Date: Tue, 15 Jun 2021 18:28:01 GMT
< Content-Length: 174
< 
* Connection #0 to host 127.0.0.1 left intact
{"Results":[{"StatementId":0,"Series":[{"AssetCode":"DK1_1B0890SL","AttributeCode":"HMI_Control_No","Columns":["time","last","quality"],"Values":[[1623781676342,3591,0]]}]}]}* Closing connection 0

更新

更新资产技术属性值。

• 请求语法

PATCH /2021-06-10/assets/{AssetCode}/attributes/{AttributeCode}

{
        "Value": "string"
}

• 请求参数

• 响应语法

HTTP/1.1 StatusCode

• 响应参数

• 示例

$ curl -v -H JWEToken:"{\"protected\":\"eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJ****iJBMjU2R0NNIn0\",\"aad\":\"eyJleHAiOiIyMDIxLTAzLTI2VDE4OjU2OjM1KzA4OjAwIiwiaWF0IjoiMjAyMS0wMy0yNlQxODoyNjozNSswODowMCJ9\",\"encrypted_key\":\"Xl0ZCP62O_ZXt5OSt_lkep7aEyxoY_zGwMOr0dkZR7rVWwQ-Rj3e05gj5emxLToGUgr2cqN_N8dEz5msu9Ul0hMCa-cZGM7O3N4mZHGxc8f5LXCGf4SfTWlhvnund1orOIuKBTh3vP86PgCNTaZssqWaE2B9BQ2corVn5FVtCCVdFWadTyracOLz9r2vaChUup1XOu3UoQQ9q13b1wFhEt8tdP8NqaBcyNDzHk73Clq0V6qCtdFzJeUf9aVaI87Pq2y3Nj1UY99x03BzZ8KjaRtH6smUG1x9IZm1QTDEsHWF__dGlXIQ-STKRcWwJ-rKeCTCSC6A8qbPjbi4DFdXjQ\",\"iv\":\"2zx_4cDgzCCdNtr3\",\"ciphertext\":\"VL3v9AL1RYq40lLTZInMcCktwI2yw1L_m5x44LDtLw4txWHCkK2d90Witg\",\"tag\":\"5_Ra1Nk-GJU839EO9ujynQ\"}" -d '{"Value":"3445"}' -X PATCH http://localhost/2021-06-10/assets/DK1_1B0890SL/attributes/HMI_Control_No
*   Trying 127.0.0.1...
* TCP_NODELAY set
* Connected to 127.0.0.1 (127.0.0.1) port 80 (#0)
> PATCH /2021-06-10/assets/DK1_1B0890SL/attributes/HMI_Control_No HTTP/1.1
> Host: 127.0.0.1
> User-Agent: curl/7.64.1
> Accept: */*
> Content-Length: 16
> Content-Type: application/x-www-form-urlencoded
> 
* upload completely sent off: 16 out of 16 bytes
< HTTP/1.1 200 OK
< Content-Type: application/json; charset=utf-8
< Date: Tue, 15 Jun 2021 18:35:34 GMT
< Content-Length: 0
< 
* Connection #0 to host 127.0.0.1 left intact
* Closing connection 0

告警事件

查询

查询告警事件，包含状态告警事件和资产告警事件。

• 协议：HTTP

GET /2021-06-10/alarmevents

• 请求参数

• 响应语法

HTTP/1.1 StatusCode

{
        "TotalCount": number,
        "AlarmEvents": [{
                "Id": "string",
                "SrcMsgId": "string",
                "AlarmId": "string",
                "SceneId": "string",
                "Category": "string",
                "Extras": {
                        "Title": {"zh": "string","en": "string"},
                        "Kind": {"code":"string","name":{"zh":"string","en":"string"}},
      "Type": {"code":"string","name":{"zh":"string","en":"string"}},
                        "Level": {"code":"string","name":{"zh":"string","en":"string"},"color":"string"},
                        "Content": {"zh": "string","en": "string"},
      "Custom": {}
                },
                "Status": "unhandled|handled|ignored",
                "CreatedAt": number,
                "RecoveredAt": number,
                "Handler": "string",
                "HandledAt": number,
                "HandledComment": "string",
                "Trigger": {
                        "Objects": [{
                                "AssetCode": "string",
        "AttributeCode":"string",
                        }],
                        "Meet": true | false
                }
        }]
}

• 响应参数

创建

创建告警事件。

• 请求语法

POST /2021-06-10/alarmevents

{
  "SrcMsgId": "string",
  "Category": "ASSET_EVENT",
  "Extras": {
    "Title": {"zh": "string", "en": "string"},
    "Kind": {"code":"string","name":{"zh":"string","en":"string"}},
    "Type": {"code":"string","name":{"zh":"string","en":"string"}},
    "Level": {"code":"string","name":{"zh":"string","en":"string"},"color":"string"},
    "Content": {"zh": "string", "en": "string"},
    "Custom": {} // User custom content.
  },      
  "CreatedAt": number,
  "Trigger": {
    "Objects": [{
      "AssetCode": "string"
    }],
    "Meet": true|false
  }
}

• 请求参数

• 响应语法

HTTP/1.1 StatusCode

{
  "Id": "string"
}

• 响应参数

创建-批量

批量创建告警事件

• 请求语法

POST /2021-06-10/alarmevents/bulk

[{
  "SrcMsgId": "string",
  "Category": "ASSET_EVENT",
  "Extras": {
    "Title": {"zh": "string", "en": "string"},
    "Kind": {"code":"string","name":{"zh":"string","en":"string"}},
    "Type": {"code":"string","name":{"zh":"string","en":"string"}},
    "Level": {"code":"string","name":{"zh":"string","en":"string"},"color":"string"},
    "Content": {"zh": "string", "en": "string"},
    "Custom": {} // User custom content.
  },      
  "CreatedAt": number, // required when Tirgger.Meet is true
  "RecoveredAt": number, // required when Tirgger.Meet is false
  "Trigger": {
    "Objects": [{
      "AssetCode": "string"
    }],
    "Meet": true|false
  }
}]

• 请求参数

• 响应语法

HTTP/1.1 StatusCode

{
  "Rows": number
}

• 响应参数

• 示例

## 创建告警
$ curl -v -H 'JWEToken:{"protected":"eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBM****NNIn0","aad":"eyJleHAiOiIyMDIxLTAzLTI5VDExOjE1OjE1KzA4OjAwIiwiaWF0IjoiMjAyMS0wMy0yOVQxMDo0NToxNSswODowMCJ9","encrypted_key":"u9iV1gihhcGe53JLghjLQck3xQrEDPdNd-Bb0ZZ86yOIvqwAqgLHj3Xgn7uP1HC91q8XErua6o090xFEoqpI0LDIh00Z0B9z2bhe2kHzoNhOoqRWuQdH-3oDObj7uWHw18K2RQSsK4TThfIFTTkoqAoHNfMlE_f7SWSCvbGJgcvfFXt2ilAPb33kDRliHdyxwakwNW7LslQfdtM9qaEeHlJzuVPYQ29eockNdZhMgVmsROzF1aBMwAENgg_cRDTx3pZOHGJEN8jt1WiXumKO1dWpWs6p7gbtabdQOoNRKB7Zq3_bwuyDxX468TRClPxIk9yEAdXQKQp0UbQvPNZQrw","iv":"DOsZV3ZKQGMS3APk","ciphertext":"voRtRhBf7oeU9d_dcUokNbwqiryZ4ECZObpGubs9COA_N5-qhXKRgrkHlA","tag":"bak50biL857G3T8axdpnrg"}' -d '[{"SrcMsgId":"MSG_DeviceID_030901_1","Category":"ASSET_EVENT","Extras":{"Title":{"zh":"资产告警1","en":"asset_alarm"},"Type":{"code":"alarm_code1","name":{"zh":"告警类型1","en":"alarmType1"}},"Level":{"code":"Content1","name":{"zh":"级别1","en":"Level1"},"color":"color1"},"Content":{"zh":"Content","en":"Content"},"Custom":{}},"CreatedAt":1616483961000,"Trigger":{"Objects":[{"DeviceId":"DeviceID_030901"}],"Meet":true}}]' -X POST http://127.0.0.1/2021-06-10/alarmevents/bulk

* About to connect() to 127.0.0.1 port 80 (#0)
*   Trying 127.0.0.1...
* Connected to 127.0.0.1 (127.0.0.1) port 80 (#0)
> POST /2021-06-10/alarmevents/bulk HTTP/1.1
> User-Agent: curl/7.29.0
> Host: 127.0.0.1
> Accept: */*
> Content-Length: 432
> Content-Type: application/x-www-form-urlencoded
> 
* upload completely sent off: 432 out of 432 bytes
< HTTP/1.1 200 OK
< Content-Length: 10
< Content-Type: application/json; charset=utf-8
< Date: Mon, 29 Mar 2021 02:44:08 GMT
< 
* Connection #0 to host 127.0.0.1 left intact
{"Rows":1}


## 恢复告警
$ curl -v -H 'JWEToken:{"protected":"eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2R0NNIn0","aad":"eyJleHAiOiIyMDIxLTAzLTI5VDExOjE1OjE1KzA4OjAwIiwiaWF0IjoiMjAyMS0wMy0yOVQxMDo0NToxNSswODowMCJ9","encrypted_key":"u9iV1gihhcGe53JLghjLQck3xQrEDPdNd-Bb0ZZ86yOIvqwAqgLHj3Xgn7uP1HC91q8XErua6o090xFEoqpI0LDIh00Z0B9z2bhe2kHzoNhOoqRWuQdH-3oDObj7uWHw18K2RQSsK4TThfIFTTkoqAoHNfMlE_f7SWSCvbGJgcvfFXt2ilAPb33kDRliHdyxwakwNW7LslQfdtM9qaEeHlJzuVPYQ29eockNdZhMgVmsROzF1aBMwAENgg_cRDTx3pZOHGJEN8jt1WiXumKO1dWpWs6p7gbtabdQOoNRKB7Zq3_bwuyDxX468TRClPxIk9yEAdXQKQp0UbQvPNZQrw","iv":"DOsZV3ZKQGMS3APk","ciphertext":"voRtRhBf7oeU9d_dcUokNbwqiryZ4ECZObpGubs9COA_N5-qhXKRgrkHlA","tag":"bak50biL857G3T8axdpnrg"}' -d '[{"SrcMsgId":"MSG_DeviceID_030901_1","Category":"ASSET_EVENT","RecoveredAt":1616902656000,"Trigger":{"Meet":false}}]' -X POST http://127.0.0.1/2021-06-10/alarmevents/bulk

* About to connect() to 127.0.0.1 port 80 (#0)
*   Trying 127.0.0.1...
* Connected to 127.0.0.1 (127.0.0.1) port 80 (#0)
> POST /2021-06-10/alarmevents/bulk HTTP/1.1
> User-Agent: curl/7.29.0
> Host: 127.0.0.1
> Accept: */*
> Content-Length: 116
> Content-Type: application/x-www-form-urlencoded
> 
* upload completely sent off: 116 out of 116 bytes
< HTTP/1.1 200 OK
< Content-Length: 10
< Content-Type: application/json; charset=utf-8
< Date: Mon, 29 Mar 2021 02:48:04 GMT
< 
* Connection #0 to host 127.0.0.1 left intact
{"Rows":1}

告警确认-批量

确认告警事件。

• 请求语法

POST /2021-06-10/alarmevents/handlings

{
        "Ids": ["string"],
        "Status": "string",
        "Handler": "string",
        "Comment": "string"
}

• 请求参数

• 响应语法

HTTP/1.1 StatusCode

• 响应参数

其他

查询连接和设备的映射关系

查询连接列表

• 请求语法

GET /2021-06-10/driver-conn-asset-map

• 请求参数

• 响应参数

HTTP/1.1 StatusCode

{
        "TotalCount": number,
        "Drivers": [
    {
      "Code": "string",        
      "Connections":[
        {
                                        "Code":"string",
          "Assets":[
                  {
                    "Code":"string"
            }
          }
        }
      ]
    }
  ]
}

• 示例

HTTP API错误码

表 1. 400 Bad Request状态码详细错误信息

表 2. 500 Internal Server Error状态码详细错误信息

HTTP API调用示例

CreateAuthToken

OkHttpClient client = new OkHttpClient().newBuilder().build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"Username\":\"xxx\",\"Password\":\"xxx\"}");
Request request = new Request.Builder()
  .url("http://localhost/2021-06-10/tokens")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

// Get JWEToken from body.

ListAlarmEvents

// Add JWEToken header for authentication.

OkHttpClient client = new OkHttpClient().newBuilder().build();
Request request = new Request.Builder()
  .url("http://localhost/2021-06-10/alarmevents?Size=1")
  .method("GET", null)
  .addHeader("JWEToken", "{\"protected\":\"eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJ****2R0NNIn0\",\"aad\":\"eyJleHAiOiIyMDIwLTEwLTA0VDAxOjUzOjEyKzA4OjAwIiwiaWF0IjoiMjAyMC0xMC0wNFQwMToyMzoxMiswO****CJ9\",\"encrypted_key\":\"iBqKB_50TmzNaI04RpfIi_5N_Mk_9-N9dDUFf_jkDk1qQFZSAF4_Q6mlwco2rrI6WZpZGmt4YDsyLJhMOyGpWq6mvq49gFErmH-UYQ80WJbDtlyIVWUrX3picCpUXS9StX_sAI7pO6gRIQvsFsUxvFG_04evL3EtPWrdZnnqhS0PsLjPmf7jF7u1drp6VN5Q81lFeOWnVEYlP5TqUMkD5_o2bpQoyeubWYndM2T3Ka8MPPZK-66duRTe9Jgxtn--vqwqp91EDWsuBFgwquScb488O0ev1cb3EX_vbWRaN6Nj-6egvwNimAkWcA15A3wRK6oJ****UasXB-HPjdXPdA\",\"iv\":\"OzSvzFEOn3WpDC-D\",\"ciphertext\":\"RRevInGzkL7EWjFP4gpEG6B1epaU88boFb6LMGSvsw1p4K_ozp6_jNwnQg\",\"tag\":\"WlFWpioEMoPDeM09oohuVA\"}")
  .build();
Response response = client.newCall(request).execute();