Upload Events¶
上传设备或逻辑资产事件数据。事件数据参数可以包含文件类型。
操作权限¶
需授权的资源 |
所需操作权限 |
---|---|
资产 |
Write |
请求格式¶
POST https://{integration-address}/connect-service/v2.1/integration?action=postEvent
备注
{integration-address}:消息集成服务网关地址。该信息可登陆 EnOS 管理控制台 ,在 帮助 > 环境信息 > HTTP消息集成通道 中获取。
请求参数(URI)¶
名称 |
位置(Path/Query) |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|---|
orgId |
Query |
必需 |
String |
资产所属的组织 ID。如何获取 orgId 信息>> |
请求参数(Header)¶
名称 |
必需/可选 |
数据类型 |
描述 |
---|---|---|---|
apim-accesstoken |
必需 |
String |
通过 Token 认证获取的 access token。获取方法,参见 获取 Access Token>> |
请求参数(Body)¶
Body 格式为 multipart/form-data。其中包含了多个 form-data,其中:
必须包含且仅包含一个请求报文。请求报文占用一个 form-data,其格式为 “请求报文 form-data”。请求报文 form-data 的 header 和 body 格式参见下文表格。
可以包含一个或多个文件 form-data。如果 body 中包含了文件类型数据,每个文件占用一个 form-data,文件数据格式为 “文件 form-data”。“文件 form-data” 类型的数据 header 格式见下文表格。如果事件数据不包含文件类型数据,则不需要提供文件 form-data。
名称 |
必需/可选 |
数据格式 |
描述 |
---|---|---|---|
Content-Disposition |
必需 |
Content-Disposition: form-data; name=”enos-message” |
|
名称 |
必需/可选 |
数据格式 |
描述 |
---|---|---|---|
method |
必需 |
String |
请求方法。 |
id |
必需 |
Integer |
请求消息 ID。 |
version |
必需 |
String |
版本号。 |
params |
必需 |
事件数据结构体数组 |
资产事件数据的列表,其格式见事件数据结构体表。 |
files |
body 包含文件时必需,不包含文件时可选 |
文件映射 Map |
文件与资产事件映射关系,内容为 “文件名:文件映射数据结构体” 格式的键值对,其格式见文件映射数据结构体表。 |
备注
以下非必选字段中,使用以下任意一种方法:
在请求中单独包含
assetId
以指定一个设备或一个逻辑资产在请求中单独包含
productKey
与deviceKey
以指定一个设备
名称 |
必需/可选 |
数据格式 |
描述 |
---|---|---|---|
assetId |
可选 |
String |
资产的 ID。单独使用以指定一个设备或一个逻辑资产。 |
productKey |
可选 |
String |
设备的 product key。与 |
deviceKey |
可选 |
String |
设备的 device key。与 |
time |
必需 |
Long |
事件数据的时间戳。 |
events |
必需 |
Map |
内容为 “事件 ID:参数”格式的键值对。如果参数是文件类型,其值为 |
名称 |
必需/可选 |
数据格式 |
描述 |
---|---|---|---|
featureId |
必需 |
String |
测点 ID。 |
assetId |
可选 |
String |
资产的 ID。 |
productKey |
可选 |
String |
设备的 product key。 |
deviceKey |
可选 |
String |
设备的 device key。 |
md5 |
可选 |
String |
文件 MD5。 |
originalFilename |
可选 |
String |
原始文件的名称,将在下载时返回。如果未指定,文件名为随机文件标识符。 |
fileExt |
可选 |
String |
文件后缀,如 .zip 和 .gpg。 |
fileLength |
可选 |
Long |
文件大小,单位字节。文件大小的值将以文件 form-data 的 header 里的 |
名称 |
必需/可选 |
数据格式 |
描述 |
---|---|---|---|
Content-Disposition |
必需 |
Content-Disposition: form-data; name=”enos-file”; filename=”yourFileName” |
name 为固定值,filename 为对应文件名。 |
Content-Length |
必需 |
Long |
文件大小,单位字节。 |
响应参数¶
名称 |
数据类型 |
描述 |
---|---|---|
code |
Integer |
请求返回状态值。0 表示请求成功,非 0 则表示请求失败。 |
msg |
String |
对状态码的解释和说明。请求成功为 “OK”。 |
requestId |
String |
每次请求获取的 ID,用于唯一标识一次 API 请求。 |
示例¶
请求示例¶
url: https://{integration-address}/connect-service/v2.1/integration?action=postEvent&orgId=yourOrgId
method: POST
requestHeader:
{
"apim-accesstoken":"yourAccessToken"
}
requestBody:
请求报文form-data
Content-Disposition: form-data; name="enos-message"
{
"method": "integration.event.post",
"id": "123",
"version": "1.1",
"params":[
{
"productKey": "productKey1",
"deviceKey": "deviceKey1",
"time": 1579580182824,
"events": {
"eventId1":{
"intParam1": 123,
"fileParam1":"local://filename1"
}
}
},
{
"assetId": "assetId2",
"time": 1579580182824,
"events": {
"eventId2":{
"intParam2": 123,
"fileParam2":"local://filename2"
}
}
}
],
"files": {
"filename1": {
"featureId": "eventId1",
"produckKey": "productKey1",
"deviceKey": "deviceKey1",
"originalFilename": "test.txt",
"fileExt": ".txt",
"md5": "0e202f9b67323d11df8a79b319a3d4f6"
},
"filename2": {
"featureId": "eventId2",
"assetId": "assetId2",
"md5": "aa8ea05bdbcbadfcda7300c65c40859f",
"fileLength": 1024000
}
}
}
文件form-data
Content-Disposition: form-data; name="enos-file"; filename="filename1"
Content-Length: 1024000
<文件filename1的内容>
文件form-data
Content-Disposition: form-data; name="enos-file"; filename="filename2"
Content-Length: 1024000
<文件filename2的内容>
返回示例¶
{
"code":0,
"msg":"OK",
"requestId":"0b754708-5661-482e-8a9a-bc5916326d18",
"data":{}
}
Java SDK 调用示例¶
import com.envisioniot.enos.iot_http_integration.HttpConnection;
import com.envisioniot.enos.iot_http_integration.message.IIntegrationCallback;
import com.envisioniot.enos.iot_http_integration.message.IntegrationEventPostRequest;
import com.envisioniot.enos.iot_http_integration.message.IntegrationResponse;
import com.envisioniot.enos.iot_mqtt_sdk.core.exception.EnvisionException;
import com.envisioniot.enos.sdk.data.DeviceInfo;
import com.google.common.collect.Maps;
import com.google.gson.GsonBuilder;
import java.io.File;
import java.io.IOException;
import java.util.Map;
public class EventIntegrationSample {
// EnOS Token Server URL (which is the same as the API gateway address) and HTTP Broker URL, which can be obtained from Environment Information page in EnOS Management Console
static final String TOKEN_SERVER_URL = "https://token_server_url";
static final String BROKER_URL = "http://broker_url";
// EnOS Application AccessKey and SecretKey, which can be obtain in Application Registration page in EnOS Console
static final String APP_KEY = "appKey";
static final String APP_SECRET = "appSecret";
// Device credentials, which can be obtained from Device Details page in EnOS Console
static final String ORG_ID = "orgId";
static final String ASSET_ID = "assetId";
static final String PRODUCT_KEY = "productKey";
static final String DEVICE_KEY = "deviceKey";
private static IntegrationEventPostRequest buildEventPostRequest() {
DeviceInfo deviceInfo1 = new DeviceInfo().setAssetId(ASSET_ID);
DeviceInfo deviceInfo2 = new DeviceInfo().setKey(PRODUCT_KEY, DEVICE_KEY);
// Events are defined in ThingModel
Map<String, Map<String, Object>> hashMap = Maps.newHashMap();
Map<String, Object> structMap = Maps.newHashMap();
structMap.put("struct1", new File("sample1.txt"));
structMap.put("struct2", 1234);
hashMap.put("IntEvent1", structMap);
return IntegrationEventPostRequest.builder()
.addEvent(deviceInfo1, System.currentTimeMillis(), hashMap)
.addEvent(deviceInfo2, System.currentTimeMillis(), hashMap)
.build();
}
public static void main(String[] args) {
// Construct a http connection
HttpConnection connection = new HttpConnection.Builder(
BROKER_URL, TOKEN_SERVER_URL, APP_KEY, APP_SECRET, ORG_ID)
.build();
IntegrationEventPostRequest request = buildEventPostRequest();
try {
IntegrationResponse response = connection.publish(request, (bytes, length) ->
System.out.println(String.format("Progress: %.2f %%", (float) bytes / length * 100.0)));
System.out.println(new GsonBuilder().setPrettyPrinting().create().toJson(response));
} catch (EnvisionException | IOException e) {
e.printStackTrace();
}
// Asynchronously call the event post with file
request = buildEventPostRequest();
try {
connection.publish(request, new IIntegrationCallback() {
@Override
public void onResponse(IntegrationResponse response) {
System.out.println("receive response asynchronously");
System.out.println(new GsonBuilder().setPrettyPrinting().create().toJson(response));
}
@Override
public void onFailure(Exception failure) {
failure.printStackTrace();
}
}, (bytes, length) ->
System.out.println(String.format("Progress: %.2f %%", (float) bytes / length * 100.0))
);
} catch (IOException | EnvisionException e) {
e.printStackTrace();
}
}
}