更新时间:2022-04-16 GMT+08:00
分享

IEF系统事件上报

功能介绍

该API用于处理IEF系统事件上报。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

    POST /v1/{project_id}/edgesrv/system-events

  • 参数说明
    表1 URI参数说明

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

请求消息

表2 请求参数说明

参数名称

是否必选

参数类型

说明

data

Array of Objects

系统事件数据。具体参数内容详见表3说明。

表3 EventData参数说明

参数名称

是否必选

参数类型

说明

event_type

String

资源类型。

operation

String

资源的操作类型。

timestamp

Integer

事件产生的时间戳。

topic

String

消息发送的Topic。

name

String

资源名称。

attributes

String

资源的属性。

响应消息

表4 响应参数说明

参数名称

是否必选

参数类型

说明

is_success

Boolean

执行请求是否成功。“true”表示请求执行成功。

message

String

消息内容。

示例

  • 请求样例
    {
        "event_type": "deployment",
        "operation": "updated",
        "timestamp": 1591879887,
        "topic": "$hw/events/deployment/+/updated",
        "name": "edge-cs",
        "attributes": {}
    }
  • 响应样例
    {
        "is_success": "true",
        "message": "IEF系统事件处理成功"
    }

状态码

状态码如表5所示。

表5 状态码

状态码

描述

200

IEF 系统事件处理成功。

400

请求错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码

分享:

    相关文档

    相关产品

close