自定义事件源参数
更新时间 2025-12-29 16:45:20
最近更新时间: 2025-12-29 16:45:20
本文介绍事件源中的请求参数。
请求参数
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| eventBusName | String | 是 | test | 事件总线的名称。 |
| eventSourceName | String | 是 | source1 | 事件源的名称。 |
| desc | String | 否 | test | 事件源描述。 |
| type | String | 是 | simple | 事件源类型，更多信息请参考下文关于事件源的格式。 |
| eventSourceParams | Arrays of Object | 是 | 事件源参数，详见表 EventSourceParams，更多信息请参考下文关于事件源的格式。 |
表 EventSourceParams
| 参数 | 是否必填 | 参数类型 | 说明 |
|---|---|---|---|
| resourceKey | 是 | String | 事件源参数名。 |
| value | 是 | String | 事件源参数值。 |
| form | 是 | String | 事件源参数格式。 |
| template | 否 | String | 事件源参数模板样式。 |
分布式消息服务Kafka
当事件源的事件提供方选择分布式消息服务Kafka时，请求参数中的type为kafka，eventSourceParams中的resourceKey字段含义如下表所示：
| resourceKey | 是否必传 | form | value | template |
|---|---|---|---|---|
| instanceId | 是 | CONSTANT | 分布式消息服务Kafka实例ID。 | 无 |
| topic | 是 | CONSTANT | 主题名称。 | 无 |
| groupName | 是 | CONSTANT | 消费组名。 | 无 |
| initialOffset | 是 | CONSTANT | 消息位点。
| 无 |
| dataFormat | 否 | CONSTANT | 数据格式,不填时默认为JSON编码格式：
| 无 |
请求示例如下：
{
"eventSourceName": "source",
"eventBusName": "test",
"desc": "dddesc",
"type": "kafka",
"eventSourceParams": [
{
"resourceKey": "instanceId",
"value": "b16b04cf0776xxxxxfa31a001a5c48b6",
"form": "constant"
},
{
"resourceKey": "topic",
"value": "eb_source",
"form": "constant"
},
{
"resourceKey": "groupName",
"value": "eb-group",
"form": "constant"
},
{
"resourceKey": "initialOffset",
"value": "latest",
"form": "constant"
},
{
"resourceKey": "dataFormat",
"value": "JSON",
"form": "CONSTANT"
}
]
}分布式消息服务RocketMQ
当事件源的事件提供方选择分布式消息服务RocketMQ时，请求参数中的type为rocketmq，eventSourceParams中的resourceKey字段含义如下表所示：
| resourceKey | 是否必传 | form | value | template |
|---|---|---|---|---|
| instanceId | 是 | CONSTANT | 分布式消息服务RocketMQ实例ID。 | 无 |
| topic | 是 | CONSTANT | 主题名称。 | 无 |
| groupName | 是 | CONSTANT | 消费组名。 | 无 |
| initialOffset | 是 | CONSTANT | 消息位点。
| 无 |
| tag | 否 | CONSTANT | 消息过滤的Tag。 | 无 |
| dataFormat | 否 | CONSTANT | 数据格式,不填时默认为JSON编码格式：
| 无 |
请求示例如下：
{
"eventSourceName": "test-rocketmq",
"eventBusName": "test0723",
"desc": "",
"type": "rocketmq",
"eventSourceParams": [
{
"resourceKey": "instanceId",
"value": "89ceb110331xxxxx499744c2ccbdbcc",
"form": "CONSTANT"
},
{
"resourceKey": "topic",
"value": "TopicA",
"form": "CONSTANT"
},
{
"resourceKey": "tag",
"value": "",
"form": "CONSTANT"
},
{
"resourceKey": "groupName",
"value": "GID_EVENTBRIDGE_1753671233631",
"form": "CONSTANT"
},
{
"resourceKey": "initialOffset",
"value": "earliest",
"form": "CONSTANT"
},
{
"resourceKey": "dataFormat",
"value": "JSON",
"form": "CONSTANT"
}
]
}分布式消息服务RabbitMQ
当事件源的事件提供方选择分布式消息服务RabbitMQ时，请求参数中的type为rabbitmq，eventSourceParams中的resourceKey字段含义如下表所示：
| resourceKey | 是否必传 | form | value | template |
|---|---|---|---|---|
| instanceId | 是 | CONSTANT | 分布式消息服务RabbitMQ实例ID。 | 无 |
| vhost | 是 | CONSTANT | vhost名称。 | 无 |
| queueName | 是 | CONSTANT | 队列名。 | 无 |
请求示例如下：
{
"eventSourceName": "test",
"eventBusName": "test",
"desc": "",
"type": "rabbitmq",
"eventSourceParams": [
{
"resourceKey": "instanceId",
"value": "e8c05d2c9f44d77a703373c6737df98b",
"form": "CONSTANT"
},
{
"resourceKey": "vhost",
"value": "/",
"form": "CONSTANT"
},
{
"resourceKey": "queueName",
"value": "test1",
"form": "CONSTANT"
}
]
}分布式消息服务MQTT
当事件源的事件提供方选择分布式消息服务MQTT时，请求参数中的type为mqtt，eventSourceParams中的resourceKey字段含义如下表所示：
| resourceKey | 是否必传 | form | value | template |
|---|---|---|---|---|
| instanceId | 是 | CONSTANT | 分布式消息服务MQTT实例ID。 | 无 |
| topic | 是 | CONSTANT | 主题名称。 | 无 |
| dataFormat | 否 | CONSTANT | 数据格式,不填时默认为JSON编码格式：
| 无 |
请求示例如下：
{
"eventSourceName": "test",
"eventBusName": "test",
"desc": "desc",
"type": "mqtt",
"eventSourceParams": [
{
"resourceKey": "instanceId",
"value": "26554575ff4dxxxxxf69ee17838d11ca",
"form": "CONSTANT"
},
{
"resourceKey": "topic",
"value": "test1",
"form": "CONSTANT"
},
{
"resourceKey": "dataFormat",
"value": "JSON",
"form": "CONSTANT"
}
]
}定时触发事件源
当事件源的事件提供方选择定时触发时，请求参数中的type为schedule，eventSourceParams中的resourceKey字段含义如下表所示：
| resourceKey | 是否必传 | form | value | template |
|---|---|---|---|---|
| schedule | 是 | CONSTANT | 触发事件的Cron表达式。 | 无 |
| timezone | 是 | CONSTANT | 时区值。 | 无 |
请求示例如下：
{
"eventSourceName": "test",
"eventBusName": "test0723",
"desc": "",
"type": "schedule",
"eventSourceParams": [
{
"resourceKey": "schedule",
"value": "0/5 * * * * ?",
"form": "CONSTANT"
},
{
"resourceKey": "timezone",
"value": "GMT+00:00",
"form": "CONSTANT"
}
]
}
