V2.1 Get Event¶

通过 eventId 获取事件的详细信息。

如果你在使用 API 批量更新相关事件相关信息后调用当前 API，建议两次调用间隔 2 秒左右，以免获取到未更新数据。

该 API 支持在 EnOS 2.1.0 及以上环境中使用。

请求格式¶

GET https://{apigw-address}/connect-service/v2.1/events?action=get

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	资产所属的组织 ID。如何获取 orgId 信息>>
eventId	Query	必需	String	事件标识符。前往模型详情的功能定义页，在功能 ID 列获取 ID。
resolveName	Query	可选	Boolean	`true`：分解 `output` 信息，返回 `eventName` 和 `outputNames` 参数。 `false` （默认）：不分解 `output` 信息。`eventName` 和 `outputNames` 参数皆为空值。

响应参数¶

名称	数据类型	描述
data	Event 结构体	有关 Event 结构体的定义，见 Event 结构体。

Event 结构体 ¶

名称	数据类型	描述
orgId	String	资产所属的组织 ID。
eventId	String	事件 ID。前往模型详情的功能定义页，在功能 ID 列获取 ID。
productKey	String	Product Key。
deviceKey	String	Device Key。
assetId	String	资产 ID。
tslEventKey	String	TSL 模型中的事件 Key。
tslEventType	String	TSL 模型中定义的事件类型。包含信息、告警和故障。
output	String	事件的输出。
outputData	Map（Key 为 String，Value 为 Object）	事件的输出 JSON 格式。
timestamp	Long	事件发生时间戳。
localtime	String	事件发生本地时间。
eventName	StringI18n	事件的名称。结构参见国际化名称结构体。
outputNames	Map（Key 为 String，Value 为 StringI18n）	事件的输出名称。

示例¶

请求示例¶

url: https://{apigw-address}/connect-service/v2.1/events?action=get&eventId=yourEventId&orgId=yourOrgId&resolveName=true
method: GET

返回示例¶

{
  "code": 0,
  "msg": "OK",
  "requestId": "437f3075-448c-4995-9bf5-81e15382615c",
  "data": {
    "eventId": "20210323d3a7738134ae8a33f569d4fea8f4d57c",
    "orgId": "yourOrgId",
    "productKey": "yourProductKey",
    "deviceKey": "yourDeviceKey",
    "assetId": "yourAssetId",
    "tslEventKey": "yourEventKey",
    "tslEventType": "INFO",
    "output": "{\"test\":12,\"branchCurr\":[1.1,2.1,3.1],\"Power\":11.1}",
    "outputData": {
      "test": 12,
      "branchCurr": [
          1.1,
          2.1,
          3.1
      ],
      "Power": 11.1
    },
    "timestamp": 1616493875000,
    "localtime": "2021-03-23 18:04:35",
    "eventName": {
      "defaultValue": "电流阈值",
      "i18nValue": {
          "en_US": "",
          "zh_CN": ""
      }
    },
    "outputNames": {
      "test": {
        "defaultValue": "test",
        "i18nValue": {
            "en_US": "test",
            "zh_CN": "测试"
        }
      },
      "branchCurr": {
        "defaultValue": "branchCurr",
        "i18nValue": {
            "en_US": "branchCurr",
            "zh_CN": "当前分支"
        }
      },
      "Power": {
        "defaultValue": "Power",
        "i18nValue": {
            "en_US": "Power",
            "zh_CN": "电量"
        }
      }
    }
  }
}

SDK 示例¶

你可以在 Github 上获取接入服务的 SDK 示例：

Java
Python