调用UpdateEventStreaming接口修改事件流-事件总线-阿里云-事件总线(EventBridge)-阿里云帮助中心

修改一个事件流的基础信息、事件源信息、事件过滤模式或事件目标信息。

接口说明

修改一个事件流的基础信息、事件源信息、事件过滤模式或事件目标信息。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eventbridge:UpdateEventStreaming

update

*EventStreaming

acs:eventbridge:{#regionId}:{#accountId}:eventstreaming/{#EventStreamingName}

无

请求参数

名称	类型	必填	描述	示例值
EventStreamingName	string	是	事件流的名称。	myeventstreaming
Description	string	否	事件流的描述。	rocketmq2mns
FilterPattern	string	否	事件过滤规则，如果不指定表示匹配全部事件。具体信息，请参见https://help.aliyun.com/zh/eventbridge/user-guide/event-patterns	{ "source": [ { "prefix": "acs:mns" } ], "type": [ { "prefix": "mns:Queue" } ], "subject": [ { "prefix": "acs:mns:cn-hangzhou:123456789098****:queues/zeus" } ] }
Source	object	否	事件提供方。必须选择一种 Source，且最多只能选择一种 Source 进行填选。
SourceApacheKafkaParameters	object	否
Bootstraps	string	否
ConsumerGroup	string	否
NetworkType	string	否
OffsetReset	string	否
SaslMechanism	string	否
SaslPassword	string	否
SaslUser	string	否
SecurityGroupId	string	否
SecurityProtocol	string	否
SslKeyPassword	string	否	【加密私钥必填】Kafka 客户端私钥密码。当客户端私钥使用密码加密保护时（即 PEM 文件中包含 'Proc-Type: 4,ENCRYPTED' 或 'ENCRYPTED' 标记），需提供解密密码。若私钥未加密则留空。注意：此密码仅用于解密私钥，与 Kafka 认证无关
SslKeystoreCertificateChain	string	否	【双向认证必填】Kafka 客户端证书链。当 Kafka 服务端开启双向 SSL 认证（ssl.client.auth=required）时，需提供此参数。格式要求：Base64 编码的 PEM 格式，包含客户端证书及完整的证书链（客户端证书在前，中间 CA 证书在后，根 CA 证书可选）。注意：确保每个 PEM 文件内容的开头和结尾分别是 '-----BEGIN CERTIFICATE-----' 和 '-----END CERTIFICATE-----' ，拼接后进行 Base64 编码
SslKeystoreKey	object	否	【双向认证必填】SSL 私钥配置对象。当 Kafka 服务端开启双向 SSL 认证时，需提供客户端私钥。密钥仅支持 KMS 模式：通过 KmsArn 指定存储私钥的密钥管理服务资源，系统只在内存态从 KMS 获取私钥内容，安全性更高；配置示例：{"KmsArn": "acs:kms:cn-hangzhou:123456789:secret/ssl-key-xxxx", "KmsSecretValueKey": "keystore_private_key"}\n"
KmsArn	string	否	【必填】存储 SSL 私钥的 KMS 资源 ARN。用于定位存放客户端私钥的密钥管理服务实例。格式示例： 'acs:kms:cn-hangzhou:123456789:secret/ssl-keystore-key-xxxx'。获取方式：在 KMS 控制台查看对应密钥的 ARN 信息。
KmsSecretValueKey	string	否	【kms KV 模式】KMS 凭据中的密钥键名。当 KMS 存储的凭据为键值对（KV）结构时，填写此参数以指定 SSL 私钥对应的 key。示例：若 KMS 凭据为 '{"ssl_keystore_key":"-----BEGIN PRIVATE KEY-----...","ssl_truststore_key":"..."}'，则填写 'ssl_keystore_key'。若 KMS 凭据为纯文本模式（直接存储私钥的 PEM 内容），则留空此参数
SslTruststoreCertificates	string	否	【SSL 场景必填】Kafka 服务端信任证书。用于验证 Kafka Broker 的 SSL 证书合法性，防止中间人攻击。格式要求：Base64 编码的 PEM 格式，通常包含 Kafka 服务端的 CA 证书或服务端证书本身。示例：将 CA 证书的 PEM 文件内容（确保开头和结尾分别是 '-----BEGIN CERTIFICATE-----' 和 '-----END CERTIFICATE-----' ），进行 Base64 编码。若 Kafka 使用自签名证书，需提供签发该证书的 CA 证书
Topic	string	否
VSwitchIds	string	否
ValueDataType	string	否
VpcId	string	否
SourceApacheRocketMQCheckpointParameters	object	否	Source RocketMQ Checkpoint 源
InstanceEndpoint	string	否	Apache RocketMQ 实例的接入点。	192.168.1.1:9876
InstancePassword	string	否	Apache RocketMQ 实例的密码。	****
InstanceUsername	string	否	Apache RocketMQ 实例的用户名。	admin
NetworkType	string	否	网络类型。 PublicNetwork PrivateNetwork	PrivateNetwork
RegionId	string	否	地域 ID。	cn-hangzhou
SecurityGroupId	string	否	安全组 ID。	sg-mw43*****
Topics	array	否	Apache RocketMQ 实例 Topic。
	string	否	Apache RocketMQ 实例 Topic。	myTopic
VSwitchId	string	否	交换机 ID。	vsw-dwaafds****
VpcId	string	否	VPC ID。	vpc-adw1awdw*****
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	否	连接器参数。
Config	object	否	连接器配置。	{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" }
Name	string	否	连接器名称。	test-name
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" }
SourceCustomizedKafkaParameters	object	否	自定义 Kafka 事件源。
InstanceId	string	否	消息队列 Kafka 版的实例 ID。	r-8vb64581862c****
SourceDTSParameters	object	否	Source DTS 源
BrokerUrl	string	否	数据订阅通道的网络地址及端口号信息。
InitCheckPoint	integer	否	消费位点，即 SDK 客户端消费第一条数据的时间戳，格式为 Unix 时间戳。	1620962769
Password	string	否	消费组的账号密码。	admin
Sid	string	否	消费组 ID。	hkprdb
TaskId	string	否	任务 ID。	f86e5814-b223-482c-b768-3b873297****
Topic	string	否	数据订阅通道的订阅 Topic。	LTC_CACHE_PRD
Username	string	否	消费组的账号。	admin
SourceEventBusParameters	object	否	Source EventBus 源。
EventBusName	string	否	事件总线名称。	my-event-bus
EventRuleName	string	否	事件规则名称。	my-event-rule
SourceFeiShuDocsParameters	SourceFeiShuDocsParameters	否
SourceJDBCParameters	SourceJDBCParameters	否
SourceKafkaParameters	object	否	Source Kafka 源
ConsumerGroup	string	否	订阅该 Topic 的消费者所对应的 Group ID。	DEFAULT_GROUP
InstanceId	string	否	实例 ID。	i-8vbh4a5b9yfhgkkzm****
Network	string	否	网络配置：默认值 Default，vpc 网络是 PublicNetwork	Default
OffsetReset	string	否	偏移量。	latest
RegionId	string	否	地域 ID。	cn-zhangjiakou
SecurityGroupId	string	否	安全组 ID。	sg-uf6jcm3y5hcs7hkl****
Topic	string	否	Topic 名称。	topic_empower_1641539400786
VSwitchIds	string	否	交换机 ID。	vsw-wz9t1l1e8eu2om****
ValueDataType	string	否	编解码参数枚举值，有 3 个枚举值，命名如下 a. Json：现有逻辑，bytes 按 utf8 解码成字符串，解析为 json b. Text：bytes 按 utf8 解码成字符串，直接放入 payload c. Binary：bytes 按 base64 编码成字符串，放入 payload	Text
VpcId	string	否	专有网络 VPC 的 ID。	vpc-2ze6p0o345nykmekxt****
SourceMNSParameters	object	否	Source 轻量消息队列（原 MNS）参数。
IsBase64Decode	boolean	否	是否开启 Base64 编码。默认为 true。	true
QueueName	string	否	队列名称	queue_api_1642474203601
RegionId	string	否	地域 ID。	cn-hangzhou
SourceMQTTParameters	object	否	Source MQTT 源
BodyDataType	string	否	消息编码格式： JSON Text Binary	JSON
InstanceId	string	否	实例 ID。	i-bp1dsudbecqwt61j****
NetworkType	string	否	网络类型。
RegionId	string	否	地域 ID。	cn-shanghai
SecurityGroupId	string	否	安全组 ID。
Topic	string	否	Topic 名称。	topic_empower_1642400400779
VSwitchIds	string	否	虚拟交换机 ID。
VpcId	string	否	VPC ID。
SourceMySQLParameters	SourceMySQLParameters	否	Source MySQL 源。
SourceOSSParameters	object	否	Source Oss 事件源。
BucketName	string	否	对象存储 OSS 中的存储空间名称。	bucket_abc
Delimiter	string	否	分隔符，在分块加载模式下，以该分隔符作为文本的分块标识符，默认以换行符\n 作为分隔符。	\n
FileExtensions	array	否	OSS 对象后缀白名单，在扫描阶段过滤，仅后缀命中白名单的对象会导入知识库。支持的后缀：txt/md/markdown/html/htm/pdf/doc/docx/ppt/pptx/xls/xlsx（大小写不敏感）。不传或为空表示不按后缀过滤	["pdf","docx"]
	string	否	后缀类型	txt
LoadFormat	string	否	文档加载器。	TextLoader
LoadMode	string	否	数据加载模式，single 表示单文档加载，element 表示分块加载。取值：single/element 默认为 single。	single
Prefix	string	否	文件路径前缀。	fun/document/
RoleName	string	否	授权事件总线 EventBridge 读取 OSS 文件的角色名称，要求该角色至少具有 oss 的只读权限。	eventbridge_oss_role
SourceOpenSourceRabbitMQParameters	object	否	Source Open Source RabbitMQ 源。
AuthType	string	否	鉴权类型。	ACL
BodyDataType	string	否	消息体数据类型。	Json
Endpoint	string	否	实例接入点。	192.168.1.1:9876
NetworkType	string	否	网络类型。 PublicNetwork PrivateNetwork	PrivateNetwork
Password	string	否	连接开源 RabbitMQ 实例时使用的密码。	****
QueueName	string	否	开源 RabbitMQ 实例的队列名称。	demo
SecurityGroupId	string	否	安全组 ID。	sg-m5edtu24f12345****
Username	string	否	连接开源 RabbitMQ 实例时使用的用户名。	admin
VSwitchIds	string	否	交换机 ID。	vsw-m5ev8asdc6h12345****
VirtualHostName	string	否	开源 RabbitMQ 实例的虚拟主机名称。	Vhost1
VpcId	string	否	VPC ID。	vpc-m5e3sv4b12345****
SourcePostgreSQLParameters	SourcePostgreSQLParameters	否
SourcePrometheusParameters	object	否	Source Prometheus 事件源
ClusterId	string	否	集群 id。	c83555068b6******ad213f565f209
DataType	string	否	数据类型。	Json
ExternalLabels	string	否	附加到事件流中的外部标签。	{"env":"test"}
Labels	string	否	标签。	__name__=.*
RegionId	string	否	实例所在地域 id。	cn-hangzhou
RoleName	string	否	任务角色名称。	test-role
SourceRabbitMQMetaParameters	SourceRabbitMQMetaParameters	否
SourceRabbitMQMsgSyncParameters	SourceRabbitMQMsgSyncParameters	否
SourceRabbitMQParameters	object	否	Source RabbitMQ 源
InstanceId	string	否	消息队列 RabbitMQ 版的实例的 ID。	i-f8z9lqkldlb4oxsxwwub
QueueName	string	否	消息队列 RabbitMQ 版实例的 Queue 的名称。	demo
RegionId	string	否	地域 ID。	cn-hangzhou
VirtualHostName	string	否	消息队列 RabbitMQ 版实例的 Vhost 的名称。	eb-connect
SourceRocketMQCheckpointParameters	object	否	Source RocketMQ Checkpoint 源
InstanceId	string	否	消息队列 RocketMQ 版实例 ID。	rmq-cn-jte3w******
InstanceType	string	否	消息队列 RocketMQ 版实例的类型。	Cloud_5
RegionId	string	否	地域 ID。	cn-hangzhou
Topics	array	否	消息队列 RocketMQ 版实例 Topic。
	string	否	消息队列 RocketMQ 版实例 Topic。	myTopic
SourceRocketMQParameters	object	否	Source RocketMQ 源
AuthType	string	否	鉴权类型。	ACL
BodyDataType	string	否	消息编码格式： Json Text Binary	Json
FilterSql	string	否	sql 过滤语句。	index > 10
FilterType	string	否	消息过滤类型。	Tag
GroupID	string	否	消息队列 RocketMQ 版的 Group ID。	GID_test
InstanceEndpoint	string	否	实例接入点	reg****-vpc.cn-zhangjiakou.aliyuncs.com
InstanceId	string	否	消息队列 RocketMQ 版的实例 ID。	i-f8z9a9mcgwri1c1id****
InstanceNetwork	string	否	实例网络信息： PublicNetwork PrivateNetwork	PublicNetwork
InstancePassword	string	否	实例密码。	admin
InstanceSecurityGroupId	string	否	实例安全组信息。	sg-m5edtu24f12345****
InstanceType	string	否	实例类型。 Cloud_4（默认值）：阿里云 RocketMQ 4.0 实例 Cloud_5：阿里云 RocketMQ 5.0 实例 SelfBuilt：自建 Apache RocketMQ 实例	Cloud_5
InstanceUsername	string	否	实例用户名。	admin
InstanceVSwitchIds	string	否	实例交换机信息。	vsw-m5ev8asdc6h12****
InstanceVpcId	string	否	实例 VPC 信息。	vpc-m5e3sv4b12345****
Network	string	否	网络类型。 PublicNetwork PrivateNetwork	PublicNetwork
Offset	string	否	消息的消费位点。取值说明如下： CONSUMEFROMLASTOFFSET：从最新位点开始消费。 CONSUMEFROMFIRSTOFFSET：从最早位点开始消费。 CONSUMEFROMTIMESTAMP：从指定时间点的位点开始消费。默认值：CONSUMEFROMLAST_OFFSET。	CONSUMEFROMLASTOFFSET
RegionId	string	否	消息队列 RocketMQ 版的地域 ID。	cn-shanghai
SecurityGroupId	string	否	安全组 ID。	sg-m5edtu24f12345****
Tag	string	否	消息的过滤标签。	test
Timestamp	integer	否	时间戳。仅当参数 Offset 取值为 CONSUMEFROMTIMESTAMP 时，该参数有效。	1670656652009
Topic	string	否	topic 名称。	TOPIC-cainiao-pcs-order-process-inBoundConditionCheck
VSwitchIds	string	否	交换机 ID。	vsw-m5ev8asdc6h12345****
VpcId	string	否	实例 VPC ID。	vpc-m5e3sv4b12345****
SourceSLSParameters	object	否	Source SLS 源
RoleName	string	否	授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时，需满足条件：在 RAM 控制台创建服务所使用的角色时，需要选择“阿里云服务”，并且“受信服务”需要选择“事件总线”。	testRole
Metadata	string	否	事件提供方通用 JSON 配置（与 Source 二选一）
Sink	object	否	事件目标。必须选择一种 Sink，且最多只能选择一种 Sink 进行填选。
SinkAgentRunParameters	SinkAgentRunParameters	否
SinkApacheKafkaParameters	object	否	描述信息
Acks	string	否
Bootstraps	string	否
CompressionType	string	否
DynamicTopic	object	否	指定消息路由的目标 Topic 策略。若同时指定了 Topic 参数和 DynamicTopic 参数，以 DynamicTopic 参数的值为准。支持以下两种配置模式： 1. 静态常量模式：直接填写固定的 Topic 名称字符串（例如："order_created"）。所有消息将统一发送至该 Topic。 2. 动态提取模式：填写标准的 JSONPath 表达式（例如："$.user.id" 或 "$.metadata.category"）。系统将解析上游消息体，提取匹配字段的值作为目标 Topic 名称。
Form	string	否	转换的类型 CONSTANT：固定值 JSONPATH：根据路径从上游提取
Template	string	否	模板
Value	string	否	值
Headers	object	否
Form	string	否
Template	string	否
Value	string	否
Key	object	否
Form	string	否
Template	string	否
Value	string	否
NetworkType	object	否
Form	string	否
Template	string	否
Value	string	否
SaslMechanism	string	否
SaslPassword	string	否
SaslUser	string	否
SecurityGroupId	object	否
Form	string	否
Template	string	否
Value	string	否
SecurityProtocol	string	否
SslKeyPassword	string	否	【加密私钥必填】Kafka 客户端私钥密码。当客户端私钥使用密码加密保护时（即 PEM 文件中包含 'Proc-Type: 4,ENCRYPTED' 或 'ENCRYPTED' 标记），需提供解密密码。若私钥未加密则留空。注意：此密码仅用于解密私钥，与 Kafka 认证无关
SslKeystoreCertificateChain	string	否	【双向认证必填】Kafka 客户端证书链。当 Kafka 服务端开启双向 SSL 认证（ssl.client.auth=required）时，需提供此参数。格式要求：Base64 编码的 PEM 格式，包含客户端证书及完整的证书链（客户端证书在前，中间 CA 证书在后，根 CA 证书可选）。注意：确保每个 PEM 文件内容的开头和结尾分别是 '-----BEGIN CERTIFICATE-----' 和 '-----END CERTIFICATE-----' ，拼接后进行 Base64 编码
SslKeystoreKey	object	否	【双向认证必填】SSL 私钥配置对象。当 Kafka 服务端开启双向 SSL 认证时，需提供客户端私钥。密钥仅支持 KMS 模式：通过 KmsArn 指定存储私钥的密钥管理服务资源，系统只在内存态从 KMS 获取私钥内容，安全性更高；配置示例：{"KmsArn": "acs:kms:cn-hangzhou:123456789:secret/ssl-key-xxxx", "KmsSecretValueKey": "keystore_private_key"}\n"
KmsArn	string	否	【必填】存储 SSL 私钥的 KMS 资源 ARN。用于定位存放客户端私钥的密钥管理服务实例。格式示例： 'acs:kms:cn-hangzhou:123456789:secret/ssl-keystore-key-xxxx'。获取方式：在 KMS 控制台查看对应密钥的 ARN 信息。
KmsSecretValueKey	string	否	【kms KV 模式】KMS 凭据中的密钥键名。当 KMS 存储的凭据为键值对（KV）结构时，填写此参数以指定 SSL 私钥对应的 key。示例：若 KMS 凭据为 '{"ssl_keystore_key":"-----BEGIN PRIVATE KEY-----...","ssl_truststore_key":"..."}'，则填写 'ssl_keystore_key'。若 KMS 凭据为纯文本模式（直接存储私钥的 PEM 内容），则留空此参数
SslTruststoreCertificates	string	否	【SSL 场景必填】Kafka 服务端信任证书。用于验证 Kafka Broker 的 SSL 证书合法性，防止中间人攻击。格式要求：Base64 编码的 PEM 格式，通常包含 Kafka 服务端的 CA 证书或服务端证书本身。示例：将 CA 证书的 PEM 文件内容（确保开头和结尾分别是 '-----BEGIN CERTIFICATE-----' 和 '-----END CERTIFICATE-----' ），进行 Base64 编码。若 Kafka 使用自签名证书，需提供签发该证书的 CA 证书
Topic	string	否
VSwitchIds	object	否
Form	string	否
Template	string	否
Value	string	否
Value	object	否
Form	string	否
Template	string	否
Value	string	否
VpcId	object	否
Form	string	否
Template	string	否
Value	string	否
SinkApacheRocketMQCheckpointParameters	object	否	Sink Apache RocketMQ Checkpoint Parameters
ConsumeTimestamp	object	否	消息消费的时间戳。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	模板样式。
Value	string	否	时间戳。	1570761026400
Group	object	否	消费者组的 Group ID。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	模板样式。
Value	string	否	Group ID	GID_EVENTBRIDGE_1736234******
InstanceEndpoint	string	否	实例接入点。	192.168.1.1:9876
InstancePassword	string	否	用户名密码。	****
InstanceUsername	string	否	认证需要的用户名。	admin
NetworkType	string	否	网络类型。 PublicNetwork PrivateNetwork	PrivateNetwork
SecurityGroupId	string	否	安全组 ID。	sg-2ze5bmpw6adn0q******
Topic	object	否	RocketMQ 实例的 Topic。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	模板样式。
Value	string	否	RocketMQ 实例的 Topic 的名称。	Mytopic
VSwitchId	string	否	交换机 ID。	vsw-uf62oqt1twuevrt******
VpcId	string	否	专有网络的 ID。	vpc-2zeccak5pb0j3ay******
SinkApiDestinationParameters	SinkApiDestinationParameters	否	ApiDestination 目标参数
SinkBaiLianParameters	SinkBaiLianParameters	否	Sink BaiLian Parameters
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=rb8q3OpV2i3gZJ"
ConnectorParameters	object	否	解析当前 ZIP 包下的 properties 文件。
Config	object	否	连接器配置。	{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" }
Name	string	否	连接器名称。	mongo-sink
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" }
SinkCustomizedKafkaParameters	object	否	Sink Kafka 参数。
InstanceId	string	否	消息队列 Kafka 版的实例 ID。	90be1f96-4229-4535-bb76-34b4f6fb2b71
SinkDashVectorParameters	object	否	Sink DashVector 参数。
ApiKey	string	否	DashVecotor 控制台创建的 API Key。	Q34nExQH7sQ****
Collection	string	否	Collection（集合）名称。	collection1
DashVectorSchemaParameters	array<object>	否	插入 DashVector 时表项的 Schema 字段定义，事件内容转换后结果必须是 Json 格式。
	array<object>	否
Name	object	否
Form	string	否
Template	string	否
Value	string	否
Type	object	否
Form	string	否
Template	string	否
Value	string	否
Value	object	否
Form	string	否
Template	string	否
Value	string	否
InstanceId	string	否	实例 ID。	vrs-cn-lbj3ru1***
Network	string	否	网络类型。 PrivateNetwork PublicNetwork	PublicNetwork
Operation	string	否	DashVector 数据库操作类型。 Delete Upsert	Upsert
Partition	object	否	Partition（分区），默认值为 default 分区。
Form	string	否	转换的格式： JSONPATH CONSTANT	CONSTANT
Template	string	否	无
Value	string	否	Form 为 CONSTANT：常量值 Form 为 JSONPATH：JSONPath 提取内容说明 Value 字段不允许超过 10240 个字符。	default
PrimaryKeyId	object	否	插入/删除记录时的主键 ID 不填写此字段时，使用随机主键 ID。
Form	string	否	转换的格式： JSONPATH TEMPLATE	JSONPATH
Template	string	否	主键 ID 模板，仅当 Form 是 TEMPLATE 时需要填写。	${ID}
Value	string	否	Form 为 JSONPATH：JSONPath 提取内容 Form 为 TEMPLATE：模板变量说明 Value 字段不允许超过 10240 个字符	$.data.requestId
Vector	object	否	插入 DashVector 记录的向量。
Form	string	否	转换的格式。	JSONPATH
Template	string	否	无
Value	string	否	JSONPath 提取内容。说明 Value 字段不允许超过 10240 个字符。	$.data.messageBody
SinkDataHubParameters	object	否	Sink DataHub 参数。
Body	object	否	BLOB 类型，Record 内容模板。
Form	string	否	转换的格式。	ORIGINAL
Template	string	否	无
Value	string	否	BLOB 类型，Record 内容模板。
ContentSchema	object	否	自定义日志的键值，仅在 ContentType 为 KeyValue 生效。每一对键值由 Key_n, Value_n 表示。
Form	string	否	模板样式。	CONSTANT
Template	string	否	模板样式。
Value	string	否	转换前的值。	{"Key_1":{"form":"CONSTANT","value":"demoKey"},"Value_1":{"form":"JSONPATH","value":"$.data.value"}}
ContentType	object	否	数据格式。可选择默认或者配置制定的键值： JSON KeyValue
Form	string	否	转换的格式。	CONSTANT
Template	string	否	模板样式。
Value	string	否	转换前的值。	JSON
Project	object	否	DataHub 项目名。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	DataHub 项目名。	demo-project
RoleName	object	否	任务角色名。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	任务角色名称。	test-role
Topic	object	否	DataHub Topic 名称。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	DataHub Topic 名称。	demo-topic
TopicSchema	object	否	TUBLE 类型，topic 内容模式。
Form	string	否	转换的格式。	TEMPLATE
Template	string	否	模板样式。	{"k1":"${k1}","k2":"${k2}"}
Value	string	否	TUBLE 类型，topic 内容模式。	{"k1":"value1","k2":"value2"}
TopicType	object	否	topic 类型。 TUPLE BLOB
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	topic 类型。 TUPLE BLOB	TUPLE
SinkDataWorksTriggerParameters	SinkDataWorksTriggerParameters	否
SinkDorisParameters	object	否	事件源类型
BeHttpEndpoint	object	否
Form	string	否
Template	string	否
Value	string	否
Body	object	否
Form	string	否
Template	string	否
Value	string	否
Database	object	否
Form	string	否
Template	string	否
Value	string	否
FeHttpEndpoint	object	否
Form	string	否
Template	string	否
Value	string	否
NetworkType	object	否
Form	string	否
Template	string	否
Value	string	否
Password	object	否
Form	string	否
Template	string	否
Value	string	否
QueryEndpoint	object	否
Form	string	否
Template	string	否
Value	string	否
SecurityGroupId	object	否
Form	string	否
Template	string	否
Value	string	否
Table	object	否
Form	string	否
Template	string	否
Value	string	否
UserName	object	否
Form	string	否
Template	string	否
Value	string	否
VSwitchIds	object	否
Form	string	否
Template	string	否
Value	string	否
VpcId	object	否
Form	string	否
Template	string	否
Value	string	否
SinkEventHouseParameters	object	否	事件目标名称
CatalogName	string	否	catalog 名称	demo
EventTableName	string	否	目标表的名称	demo-table
MappingRules	array<object>	否	字段映射规则
	array<object>	否	字段映射规则
ColumnName	string	否	列名称	age
ColumnType	string	否	列的类型	text
ColumnValue	object	否	列值的提取规则
Form	string	否	转换的方式，如 JSONPATH	JSONPATH
Template	string	否	模板配置	The value of ${key} is ${value}!
Value	string	否	提取路径，如$.data.value.name	$.data.value
NamespaceName	string	否	目标表的命名空间	name1
SinkFcParameters	object	否	函数目标。
Body	object	否	发送给函数的内容体。
Form	string	否	转换的格式。	TEMPLATE
Template	string	否	模板样式。	The value of ${key} is ${value}!
Value	string	否	转换前的值。	{ "key": "value" }
Concurrency	object	否	投递并发度，最小 1。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	投递并发度，最小 1。	1
DataFormat	object	否	事件内容的格式转换规则。
Form	string	否	转换的格式： ORIGINAL：完整事件 JSONPATH：部分事件 CONSTANT：常量 TEMPLATE：模板	JSONPATH
Template	string	否	模板样式。	$.data.key
Value	string	否	转换前的值。	{ "key": "value" }
FunctionName	object	否	函数名称。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	函数名称。	mFunction
InvocationType	object	否	同步或则异步。 Sync：同步。 Async：异步。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	调用类型。	Async
Qualifier	object	否	函数所属服务的别名。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	函数所属服务的别名。	LATEST
ServiceName	object	否	服务的名称。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	服务的名称。	myService
SinkFnfParameters	object	否	Sink Fnf 参数
ExecutionName	object	否	执行名称
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	模板样式。
Value	string	否	执行名称	123
FlowName	object	否	流程名称
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	模板样式。
Value	string	否	流程名称	test-streaming-fnf
Input	object	否	执行输入信息
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	模板样式。
Value	string	否	执行输入信息	123
RoleName	object	否	角色配置
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	模板样式。
Value	string	否	角色配置	Al**FNF-x**
SinkHttpsParameters	SinkHttpsParameters	否	Https 目标参数
SinkKafkaParameters	object	否	Sink kafak 参数
Acks	object	否	写入 Kafka 确认模式： acks=0：无需服务端的 Response、性能较高、丢数据风险较大。 acks=1：服务端主节点写成功即返回 Response、性能中等、丢数据风险中等、主节点宕机可能导致数据丢失； acks=all：服务端主节点写成功且备节点同步成功才返回 Response、性能较差、数据较为安全、主节点和备节点都宕机才会导致数据丢失。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	写入 Kafka 确认模式： acks=0：无需服务端的 Response、性能较高、丢数据风险较大。 acks=1：服务端主节点写成功即返回 Response、性能中等、丢数据风险中等、主节点宕机可能导致数据丢失； acks=all：服务端主节点写成功且备节点同步成功才返回 Response、性能较差、数据较为安全、主节点和备节点都宕机才会导致数据丢失。	1
CompressionType	string	否
DynamicTopic	object	否	指定消息路由的目标 Topic 策略。若同时指定了 Topic 参数和 DynamicTopic 参数，以 DynamicTopic 参数的值为准。支持以下两种配置模式： 1. 静态常量模式：直接填写固定的 Topic 名称字符串（例如："order_created"）。所有消息将统一发送至该 Topic。 2. 动态提取模式：填写标准的 JSONPath 表达式（例如："$.user.id" 或 "$.metadata.category"）。系统将解析上游消息体，提取匹配字段的值作为目标 Topic 名称。
Form	string	否	转换的类型 CONSTANT：固定值 JSONPATH：根据路径从上游提取
Template	string	否	模板
Value	string	否	值
Headers	object	否	Kafka 消息的附加元数据。
Form	string	否	转换的格式： ORIGINAL：完整事件 JSONPATH：部分事件 CONSTANT：常量 TEMPLATE：模板	CONSTANT
Template	string	否	模板样式。	The value of ${key} is ${value}!
Value	string	否	转换前的值。	{ "key": "value" }
InstanceId	object	否	目标服务类型为消息队列 Kafka 版。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	实例 ID。	Defaut_1283278472_s****
Key	object	否	消息的标识。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	消息的标识。	key
Topic	object	否	主题名称。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	主题名称。	test
Value	object	否	消息体内容。
Form	string	否	转换的格式。	TEMPLATE
Template	string	否	模板样式。	The value of ${key} is ${value}!
Value	string	否	转换前的值。	{ "key": "value" }
SinkKnowledgeBaseParameters	SinkKnowledgeBaseParameters	否	事件流投递到 EventHouse 知识库的目标端参数，仅 Sink 类型为知识库时传入
SinkMNSParameters	object	否	轻量消息队列（原 MNS）事件目标。
Body	object	否	消息内容。
Form	string	否	转换的格式。	TEMPLATE
Template	string	否	模板样式。	The value of ${key} is ${value}!
Value	string	否	转换前的值。	{ "key": "value" }
IsBase64Encode	object	否	是否开启 Base64 编码。
Form	string	否	事件转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	开启 Base64 编码。	true
QueueName	object	否	目标服务类型为轻量消息队列（原 MNS）。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	轻量消息队列（原 MNS）的 Queue 的名称。	MyQueue
SinkMQTTParameters	SinkMQTTParameters	否
SinkOSSParameters	SinkOSSParameters	否
SinkOpenSourceRabbitMQParameters	object	否	Sink Open Source RabbitMQ Parameters
AuthType	string	否	认证类型： ACL 无需配置	ACL
Body	object	否	消息体内容。
Form	string	否	转换格式，默认为 CONSTANT。	CONSTANT
Template	string	否	模板样式。	The value of ${key} is ${value}!
Value	string	否	原始数据值。	{"key": "value"}
Endpoint	string	否	接入点。	192.168.1.1:9876
Exchange	string	否	RabbitMQ 中的 Exchange 名称，当 TargetType 设置为 Exchange 时生效。	my-exchange
MessageId	object	否	消息的唯一标识符。
Form	string	否	转换格式，默认为 CONSTANT。	CONSTANT
Template	string	否	模板样式。
Value	string	否	消息 ID 值。	12345
NetworkType	string	否	网络类型。 PrivateNetwork PublicNetwork	PublicNetwork
Password	string	否	访问 RabbitMQ 实例的密码。	****
Properties	object	否	消息的附加属性。
Form	string	否	转换格式，默认为 CONSTANT。	CONSTANT
Template	string	否	模板样式。	The value of ${key} is ${value}!
Value	string	否	属性内容。	{"env": "prod"}
QueueName	string	否	RabbitMQ 中的队列名称，仅当 TargetType 设置为 Queue 时生效。	my-queue
RoutingKey	object	否	消息路由键。
Form	string	否	转换格式，默认为 CONSTANT。	CONSTANT
Template	string	否	模板样式。	The value of ${key} is ${value}!
Value	string	否	路由键值。	{"Form": "CONSTANT", "Value": "my-routing-key"}
SecurityGroupId	string	否	安全组 ID。	sg-uf6of9452b2pba82c ****
TargetType	string	否	消息投递的目标类型。 Exchange：消息通过交换机进行路由。 Queue：消息直接投递到指定队列。	Exchange
Username	string	否	访问 RabbitMQ 实例的用户名。	admin
VSwitchIds	string	否	交换机 ID。	vsw-uf6of9452b2pba82c ****
VirtualHostName	string	否	RabbitMQ 的虚拟主机名称。	Vhost1
VpcId	string	否	专有网络 ID。	vpc-uf6of9452b2pba82c ****
SinkPrometheusParameters	object	否	Sink Prometheus 参数
AuthorizationType	object	否	鉴权方式
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	鉴权方式	BASIC_AUTH
Data	object	否	指标内容
Form	string	否	转换的格式。默认为 JSONPATH。	JSONPATH
Template	string	否	无
Value	string	否	指标内容	$.data
HeaderParameters	object	否	请求头的参数数据结构。
Form	string	否	转换的格式。枚举值： JSONPATH：JSONPATH。 CONSTANT：CONSTANT。 TEMPLATE：TEMPLATE。	TEMPLATE
Template	string	否	Http 请求头模板样式，当 Form 是 TEMPLATE 时填写，事件内容转换后结果必须是 Json 格式。	{ "user_name":"${name}" }
Value	string	否	Form 为 CONSTANT：常量值 Form 为 JSONPATH：JSONPath 提取内容 Form 为 TEMPLATE：模板变量注：Value 字段不允许超过 10240 个字符	name
NetworkType	object	否	网络类型
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	网络类型： PublicNetwork PrivateNetwork	PrivateNetwork
Password	object	否	密码
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	密码	abc
SecurityGroupId	object	否	安全组 ID。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	安全组 ID。	sg-mw43*****
URL	object	否	Prometheus Remote Write URL 地址
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	Prometheus Remote Write URL 地址	https://cn-hangzhou.arms.aliyuncs.com/prometheus/167275**/c5b7faeb2e8994641***d5c559f/cn-hangzhou/api/v3/write
Username	object	否	用户名
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	用户名	***admin
VSwitchId	object	否	交换机 Id
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	交换机 Id	vsw-dwaafds****
VpcId	object	否	VPC ID。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	VPC ID。	vpc-adw1awdw*****
SinkRabbitMQMetaParameters	SinkRabbitMQMetaParameters	否
SinkRabbitMQMsgSyncParameters	SinkRabbitMQMsgSyncParameters	否
SinkRabbitMQParameters	object	否	Sink Rabbitmq 的参数。
Body	object	否	消息内容。
Form	string	否	转换的格式。	TEMPLATE
Template	string	否	模板样式。	The value of ${key} is ${value}!
Value	string	否	转换前的值。	{ "key": "value" }
Exchange	object	否	Exchange 模式。仅当参数 TargetType 配置为 Exchange 时，需配置此参数。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	消息队列 RabbitMQ 版实例的 Exchange 的名称。	a_exchange
InstanceId	object	否	目标服务类型为消息队列 RabbitMQ 版。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	消息队列 RabbitMQ 版的实例 ID。	amqp-cn-2r42e73o****
MessageId	object	否	消息 ID。
Form	string	否	转换的格式。	TEMPLATE
Template	string	否	模板样式。	The value of ${key} is ${value}!
Value	string	否	转换前的值。	{ "key": "value" }
Properties	object	否	过滤属性。
Form	string	否	转换的格式。	TEMPLATE
Template	string	否	模板样式。	The value of ${key} is ${value}!
Value	string	否	转换前的值。	{ "key": "value" }
QueueName	object	否	Queue 模式。仅当参数 TargetType 配置为 Queue 时，需配置此参数。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	实例的 Queue 的名称。	MyQueue
RoutingKey	object	否	消息的路由规则。仅当参数 TargetType 配置为 Exchange 时，需配置此参数。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	消息的路由规则。	housekeeping
TargetType	object	否	目标类型。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	目标类型。取值说明如下： Exchange：Exchange 模式。 Queue：Queue 模式。	Exchange/Queue
VirtualHostName	object	否	消息队列 RabbitMQ 版实例的 Vhost 的名称。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	消息队列 RabbitMQ 版实例的 Vhost 的名称。	rabbit-host
SinkRocketMQCheckpointParameters	object	否	Sink RocketMQ Checkpoint Parameters
ConsumeTimestamp	object	否	消息消费的时间戳。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	模板样式。
Value	string	否	时间戳。	1570761026400
Group	object	否	消费者组的 Group ID。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	模板样式。
Value	string	否	Group ID	GID_EVENTBRIDGE_1736234******
InstanceId	string	否	实例 ID。	MQ_INST_164901546557**_BAAN**
InstanceType	string	否	实例类型。取值说明如下： Cloud_4：阿里云 RocketMQ 4.0 版本实例 Cloud_5：阿里云 RocketMQ 5.0 版本实例	Cloud_4
Topic	object	否	消息队列 RocketMQ 版实例的 Topic。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	模板样式。
Value	string	否	消息队列 RocketMQ 版实例的 Topic 名称。	Mytopic
SinkRocketMQParameters	object	否	Sink RocketMQ Parameters
Body	object	否	消息内容。
Form	string	否	转换的格式。	TEMPLATE
Template	string	否	模板样式。	The value of ${key} is ${value}!
Value	string	否	转换前的值。	{ "key": "value" }
DeliveryOrderType	object	否	消息的投递顺序类型。选填，默认为并发投递。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	模板样式。
Value	string	否	投递顺序类型。 Orderly：顺序投递 Concurrently：并发投递	Concurrently
InstanceEndpoint	object	否	实例接入点。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	实例接入点。	vbr-8vbsvkkbpf3vb0zef****
InstanceId	object	否	目标服务类型为消息队列 RocketMQ 版。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	消息队列 RocketMQ 版的实例 ID。	MQ_INST_164901546557**_BAAN**
InstancePassword	object	否	实例密码。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	实例密码。	admin****
InstanceType	object	否	实例类型。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	实例类型。取值说明如下： Cloud_4：阿里云 RocketMQ 4.0 版本实例（默认选项） Cloud_5：阿里云 RocketMQ 5.0 版本实例 SelfBuilt：自建 Apache RocketMQ 集群	Cloud_4
InstanceUsername	object	否	实例用户名。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	实例用户名。	admin
Keys	object	否	过滤属性。
Form	string	否	转换的格式。	TEMPLATE
Template	string	否	模板样式。	The value of ${key} is ${value}!
Value	string	否	转换前的值。	{ "key": "value" }
Network	object	否	网络类型。 PublicNetwork PrivateNetwork
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	网络类型。 PublicNetwork PrivateNetwork	PublicNetwork
Properties	object	否	过滤属性。
Form	string	否	转换的格式。	TEMPLATE
Template	string	否	模板样式。	The value of ${key} is ${value}!
Value	string	否	转换前的值。	{ "key": "value" }
SecurityGroupId	object	否	安全组 ID。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	安全组 ID。	b4bf375515f6440f942e3a20c33d****
ShardingKey	object	否	消息的分片健。说明 DeliveryOrderType 为 Orderly 时，向下游写入消息时 ShardingKey 属性的事件内容转换规则。Source 为 RocketMQ 时，ShardingKey 允许为空，此时使用上游 BrokerName 和 QueueId 拼接得到消息 ShardingKey。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	模板样式。
Value	string	否	分片健值。	order_id
Tags	object	否	过滤属性。
Form	string	否	转换的格式。	TEMPLATE
Template	string	否	模板样式。	The value of ${key} is ${value}!
Value	string	否	转换前的值。	{ "key": "value" }
Topic	object	否	消息队列 RocketMQ 版实例的 Topic。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	消息队列 RocketMQ 版实例的 Topic。	Mytopic
VSwitchIds	object	否	交换机 ID。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	交换机 ID。	vbr-8vb835n3zf9shwl****mp
VpcId	object	否	VPC 的 ID。
Form	string	否	事件转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	VPC 的 ID。	vbr-8vb835n3zf9shwlvb****
SinkSLSParameters	object	否	Sink SLS Parameters
Body	object	否	发送给 SLS 的内容。
Form	string	否	转换的格式。	TEMPLATE
Template	string	否	模板样式。	The value of ${key} is ${value}!
Value	string	否	转换前的值。	{ "key": "value" }
ContentSchema	object	否	自定义日志的键值，仅在 ContentType 为 KeyValue 生效。每一对键值由 Key_n，Value_n 表示。
Form	string	否	转换的格式。	CONSTANT
Template	string	否	模板样式。
Value	string	否	自定义键值。	{"Key_1":{"form":"CONSTANT","value":"demoKey"},"Value_1":{"form":"JSONPATH","value":"$.data.value"}}
ContentType	object	否	SLS 数据格式。可选择默认或者配置制定的键值： JSON KeyValue
Form	string	否	转换的格式。	CONSTANT
Template	string	否	模板样式。
Value	string	否	SLS 数据格式。	JSON
LogStore	object	否	日志服务 SLS 的日志库。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	日志服务 SLS 的日志库。	test-logstore
Project	object	否	日志服务 SLS 的日志项目。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	日志服务 SLS 的日志项目。	test-project
RoleName	object	否	授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时，需满足条件：在 RAM 控制台创建服务所使用的角色时，需要选择“阿里云服务”，并且“受信服务”需要选择“事件总线”。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时，需满足条件：在 RAM 控制台创建服务所使用的角色时，需要选择“阿里云服务”，并且“受信服务”需要选择“事件总线”。	testRole
Topic	object	否	日志所在的 topic，对应 SLS 保留字段“topic”。
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无
Value	string	否	日志所在的 topic，对应 SLS 保留字段“topic”。	testTopic
RunOptions	object	否	运行环境参数。
BatchWindow	object	否	攒批窗口。
CountBasedWindow	integer	否	窗口中最大可容纳的事件数量。当达到此阈值，会触发窗口内的数据往下游推送。当存在多个窗口时，有一个窗口满足即触发。	100
TimeBasedWindow	integer	否	窗口中最大可容纳的时间范围内的事件（单位秒）。当达到此阈值，会触发窗口内的数据往下游推送。当存在多个窗口时，有一个窗口满足即触发。	10
BusinessOption	object	否
BusinessMode	string	否
MaxCapacityUnitCount	integer	否
MinCapacityUnitCount	integer	否
DeadLetterQueue	object	否	是否启用死信队列。默认不启用死信队列，超过重试策略后的消息将被丢弃。
Arn	string	否	死信队列 ARN。	acs:ram::131733464781****:role/rdstoecsassumekms
Network	string	否	死信队列的网络类型。 PrivateNetwork PublicNetwork	PrivateNetwork
SecurityGroupId	string	否	死信队列所在实例的安全组 ID。	sg-2vcgdxz7o1n9zapp****
VSwitchIds	string	否	死信队列所在的虚拟交换机 ID。	vsw-m5ev8asdc6h12345****
VpcId	string	否	死信队列所在的 VPC 网络 ID。	vpc-2zehizpoendb3****
ErrorsTolerance	string	否	异常容忍策略：NONE（不容忍异常）、ALL（容忍所有异常）。	ALL
MaximumTasks	integer	否	并发数。	2
RetryStrategy	object	否	事件推送失败时的重试策略。
MaximumEventAgeInSeconds	integer	否	最大重试时间。	512
MaximumRetryAttempts	integer	否	最大重试次数。	2
PushRetryStrategy	string	否	重试策略：BACKOFF_RETRY（退避重试）和 EXPONENTIAL_DECAY_RETRY（指数衰减重试）。	BACKOFF_RETRY
Throttling	integer	否
Transforms	array<object>	否	Transform 相关配置
	object	否	云产品的 ARN，比如函数计算中函数的 ARN
AiChunkTransformParameters	AiChunkTransformParameters	否	AI 本地文本分块参数
AiClassifyTransformParameters	AiClassifyTransformParameters	否	AI 文本分类参数
AiEmbedTransformParameters	AiEmbedTransformParameters	否	AI 向量化参数
AiExtractTransformParameters	AiExtractTransformParameters	否	AI 信息抽取参数
AiFilterTransformParameters	AiFilterTransformParameters	否	AI 条件过滤参数
AiPrepSearchTransformParameters	AiPrepSearchTransformParameters	否	AI 语义切块参数
AiRedactTransformParameters	AiRedactTransformParameters	否	AI 脱敏参数
AiSentimentAnalysisTransformParameters	AiSentimentAnalysisTransformParameters	否	AI 情感分析参数
AiSummarizeTransformParameters	AiSummarizeTransformParameters	否	AI 摘要参数
AiTranslateTransformParameters	AiTranslateTransformParameters	否	AI 翻译参数
Arn	string	否	云产品的 ARN，比如函数计算中函数的 ARN	acs:fc:cn-hangzhou:*****:services/demo-service.LATEST/functions/demo-func
BaiLianAgentTransformParameters	BaiLianAgentTransformParameters	否
DashScopeTransformParameters	DashScopeTransformParameters	否

返回参数

名称	类型	描述	示例值
	object	返回信息。
Code	string	接口返回码：Success：表示成功。其它：表示错误码。错误码详情，请参见错误码。	Success
Message	string	错误信息。	The name [xxxx] of event streaming in request is already exist!
RequestId	string	阿里云为该请求生成的唯一标识符。	0FDD73AA-7A2D-5BD4-B4C0-88AFEBF5F0F5
Success	boolean	操作成功返回 true。	true

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "The name [xxxx] of event streaming in request is already exist!",
  "RequestId": "0FDD73AA-7A2D-5BD4-B4C0-88AFEBF5F0F5",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
403	ServiceNotEnable	Service not enable

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

变更历史

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