事件总线推送
更新时间:2025-03-25
接口描述
该接口用于在事件总线中推送具体事件。
请求结构
- method:POST
- 请求URL:/v1/event-bus/event/recv
请求参数
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
eventList | List<CloudEvent> | 事件总线内事件结构 | 是 | Body参数 |
CloudEvent
名称 | 类型 | 描述 | 是否必须 | 参数位置 |
---|---|---|---|---|
data | Map<String, Object> | 事件内容。JSON对象,内容由发起事件的用户或者服务决定。CloudEvents可能包含事件发生时由事件生产者给定的上下文,data中封装了这些信息。可以为空。 | 否 | 参数 |
id | String | 事件ID。标识事件的唯一值。发送端必须确保source+id是唯一的。可以为空,为空时系统自动生成。 | 否 | 参数 |
source | String | 事件源。提供事件的服务。标识事件发生的内容。 | 是 | 参数 |
specversion | String | CloudEvents协议版本。可以为空。 | 否 | 参数 |
type | String | 事件类型。描述事件源相关的事件类型。 | 是 | 参数 |
datacontenttype | String | 参数data的内容形式。datacontenttype只支持application/json格式。可以为空。 | 否 | 参数 |
subject | String | 事件主体。JSON数据包含标识事件中涉及的资源的标识。可以为空。 | 否 | 参数 |
time | String | 发生事件的时间,例如2020-11-19T21:04:41Z。默认值,系统接受到事件的时间。可以为空。 | 否 | 参数 |
resourceType | String | 云产品子类型,用户自定义事件中该值可为空。可以为空。 | 否 | 参数 |
level | EventLevel | 事件级别,用户自定义可以为空。 | 否 | 参数 |
accountId | String | 云账号ID。可以为空。默认从请求头中获取。 | 否 | 参数 |
eventBusId | String | 接收事件的事件总线Id。 | 是 | 参数 |
eventBusName | String | 接收事件的事件总线名称。可以为空。 | 否 | 参数 |
eventSourceAlias | String | 事件源的中文别称。可以为空。 | 否 | 参数 |
eventAlias | String | 事件类型的中文别称。可以为空。 | 否 | 参数 |
eventAliasEn | String | 事件类型的英文别称。可以为空。 | 否 | 参数 |
region | String | 事件的地域。可以为空。 | 否 | 参数 |
recvTimestamp | String | 接受到事件的时间戳。2020-11-19T21:04:41+08:00 | 否 | 参数 |
响应参数
名称 | 类型 | 描述 |
---|---|---|
events | List<CloudEvent> | 推送事件 |
请求示例
JSON
1{
2 "eventList": [
3 {
4 // 事件具体信息,非必填,可以用于规则匹配等。
5 "data": "{\"info\":\"系统出现异常\",\"advice\":\"请联系管理员\"}",
6 // 事件源名称,必填
7 "source": "App_DEMO",
8 // 事件名称,必填
9 "type": "DEMO_EVENT",
10 // 事件id,非必填。默认会随机生成一个字符串。
11 "id": "45ef4dewdwe1-7c35-447a-bd93-fab****",
12 // 事件发生源,非必填。默认为空
13 "subject": "qcs::dts:ap-guangzhou:appid12312/uid1250000000:xxx",
14 // 事件发生时间,非必填。默认为接受到该事件的时间
15 "time": 1615430559146,
16 // 事件发生地区,非必填。
17 "region": "bj"
18 },
19 ...
20 ],
21 "eventBusId": "eb-xxxxxx"
22}
响应示例
JSON
1{
2 "events": [
3 {
4 // 事件具体信息
5 "data": {
6 "info": "系统出现异常",
7 "advice": "请联系管理员"
8 },
9 // 事件id
10 "id": "45ef4dewdwe1-7c35-447a-bd93-fab****",
11 // 事件源名称
12 "source": "source1",
13 // 事件名称
14 "type": "DEMO_EVENT",
15 // 事件发生源
16 "subject": "qcs::dts:ap-guangzhou:appid12312/uid1250000000:xxx",
17 // 事件发生时间
18 "time": "2023-01-01T00:00:00+0800",
19 // 事件总线ID
20 "eventBusId": "bus1",
21 // 事件总线名称
22 "eventBusName": "busName1",
23 // 事件名称
24 "eventAlias": "eventAlias1",
25 // 事件名称,英文
26 "eventAliasEn": "eventAliasEn1",
27 // 地区
28 "region": "region1",
29 },
30 ...
31 ]
32}