AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 事件总线 开发参考 API参考指南 API目录 事件流 GetEventStreaming - 获取一个事件流的详细信息

GetEventStreaming - 获取一个事件流的详细信息

更新时间：
产品详情
我的收藏

获取一个事件流的详细信息。

接口说明

获取一个事件流的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值
EventStreamingName

string

是

要获取信息的事件流的名称。

myeventstreaming

返回参数

名称

类型

描述

示例值

object

返回信息。

Message

string

错误信息。

The event streaming [xxxx] not existed!
RequestId

string

阿里云为该请求生成的唯一标识符。

7892F480-58C9-5067-AB35-8A7BEF****
Data

object

返回数据。

EventStreamingName

string

获取到的事件流的名称。

rocketmq-sync
Description

string

获取到的事件流的描述。

RocketMQ-to-RocketMQ
Source

object

事件提供方。

SourceMNSParameters

object

Source 轻量消息队列（原 MNS） 参数。

RegionId

string

地域 ID。

cn-hangzhou
QueueName

string

轻量消息队列（原 MNS）的 Queue 的名称。

demo
IsBase64Decode

boolean

是否开启 Base64 编码。

true
SourceRabbitMQParameters

object

Source RabbitMQ 源。

RegionId

string

地域 ID。

cn-hangzhou
InstanceId

string

消息队列 RabbitMQ 版的实例的 ID。

i-f8z9a9mcgwri1c1i****
VirtualHostName

string

消息队列 RabbitMQ 版实例的 Vhost 的名称。

eb-connect
QueueName

string

消息队列 RabbitMQ 版实例的 Queue 的名称。

comp
SourceRocketMQParameters

object

Source RocketMQ 源。

RegionId

string

消息队列 RocketMQ 版的地域 ID。

cn-hangzhou
InstanceId

string

消息队列 RocketMQ 版的实例 ID。

i-f8zbher64dlm58pl****
Topic

string

消息的 Topic。

topic_add_anima
Tag

string

消息的过滤标签

v1
Offset

string

消息的消费位点。取值说明如下： CONSUME_FROM_LAST_OFFSET：从最新位点开始消费。 CONSUME_FROM_FIRST_OFFSET：从最早位点开始消费。 CONSUME_FROM_TIMESTAMP：从指定时间点的位点开始消费。

CONSUMEFROMLASTOFFSET
GroupID

string

消息队列 RocketMQ 版的 Group ID。

GID_group1
Timestamp

integer

时间戳。仅当参数 Offset 取值为 CONSUME_FROM_TIMESTAMP 时，该参数有效。

1636597951964
InstanceType

string

实例类型。取值说明如下：

  • Cloud_4：阿里云 RocketMQ 4.0 版本实例（默认选项）

  • Cloud_5：阿里云 RocketMQ 5.0 版本实例

  • SelfBuilt：自建 Apache RocketMQ 集群

Cloud_4

InstanceEndpoint

string

实例接入点。

reg****-vpc.cn-zhangjiakou.aliyuncs.com

AuthType

string

鉴权类型。

ACL
InstanceUsername

string

实例用户名。

xxxa
InstancePassword

string

实例密码。

xxxa
InstanceVpcId

string

实例 VPC 信息。

vpc-m5e3sv4b12345****

InstanceVSwitchIds

string

实例交换机信息。

vsw-m5ev8asdc6h12****

InstanceSecurityGroupId

string

实例安全组信息。

sg-m5edtu24f12345****

InstanceNetwork

string

实例网络信息：

  • PublicNetwork

  • PrivateNetwork

PublicNetwork
BodyDataType

string

消息编码格式：

  • Json

  • Text

  • Binary

Json
FilterType

string

消息过滤类型。

Tag

FilterSql

string

sql 过滤语句。

index > 10
VpcId

string

VPC 的 ID。

vpc-m5e3sv4b12345****

VSwitchIds

string

交换机 ID。

vsw-m5ev8asdc6h12345****

SecurityGroupId

string

安全组 ID。

sg-m5edtu24f12345****

Network

string

网络类型。

  • PublicNetwork

  • PrivateNetwork

PublicNetwork
SourceRocketMQCheckpointParameters

object

Source RocketMQ Checkpoint 源

RegionId

string

地域 ID。

cn-hangzhou
InstanceType

string

实例类型。取值说明如下：

  • Cloud_4：阿里云 RocketMQ 4.0 版本实例（默认选项）

  • Cloud_5：阿里云 RocketMQ 5.0 版本实例

  • SelfBuilt：自建 Apache RocketMQ 集群

Cloud_4
InstanceId

string

实例 ID。

rmp-cn-jte3w******

Topics

array

消息 Topic。

string

消息 Topic。

opic_add_anima
SourceApacheRocketMQCheckpointParameters

object

Source RocketMQ Checkpoint 源

RegionId

string

地域 ID。

cn-hangzhou

InstanceId

string

RocketMQ 实例 ID。

MQ_INST_164901546557****_BAAN****
Topics

array

Topic 列表。

string

需要消费 Topic 列表。

["Topic_1","Topic_2"]
InstanceEndpoint

string

实例接入点。

registry-vpc.cn-hangzhou.aliyuncs.com
InstanceUsername

string

实例用户名。

admin
InstancePassword

string

实例密码。

123456
NetworkType

string

网络类型。

PrivateNetwork
VpcId

string

VPC ID。

vpc-adw1awdw*****
VSwitchId

string

交换机 ID。

vsw-dwaafds****
SecurityGroupId

string

安全组 ID。

sg-mw43*****
SourceKafkaParameters

object

Source Kafka 源。

RegionId

string

实例所在地域 id。

cn-hangzhou
InstanceId

string

实例 id。

i-bp1fbtrnqmjvgq66****
Topic

string

Topic 名称。

topic_empower_1642473600414
ConsumerGroup

string

订阅该 Topic 的消费者所对应的 Group ID。

GID_TEST
OffsetReset

string

偏移量。

latest
Network

string

网络配置 ：默认值 Default，vpc 网络是 PublicNetwork

Default
VpcId

string

VPC ID

vpc-2zehizpoendb3****
VSwitchIds

string

虚拟交换机 ID。

vsw-wz9qqeovkwjxlu9uc****
SecurityGroupId

string

安全组 ID。

sg-2vcgdxz7o1n9zapp****
ValueDataType

string

编解码参数枚举值，有 3 个枚举值，命名如下

  1. JSON：现有逻辑，bytes 按 utf8 解码成字符串，解析为 JSON。

  2. Text：bytes 按 utf8 解码成字符串，直接放入 payload。

  3. Binary：bytes 按 base64 编码成字符串，放入 payload。

Text
SourceMQTTParameters

object

Source MQTT 源

RegionId

string

地域 ID。

cn-shanghai
InstanceId

string

实例 id。

i-2ze06wqdwk0uq14k****
Topic

string

Topic 名称。

TOPIC-cainiao-pcs-wms-instock-noPrealertPrintLabel
BodyDataType

string

消息编码格式：

  • JSON

  • Text

  • Binary

JSON
SourceDTSParameters

object

Source DTS 源。

TaskId

string

任务 ID。

f86e5814-b223-482c-b768-3b873297****
BrokerUrl

string

数据订阅通道的网络地址及端口号信息。

无
Topic

string

数据订阅通道的订阅 Topic。

TP_TEST_UNDERWRITE_ISSUE
Sid

string

消费组 ID。

HD1
Username

string

消费组的账号。

admin
Password

string

消费组的账号密码。

admin****
InitCheckPoint

string

消费位点，即 SDK 客户端消费第一条数据的时间戳，格式为 Unix 时间戳。

1620962769
SourceSLSParameters

object

Source SLS 源。

Project

string

日志服务 SLS 的日志项目。

dmmzk
LogStore

string

日志服务 SLS 的日志库。

waf-logstore
ConsumerGroup

string

消费组。

无
ConsumePosition

string

起始消费位点，可以选择最早或最新位点，分别对应“begin”，“end”，也可以从指定时间开始消费，以秒为单位。

begin
RoleName

string

授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时，需满足条件：在 RAM 控制台创建服务所使用的角色时，需要选择“阿里云服务”，并且“受信服务”需要选择“事件总线”。

testRole
SourcePrometheusParameters

object

Source Prometheus 事件源。

RegionId

string

地域 id。

cn-hangzhou
ClusterId

string

集群 id。

c83555068b6******ad213f565f209

DataType

string

数据类型。

Json
Labels

string

标签。

__name__=.*

RoleName

string

任务角色名称。

test-role
ExternalLabels

string

附加到事件流中的外部标签。

{"env":"test"}
SourceCustomizedKafkaParameters

object

自定义 Kafka 事件源。

InstanceId

string

消息队列 Kafka 版的实例 ID。

r-8vb64581862c****

SourceCustomizedKafkaConnectorParameters

object

自定义连接器 Apache Kafka 事件源。

ConnectorPackageUrl

string

OSS 资源 ZIP 包下载链接。

"https://examplebucket.oss-cn-hangzhou.aliyuncs.com/testDoc/Old_Homebrew/2024-06-26%2022%3A34%3A08/opt/homebrew/homebrew/Library/Homebrew/test/support/fixtures/cask/AppWithBinary.zip?OSSAccessKeyId=ri&Expires=1725539627&Signature=rb8q3OpV2i3gZJ"
ConnectorParameters

object

连接器参数。

Name

string

连接器名称。

test-name

Config

object

连接器配置。

{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" }
WorkerParameters

object

实例配置。

{ "group.id": "connect-eb-cluster-KAFKA_CONNECTORC", "offset.storage.topic": "connect-eb-offset-KAFKA_CONNECTOR_yjqC8K5ewC", "config.storage.topic": "connect-eb-config-KAFKA_CONNECTOR_yjqC8K5ewC", "status.storage.topic": "connect-eb-status-KAFKA_CONNECTOR_yjqC8K5ewC", "consumer.group.id": "connector-eb-cluster-KAFKA_CONNECTOR_yjqC8K5ewC-mongo-sink", "bootstrap.servers": "alikafka-post:9092" }
SourceApacheKafkaParameters

object

Bootstraps

string

Topic

string

ConsumerGroup

string

OffsetReset

string

ValueDataType

string

VpcId

string

VSwitchIds

string

SecurityGroupId

string

NetworkType

string

SecurityProtocol

string

SaslMechanism

string

SaslUser

string

SaslPassword

string

SourceOSSParameters

object

Source OSS 事件源。

RoleName

string

授权事件总线 EventBridge 读取 OSS 文件的角色名称，要求该角色至少具有 OSS 的只读权限。

eventbridge_oss_role

BucketName

string

对象存储 OSS 中的存储空间名称。

bucket_abc

Prefix

string

文件路径前缀。

fun/document/

LoadMode

string

数据加载模式，single 表示单文档加载，element 表示分块加载。 取值：single/element 默认为 single。

single

LoadFormat

string

文档加载器。

TextLoader

Delimiter

string

分隔符，在分块加载模式下，以该分隔符作为文本的分块标识符，默认以换行符\n 作为分隔符。

\n

SourceOpenSourceRabbitMQParameters

object

Source 开源 RabbitMQ 源。

Endpoint

string

开源版 RabbitMQ 实例接入点。

192.168.1.100:5672
VirtualHostName

string

开源版 RabbitMQ 实例的 Vhost 的名称。

eb-connect
QueueName

string

开源版 RabbitMQ 实例的 Queue 的名称。

demo
BodyDataType

string

消息编码格式：

  • JSON

  • Text

  • Binary

Json
Username

string

用户名。

admin
Password

string

密码。

******
VpcId

string

VPC 的 ID。

vpc-bp1vllc1lnw1v657******
VSwitchIds

string

交换机 ID。

vsw-uf65zhil5oukof5******
SecurityGroupId

string

安全组 ID。

sg-2ze65razphjfz3******
NetworkType

string

网络类型：

  • 公网 ：PublicNetwork

  • 专有网络 ：PrivateNetwork

PrivateNetwork

AuthType

string

鉴权类型。

ACL
SourceEventBusParameters

object

Source Event Bus 源。

EventBusName

string

事件总线的名称。

demo
EventRuleName

string

事件规则名称。

test
SourceMySQLParameters SourceMySQLParameters

Source MySQL 源。

FilterPattern

string

事件过滤规则，如果不指定表示匹配全部事件。

无
Transforms

array<object>

Transform 相关配置。

object

云产品的 ARN，比如函数计算中函数的 ARN。

Arn

string

云产品的 ARN，比如函数计算中函数的 ARN。

acs:fc:cn-hangzhou:*****:services/demo-service.LATEST/functions/demo-func

DashScopeTransformParameters

DashScopeTransformParameters

BaiLianAgentTransformParameters

BaiLianAgentTransformParameters

Sink

object

事件目标。

SinkMNSParameters

object

轻量消息队列（原 MNS）事件目标。

QueueName

object

目标服务类型为轻量消息队列（原 MNS）。

Value

string

轻量消息队列（原 MNS）的 Queue 的名称。

MyQueue
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

无
Body

object

消息内容。

Value

string

转换前的值。

{ "key": "value" }
Form

string

转换的格式。

TEMPLATE
Template

string

模板样式。

The value of ${key} is ${value}!
IsBase64Encode

object

是否开启 Base64 编码。

Value

string

开启 Base64 编码。

true
Form

string

事件转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

无
SinkRabbitMQParameters

object

Sink Rabbitmq 的参数。

InstanceId

object

目标服务类型为消息队列 RabbitMQ 版。

Value

string

消息队列 RabbitMQ 版的实例 ID。

e5c9b727-e06c-4d7e-84d5-f8ce644e****
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

The value of ${key} is ${value}!

VirtualHostName

object

消息队列 RabbitMQ 版实例的 Vhost 的名称。

Value

string

消息队列 RabbitMQ 版实例的 Vhost 的名称。

rabbit-host

Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

无
TargetType

object

目标类型。

Value

string

目标类型。取值说明如下：

  • Exchange：Exchange 模式。

  • Queue：Queue 模式。

Exchange/Queue
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

The value of ${key} is ${value}!

Exchange

object

Exchange 模式。 仅当参数 TargetType 配置为 Exchange 时，需配置此参数。

Value

string

消息队列 RabbitMQ 版实例的 Exchange 的名称。

a_exchange
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

The value of ${key} is ${value}!

RoutingKey

object

消息的路由规则。 仅当参数 TargetType 配置为 Exchange 时，需配置此参数。

Value

string

消息的路由规则。

housekeeping
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

The value of ${key} is ${value}!

QueueName

object

Queue 模式。 仅当参数 TargetType 配置为 Queue 时，需配置此参数。

Value

string

实例的 Queue 的名称。

MyQueue
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

The value of ${key} is ${value}!

Body

object

消息内容。

Value

string

转换前的值。

{ "key": "value" }
Form

string

转换的格式。

TEMPLATE
Template

string

模板样式。

The value of ${key} is ${value}!
MessageId

object

消息 ID。

Value

string

转换前的值。

{ "key": "value" }
Form

string

转换的格式。

TEMPLATE
Template

string

模板样式。

The value of ${key} is ${value}!
Properties

object

过滤属性。

Value

string

转换前的值。

{ "key": "value" }
Form

string

转换的格式。

TEMPLATE
Template

string

模板样式。

The value of ${key} is ${value}!

SinkFcParameters

object

函数目标。

ServiceName

object

服务的名称。

Value

string

服务的名称。

myService
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

The value of ${key} is ${value}!

FunctionName

object

函数名称。

Value

string

函数名称。

mFunction
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

The value of ${key} is ${value}!

Concurrency

object

投递并发度，最小 1。

Value

string

投递并发度，最小 1。

1
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

The value of ${key} is ${value}!

Qualifier

object

服务版本。

Value

string

服务版本。

LATEST
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

The value of ${key} is ${value}!

InvocationType

object

同步或则异步。

  • Sync：同步。

  • Async：异步。

Value

string

同步或则异步。

  • Sync：同步。

  • Async：异步。

Async
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

The value of ${key} is ${value}!

Body

object

发送给函数的内容体。

Value

string

转换前的值。

{ "key": "value" }
Form

string

转换的格式：

  • ORIGINAL：完整事件

  • JSONPATH：部分事件

  • CONSTANT：常量

  • TEMPLATE：模板

详细参考：https://help.aliyun.com/zh/eventbridge/user-guide/event-transformation

TEMPLATE
Template

string

模板样式。

The value of ${key} is ${value}!

DataFormat

object

事件内容的格式转换规则。

Value

string

转换前的值。

{ "key": "value" }
Form

string

转换的格式：

  • ORIGINAL：完整事件

  • JSONPATH：部分事件

  • CONSTANT：常量

  • TEMPLATE：模板

JSONPATH
Template

string

模板样式。

$.data.key
SinkKafkaParameters

object

Sink kafak 参数。

InstanceId

object

目标服务类型为消息队列 Kafka 版。

Value

string

实例 ID。

Defaut_1283278472_s****
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

The value of ${key} is ${value}!

Topic

object

主题名称。

Value

string

主题名称。

test
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

The value of ${key} is ${value}!

Acks

object

写入 Kafka 确认模式：

  • acks=0：无需服务端的 Response、性能较高、丢数据风险较大。

  • acks=1：服务端主节点写成功即返回 Response、性能中等、丢数据风险中等、主节点宕机可能导致数据丢失；

  • acks=all：服务端主节点写成功且备节点同步成功才返回 Response、性能较差、数据较为安全、主节点和备节点都宕机才会导致数据丢失。

Value

string

写入 Kafka 确认模式：

  • acks=0：无需服务端的 Response、性能较高、丢数据风险较大。

  • acks=1：服务端主节点写成功即返回 Response、性能中等、丢数据风险中等、主节点宕机可能导致数据丢失；

  • acks=all：服务端主节点写成功且备节点同步成功才返回 Response、性能较差、数据较为安全、主节点和备节点都宕机才会导致数据丢失。

1
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

The value of ${key} is ${value}!

Key

object

消息键。

Value

string

消息键。

key
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

The value of ${key} is ${value}!

Headers

object

Kafka 消息的附加元数据。

Value

string

转换前的值。

{ "key": "value" }

Form

string

转换的格式：

  • ORIGINAL：完整事件

  • JSONPATH：部分事件

  • CONSTANT：常量

  • TEMPLATE：模板

CONSTANT
Template

string

模板样式。

The value of ${key} is ${value}!

Value

object

消息体。

Value

string

转换前的值。

{ "key": "value" }
Form

string

转换的格式。

TEMPLATE
Template

string

模板样式。

The value of ${key} is ${value}!

SinkApacheKafkaParameters

object

描述信息

Bootstraps

string

Topic

string

Acks

string

Key

object

Value

string

Form

string

Template

string

Headers

object

Value

string

Form

string

Template

string

Value

object

Value

string

Form

string

Template

string

SecurityProtocol

string

SaslMechanism

string

SaslUser

string

VpcId

object

Value

string

Form

string

Template

string

VSwitchIds

object

Value

string

Form

string

Template

string

SecurityGroupId

object

Value

string

Form

string

Template

string

NetworkType

object

Value

string

Form

string

Template

string

SaslPassword

string

SinkRocketMQParameters

object

Sink RocketMQ Parameters

InstanceId

object

目标服务类型为消息队列 RocketMQ 版。

Value

string

消息队列 RocketMQ 版的实例 ID。

MQ_INST_164901546557****_BAAN****
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

The value of ${key} is ${value}!

Topic

object

消息队列 RocketMQ 版实例的 Topic。

Value

string

消息队列 RocketMQ 版实例的 Topic 名称。

Mytopic
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

The value of ${key} is ${value}!

Body

object

消息内容。

Value

string

转换前的值。

{ "key": "value" }
Form

string

转换的格式。

TEMPLATE
Template

string

模板样式。

The value of ${key} is ${value}!

Properties

object

过滤属性。

Value

string

转换前的值。

{ "key": "value" }
Form

string

转换的格式。

TEMPLATE
Template

string

模板样式。

The value of ${key} is ${value}!

Keys

object

过滤属性。

Value

string

转换前的值。

{ "key": "value" }
Form

string

转换的格式。

TEMPLATE
Template

string

模板样式。

The value of ${key} is ${value}!
Tags

object

过滤属性。

Value

string

转换前的值。

{ "key": "value" }
Form

string

转换的格式。

TEMPLATE
Template

string

模板样式。

The value of ${key} is ${value}!
InstanceType

object

实例类型。取值说明如下：

  • Cloud_4：阿里云 RocketMQ 4.0 版本实例（默认选项）

  • Cloud_5：阿里云 RocketMQ 5.0 版本实例

  • SelfBuilt：自建 Apache RocketMQ 集群

Value

string

实例类型。取值说明如下：

  • Cloud_4：阿里云 RocketMQ 4.0 版本实例（默认选项）

  • Cloud_5：阿里云 RocketMQ 5.0 版本实例

  • SelfBuilt：自建 Apache RocketMQ 集群

Cloud_4

Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

无

无
InstanceEndpoint

object

实例接入点。

Value

string

实例接入点。

vbr-8vbsvkkbpf3vb0zef****

Form

string

转换的格式。默认为 CONSTANT。

CONSTANT

Template

string

无

无
InstanceUsername

object

实例用户名。

Value

string

实例用户名。

admin

Form

string

转换的格式。默认为 CONSTANT。

CONSTANT

Template

string

无

无
InstancePassword

object

实例密码。

Value

string

实例密码。

admin****

Form

string

转换的格式。默认为 CONSTANT。

CONSTANT

Template

string

无

无

VpcId

object

VPC 的 ID。

Value

string

VPC 的 ID。

vbr-8vb835n3zf9shwlvb****

Form

string

事件转换的格式。默认为 CONSTANT。

CONSTANT

Template

string

无

无

VSwitchIds

object

交换机 ID。

Value

string

交换机 ID。

vbr-8vb835n3zf9shwl****mp

Form

string

转换的格式。默认为 CONSTANT。

CONSTANT

Template

string

无

无

SecurityGroupId

object

安全组 ID。

Value

string

安全组 ID。

b4bf375515f6440f942e3a20c33d****

Form

string

转换的格式。默认为 CONSTANT。

CONSTANT

Template

string

无

无

Network

object

网络类型。

  • PublicNetwork

  • PrivateNetwork

Value

string

网络类型。

  • PublicNetwork

  • PrivateNetwork

PublicNetwork

Form

string

转换的格式。默认为 CONSTANT。

CONSTANT

Template

string

无

无

DeliveryOrderType

object

消息的投递顺序类型。选填，默认为并发投递。

Value

string

投递顺序类型。

  • Orderly： 顺序投递

  • Concurrently： 并发投递

Concurrently
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

无
ShardingKey

object

消息的分片健。

说明

  • DeliveryOrderType 为 Orderly 时，ShardingKey 为必填参数。

  • Source 为 RocketMQ 时，ShardingKey 允许为空，此时使用上游 BrokerName 和 QueueId 拼接得到消息 ShardingKey。

Value

string

分片健值。

order_id
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

无
SinkDorisParameters

object

QueryEndpoint

object

Value

string

Form

string

Template

string

FeHttpEndpoint

object

Value

string

Form

string

Template

string

BeHttpEndpoint

object

Value

string

Form

string

Template

string

UserName

object

Value

string

Form

string

Template

string

Password

object

Value

string

Form

string

Template

string

Database

object

Value

string

Form

string

Template

string

Table

object

Value

string

Form

string

Template

string

Body

object

Value

string

Form

string

Template

string

NetworkType

object

Value

string

Form

string

Template

string

VpcId

object

Value

string

Form

string

Template

string

VSwitchIds

object

Value

string

Form

string

Template

string

SecurityGroupId

object

Value

string

Form

string

Template

string

SinkRocketMQCheckpointParameters

object

Sink RocketMQ Checkpoint Parameters

InstanceType

string

实例类型。取值说明如下：

  • Cloud_4：阿里云 RocketMQ 4.0 版本实例

  • Cloud_5：阿里云 RocketMQ 5.0 版本实例

Cloud_4
InstanceId

string

实例 ID。

MQ_INST_164901546557****_BAAN****
Topic

object

消息队列 RocketMQ 版实例的 Topic。

Value

string

消息队列 RocketMQ 版实例的 Topic 名称。

Mytopic
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

无
Group

object

消费者组的 Group ID。

Value

string

Group ID

GID_EVENTBRIDGE_1736234******
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

无
ConsumeTimestamp

object

消息消费的时间戳。

Value

string

时间戳。

1570761026400
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

无
SinkApacheRocketMQCheckpointParameters

object

Sink Apache RocketMQ Checkpoint Parameters

Topic

object

RocketMQ 版实例的 Topic。

Value

string

RabbitMQ 版实例的 Topic 的名称。

Mytopic
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

无
Group

object

消费者组的 Group ID。

Value

string

Group ID

GID_EVENTBRIDGE_1736234******

Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

无
ConsumeTimestamp

object

消息消费的时间戳。

Value

string

时间戳。

1570761026400
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

无
InstanceEndpoint

string

实例接入点。

192.168.1.1:9876
InstanceUsername

string

认证需要的用户名。

admin
InstancePassword

string

用户名密码。

****
NetworkType

string

网络类型。

PrivateNetwork
VpcId

string

专有网络的 ID。

vpc-2zeccak5pb0j3ay******
VSwitchId

string

交换机 ID。

vsw-uf62oqt1twuevrt******
SecurityGroupId

string

安全组 ID。

sg-2ze5bmpw6adn0q******
SinkSLSParameters

object

Sink SLS Parameters

Project

object

日志服务 SLS 的日志项目。

Value

string

日志服务 SLS 的日志项目。

test-project

Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

无
LogStore

object

日志服务 SLS 的日志库。

Value

string

日志服务 SLS 的日志库。

test-logstore
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

无
Topic

object

日志所在的 topic，对应 SLS 保留字段“topic”。

Value

string

日志所在的 topic，对应 SLS 保留字段“topic”。

testTopic
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

无
Body

object

发送给 SLS 的内容。

Value

string

转换前的值。

{ "key": "value" }
Form

string

转换的格式

TEMPLATE
Template

string

模板样式。

The value of ${key} is ${value}!

RoleName

object

授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时，需满足条件：在 RAM 控制台创建服务所使用的角色时，需要选择“阿里云服务”，并且“受信服务”需要选择“事件总线”。

Value

string

授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时，需满足条件：在 RAM 控制台创建服务所使用的角色时，需要选择“阿里云服务”，并且“受信服务”需要选择“事件总线”。

testRole
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

无
ContentType

object

SLS 数据格式。可选择默认或者配置制定的键值：

  • JSON

  • KeyValue

Value

string

转换前的值。

JSON

Form

string

转换的格式。

CONSTANT

Template

string

模板样式。

无
ContentSchema

object

自定义日志的键值，仅在 ContentType 为 KeyValue 生效。每一对键值由 Key_n, Value_n 表示。

Value

string

转换前的值。

{"Key_1":{"form":"CONSTANT","value":"demoKey"},"Value_1":{"form":"JSONPATH","value":"$.data.value"}}
Form

string

模板样式。

CONSTANT

Template

string

模板样式。

无
SinkFnfParameters

object

Sink Fnf 参数。

FlowName

object

流程名称。

Value

string

流程名称。

test-streaming-fnf
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

无
ExecutionName

object

执行名称。

Value

string

执行名称。

123
Form

string

转换的格式。默认为 CONSTANT：

  • JSONPATH：部分事件 。

  • CONSTANT：常量。

  • TEMPLATE：模板 。

详细参考：https://help.aliyun.com/zh/eventbridge/user-guide/event-transformation

CONSTANT
Template

string

模板样式。

无
Input

object

执行输入信息。

Value

string

执行输入信息。

123
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

无
RoleName

object

角色配置。

Value

string

角色配置。

Al****FNF-x****
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

模板样式。

无
SinkDataHubParameters

object

Sink DataHub 参数。

Project

object

DataHub 项目名。

Value

string

DataHub 项目名。

demo-project

Form

string

转换的格式。默认为 CONSTANT。

CONSTANT

Template

string

无

无

Topic

object

DataHub Topic 名称。

Value

string

DataHub Topic 名称。

demo-topic

Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

无

无
TopicType

object

opic 类型：

  • TUPLE

  • BLOB

Value

string

topic 类型。

  • TUPLE

  • BLOB

TUPLE

Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

无

无
TopicSchema

object

TUBLE 类型，topic 内容模式。

Value

string

TUBLE 类型，topic 内容模式。

{"k1":"value1","k2":"value2"}
Form

string

转换的格式。

TEMPLATE
Template

string

模板样式。

{"k1":"${k1}","k2":"${k2}"}
Body

object

BLOB 类型，Record 内容模板。

Value

string

BLOB 类型，Record 内容模板。

无
Form

string

转换的格式。

ORIGINAL
Template

string

无

无
RoleName

object

任务角色名。

Value

string

任务角色名称。

test-role
Form

string

转换的格式。默认为 CONSTANT。

CONSTANT
Template

string

无

无
SinkCustomizedKafkaParameters

object

Sink Kafka 参数。

InstanceId

string

消息队列 Kafka 版的实例 ID。

90be1f96-4229-4535-bb76-34b4f6fb****
SinkCustomizedKafkaConnectorParameters

object

Sink Kafka 连接器参数。

ConnectorPackageUrl

string

OSS 文件下载链接。

"https://examplebucket.oss-cn-hangzhou.aliyuncs.com/testDoc/Old_Homebrew/2024-06-26%2022%3A34%3A08/opt/homebrew/homebrew/Library/Homebrew/test/support/fixtures/cask/AppWithBinary.zip?OSSAccessKeyId=ri&Expires=1725539627&Signature=rb8q3OpV******"
ConnectorParameters

object

解析当前 ZIP 包下的 properties 文件。

Name

string

连接器名称。

mongo-sink
Config

object

连接器配置。

{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" }
WorkerParameters

object

实例配置。

{ "group.id": "connect-eb-cluster-KAFKA_CONNECTORC", "offset.storage.topic": "connect-eb-offset-KAFKA_CONNECTOR_yjqC8K5ewC", "config.storage.topic": "connect-eb-config-KAFKA_CONNECTOR_yjqC8K5ewC", "status.storage.topic": "connect-eb-status-KAFKA_CONNECTOR_yjqC8K5ewC", "consumer.group.id": "connector-eb-cluster-KAFKA_CONNECTOR_yjqC8K5ewC-mongo-sink", "bootstrap.servers": "alikafka-post:9092" }
SinkDashVectorParameters

object

Sink DashVector 参数。

InstanceId

string

实例 ID。

vrs-cn-lbj3ru1***
Collection

string

Collection（集合）名称。

collection1
ApiKey

string

DashVecotor 控制台创建的 API Key。

Q34nExQH7sQ****
Operation

string

DashVector 数据库操作类型。

Upsert
Network

string

网络类型。

PublicNetwork
PrimaryKeyId

object

插入/删除记录时的主键 ID 不填写此字段时，使用随机主键 ID。

Form

string

转换的格式。

JSONPATH
Value

string

  • Form 为 JSONPATH：JSONPath 提取内容。

  • Form 为 TEMPLATE：模板变量。

注：Value 字段不允许超过 10240 个字符、

$.data.requestId
Template

string

主键 ID 模板，仅当 Form 是 TEMPLATE 时需要填写。

${ID}
Partition

object

Partition（分区），默认值为 default 分区。

Form

string

转换的格式。

CONSTANT
Value

string

  • Form 为 CONSTANT：常量值。

  • Form 为 JSONPATH：JSONPath 提取内容。

注：Value 字段不允许超过 10240 个字符。

default
Template

string

无

无
Vector

object

插入 DashVector 记录的向量。

Form

string

转换的格式。

JSONPATH
Value

string

JSONPath 提取内容。

注：Value 字段不允许超过 10240 个字符。

$.data.messageBody
Template

string

无

无
DashVectorSchemaParameters

array<object>

插入 DashVector 时表项的 Schema 字段定义，事件内容转换后结果必须是 JSON 格式。

array<object>

Name

object

Form

string

Value

string

Template

string

Type

object

Form

string

Value

string

Template

string

Value

object

Form

string

Value

string

Template

string

SinkOpenSourceRabbitMQParameters

object

Sink Open Source RabbitMQ Parameters

Endpoint

string

接入点。

192.168.1.1:9876
VirtualHostName

string

RabbitMQ 的虚拟主机名称。

vhost1
TargetType

string

消息投递的目标类型，仅当 TargetType 设置为 Exchange 时生效。

Exchange
Exchange

string

RabbitMQ 中的 Exchange 名称。

my-exchange
QueueName

string

RabbitMQ 中的队列名称，仅当 TargetType 设置为 Queue 时生效。

my-queue
Username

string

访问 RabbitMQ 实例的用户名。

admin
Password

string

访问 RabbitMQ 实例的密码。

****
VpcId

string

专有网络 ID。

vpc-uf6of9452b2pba82c ****
VSwitchIds

string

交换机 ID。

vsw-uf6of9452b2pba82c ****
SecurityGroupId

string

安全组 ID。

sg-uf6of9452b2pba82c ****
NetworkType

string

网络类型。

PublicNetwork

AuthType

string

认证类型。

ACL
RoutingKey

object

消息路由键。

Form

string

转换格式，默认为 CONSTANT。

CONSTANT
Value

string

路由键值。

{"Form": "CONSTANT", "Value": "my-routing-key"}

Template

string

模板样式。

The value of ${key} is ${value}!
Body

object

消息体内容。

Form

string

转换格式，默认为 CONSTANT。

CONSTANT
Value

string

原始数据值。

{"key": "value"}
Template

string

模板样式。

The value of ${key} is ${value}!
MessageId

object

消息的唯一标识符。

Form

string

转换格式，默认为 CONSTANT。

CONSTANT
Value

string

消息 ID 值。

12345
Template

string

模板样式。

无
Properties

object

消息的附加属性。

Form

string

转换格式，默认为 CONSTANT。

CONSTANT
Value

string

属性内容。

{"env": "prod"}
Template

string

模板样式。

The value of ${key} is ${value}!

SinkBaiLianParameters SinkBaiLianParameters

Sink BaiLian Parameters

SinkDataWorksTriggerParameters SinkDataWorksTriggerParameters

SinkHttpsParameters

SinkHttpsParameters

SinkApiDestinationParameters

SinkApiDestinationParameters

RunOptions

object

运行环境参数。

MaximumTasks

integer

并发数。

2
RetryStrategy

object

事件推送失败时的重试策略。

PushRetryStrategy

string

重试策略：BACKOFF_RETRY（退避重试）和 EXPONENTIALDECAY_RETRY（指数衰减重试）。

BACKOFF_RETRY
MaximumEventAgeInSeconds

number

最大重试时间。

512
MaximumRetryAttempts

number

最大重试次数。

2
ErrorsTolerance

string

异常容忍策略：NONE（不容忍异常）、ALL（容忍所有异常）。

ALL
DeadLetterQueue

object

是否启用死信队列。默认不启用死信队列，超过重试策略后的消息将被丢弃。

Arn

string

死信队列 ARN。

acs:ram::155020394332****:role/edskmstoecs
Network

string

死信队列的网络类型。

PrivateNetwork
VpcId

string

死信队列所在的 VPC 网络 ID。

vpc-2zehizpoendb3****
VSwitchIds

string

死信队列所在的虚拟交换机 ID。

vsw-m5ev8asdc6h12345****
SecurityGroupId

string

死信队列所在实例的安全组 ID。

sg-2vcgdxz7o1n9zapp****
BatchWindow

object

攒批窗口。

CountBasedWindow

integer

窗口中最大可容纳的事件数量。当达到此阈值，会触发窗口内的数据往下游推送。当存在多个窗口时，有一个窗口满足即触发。

100
TimeBasedWindow

integer

窗口中最大可容纳的时间范围内的事件（单位秒）。当达到此阈值，会触发窗口内的数据往下游推送。当存在多个窗口时，有一个窗口满足即触发。

10
BusinessOption

object

BusinessMode

string

MinCapacityUnitCount

integer

MaxCapacityUnitCount

integer

Throttling

integer

Status

string

获取到的事件流的状态。

RUNNING
DetailedStatus

object

详细状态。

TPS

number

每秒处理事务数。

5
DelayTime

integer

延迟时间。

3
DiffOffset

integer

差异偏移。

0
Extensions

object

扩展属性。

{ "test": "test", "test2": 1 }
Code

string

接口返回码：Success：表示成功。 其它：表示错误码。错误码详情，请参见错误码。

Success
Success

boolean

操作成功返回 true。

true

错误码

HTTP status code

错误码

错误信息

描述
403 ServiceNotEnable Service not enable

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：StartEventStreaming - 启用一个已创建或已停用的事件流下一篇：UpdateEventStreaming - 修改一个事件流