调用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 进行填选。
SourceMNSParameters	object	否	Source 轻量消息队列（原 MNS）参数。
RegionId	string	否	地域 ID。	cn-hangzhou
QueueName	string	否	队列名称	queue_api_1642474203601
IsBase64Decode	boolean	否	是否开启 Base64 编码。默认为 true。	true
SourceRabbitMQParameters	object	否	Source RabbitMQ 源
RegionId	string	否	地域 ID。	cn-hangzhou
InstanceId	string	否	消息队列 RabbitMQ 版的实例的 ID。	i-f8z9lqkldlb4oxsxwwub
VirtualHostName	string	否	消息队列 RabbitMQ 版实例的 Vhost 的名称。	eb-connect
QueueName	string	否	消息队列 RabbitMQ 版实例的 Queue 的名称。	demo
SourceKafkaParameters	object	否	Source Kafka 源
RegionId	string	否	地域 ID。	cn-zhangjiakou
InstanceId	string	否	实例 ID。	i-8vbh4a5b9yfhgkkzm****
Topic	string	否	Topic 名称。	topic_empower_1641539400786
ConsumerGroup	string	否	订阅该 Topic 的消费者所对应的 Group ID。	DEFAULT_GROUP
OffsetReset	string	否	偏移量。	latest
Network	string	否	网络配置：默认值 Default，vpc 网络是 PublicNetwork	Default
VpcId	string	否	专有网络 VPC 的 ID。	vpc-2ze6p0o345nykmekxt****
VSwitchIds	string	否	交换机 ID。	vsw-wz9t1l1e8eu2om****
SecurityGroupId	string	否	安全组 ID。	sg-uf6jcm3y5hcs7hkl****
ValueDataType	string	否	编解码参数枚举值，有 3 个枚举值，命名如下 a. Json：现有逻辑，bytes 按 utf8 解码成字符串，解析为 json b. Text：bytes 按 utf8 解码成字符串，直接放入 payload c. Binary：bytes 按 base64 编码成字符串，放入 payload	Text
SourceRocketMQParameters	object	否	Source RocketMQ 源
RegionId	string	否	消息队列 RocketMQ 版的地域 ID。	cn-shanghai
InstanceId	string	否	消息队列 RocketMQ 版的实例 ID。	i-f8z9a9mcgwri1c1id****
Topic	string	否	topic 名称。	TOPIC-cainiao-pcs-order-process-inBoundConditionCheck
Tag	string	否	消息的过滤标签。	test
Offset	string	否	消息的消费位点。取值说明如下： CONSUMEFROMLASTOFFSET：从最新位点开始消费。 CONSUMEFROMFIRSTOFFSET：从最早位点开始消费。 CONSUMEFROMTIMESTAMP：从指定时间点的位点开始消费。默认值：CONSUMEFROMLAST_OFFSET。	CONSUMEFROMLASTOFFSET
GroupID	string	否	消息队列 RocketMQ 版的 Group ID。	GID_test
Timestamp	long	否	时间戳。仅当参数 Offset 取值为 CONSUMEFROMTIMESTAMP 时，该参数有效。	1670656652009
InstanceType	string	否	实例类型。 Cloud_4（默认值）：阿里云 RocketMQ 4.0 实例 Cloud_5：阿里云 RocketMQ 5.0 实例 SelfBuilt：自建 Apache RocketMQ 实例	Cloud_5
InstanceEndpoint	string	否	实例接入点	reg****-vpc.cn-zhangjiakou.aliyuncs.com
InstanceUsername	string	否	实例用户名。	admin
InstancePassword	string	否	实例密码。	admin
AuthType	string	否	鉴权类型。	ACL
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
SourceMQTTParameters	object	否	Source MQTT 源
RegionId	string	否	地域 ID。	cn-shanghai
InstanceId	string	否	实例 ID。	i-bp1dsudbecqwt61j****
Topic	string	否	Topic 名称。	topic_empower_1642400400779
BodyDataType	string	否	消息编码格式： JSON Text Binary	JSON
SourceDTSParameters	object	否	Source DTS 源
TaskId	string	否	任务 ID。	f86e5814-b223-482c-b768-3b873297****
BrokerUrl	string	否	数据订阅通道的网络地址及端口号信息。	无
Topic	string	否	数据订阅通道的订阅 Topic。	LTC_CACHE_PRD
Sid	string	否	消费组 ID。	hkprdb
Username	string	否	消费组的账号。	admin
Password	string	否	消费组的账号密码。	admin
InitCheckPoint	long	否	消费位点，即 SDK 客户端消费第一条数据的时间戳，格式为 Unix 时间戳。	1620962769
SourceSLSParameters	object	否	Source SLS 源
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__=.*
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" }
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
Sink	object	是	事件目标。必须选择一种 Sink，且最多只能选择一种 Sink 进行填选。
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	否	无	无
SinkFcParameters	object	否	函数目标。
ServiceName	object	否	服务的名称。
Value	string	否	服务的名称。	myService
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
FunctionName	object	否	函数名称。
Value	string	否	函数名称。	mFunction
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
Concurrency	object	否	投递并发度，最小 1。
Value	string	否	投递并发度，最小 1。	1
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
Qualifier	object	否	函数所属服务的别名。
Value	string	否	函数所属服务的别名。	LATEST
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
InvocationType	object	否	同步或则异步。 Sync：同步。 Async：异步。
Value	string	否	调用类型。	Async
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
Body	object	否	发送给函数的内容体。
Value	string	否	转换前的值。	{ "key": "value" }
Form	string	否	转换的格式。	TEMPLATE
Template	string	否	模板样式。	The value of ${key} is ${value}!
SinkRabbitMQParameters	object	否	Sink Rabbitmq 的参数。
InstanceId	object	否	目标服务类型为消息队列 RabbitMQ 版。
Value	string	否	消息队列 RabbitMQ 版的实例 ID。	amqp-cn-2r42e73o****
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
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	否	无	无
Exchange	object	否	Exchange 模式。仅当参数 TargetType 配置为 Exchange 时，需配置此参数。
Value	string	否	消息队列 RabbitMQ 版实例的 Exchange 的名称。	a_exchange
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
RoutingKey	object	否	消息的路由规则。仅当参数 TargetType 配置为 Exchange 时，需配置此参数。
Value	string	否	消息的路由规则。	housekeeping
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
QueueName	object	否	Queue 模式。仅当参数 TargetType 配置为 Queue 时，需配置此参数。
Value	string	否	实例的 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}!
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}!
SinkKafkaParameters	object	否	Sink kafak 参数
InstanceId	object	否	目标服务类型为消息队列 Kafka 版。
Value	string	否	实例 ID。	Defaut_1283278472_s****
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
Topic	object	否	主题名称。
Value	string	否	主题名称。	test
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
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	否	无	无
Key	object	否	消息的标识。
Value	string	否	消息的标识。	key
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
Value	object	否	消息体内容。
Value	string	否	转换前的值。	{ "key": "value" }
Form	string	否	转换的格式。	TEMPLATE
Template	string	否	模板样式。	The value of ${key} is ${value}!
SinkRocketMQParameters	object	否	Sink RocketMQ Parameters
InstanceId	object	否	目标服务类型为消息队列 RocketMQ 版。
Value	string	否	消息队列 RocketMQ 版的实例 ID。	MQ_INST_164901546557**_BAAN**
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
Topic	object	否	消息队列 RocketMQ 版实例的 Topic。
Value	string	否	消息队列 RocketMQ 版实例的 Topic。	Mytopic
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
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	否	实例类型。
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	否	无	无
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	否	SLS 数据格式。	JSON
Form	string	否	转换的格式。
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	否	转换的格式。
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。	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	否	模板样式。	无
SinkPrometheusParameters	object	否	Sink Prometheus 参数
URL	object	否	Prometheus Remote Write URL 地址
Value	string	否	Prometheus Remote Write URL 地址	https://cn-hangzhou.arms.aliyuncs.com/prometheus/167275**/c5b7faeb2e8994641***d5c559f/cn-hangzhou/api/v3/write
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
HeaderParameters	object	否	请求头的参数数据结构。
Value	string	否	Form 为 CONSTANT：常量值 Form 为 JSONPATH：JSONPath 提取内容 Form 为 TEMPLATE：模板变量注：Value 字段不允许超过 10240 个字符	示例1（Form为CONSTANT） name 示例2（Form为JSONPATH） $.data.name 示例3（Form为TEMPLATE） { "name":"$.data.name" }
Form	string	否	转换的格式。枚举值： JSONPATH：JSONPATH。 CONSTANT：CONSTANT。 TEMPLATE：TEMPLATE。	TEMPLATE
Template	string	否	Http 请求头模板样式，当 Form 是 TEMPLATE 时填写，事件内容转换后结果必须是 Json 格式。	{ "user_name":"${name}" }
AuthorizationType	object	否	鉴权方式
Value	string	否	鉴权方式	BASIC_AUTH
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
Username	object	否	用户名
Value	string	否	用户名	***admin
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
Password	object	否	密码
Value	string	否	密码	abc
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
Data	object	否	指标内容
Value	string	否	指标内容	$.data
Form	string	否	转换的格式。默认为 JSONPATH。	JSONPATH
Template	string	否	无	无
NetworkType	object	否	网络类型
Value	string	否	网络类型	PrivateNetwork
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
VpcId	object	否	VPC ID。
Value	string	否	VPC ID。	vpc-adw1awdw*****
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
VSwitchId	object	否	交换机 Id
Value	string	否	交换机 Id	vsw-dwaafds****
Form	string	否	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	否	无	无
SecurityGroupId	object	否	安全组 ID。
Value	string	否	安全组 ID。	sg-mw43*****
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	否	topic 类型。 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	否	无	无
ContentType	object	否	数据格式。可选择默认或者配置制定的键值： 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	否	模板样式。	无
SinkCustomizedKafkaParameters	object	否	Sink Kafka 参数。
InstanceId	string	否	消息队列 Kafka 版的实例 ID。	90be1f96-4229-4535-bb76-34b4f6fb2b71
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 文件。
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 数据库操作类型。 Delete Upsert	Upsert
Network	string	否	网络类型。 PrivateNetwork PublicNetwork	PublicNetwork
PrimaryKeyId	object	否	插入/删除记录时的主键 ID 不填写此字段时，使用随机主键 ID。
Form	string	否	转换的格式： JSONPATH TEMPLATE	JSONPATH
Value	string	否	Form 为 JSONPATH：JSONPath 提取内容 Form 为 TEMPLATE：模板变量说明 Value 字段不允许超过 10240 个字符	$.data.requestId
Template	string	否	主键 ID 模板，仅当 Form 是 TEMPLATE 时需要填写。	${ID}
Partition	object	否	Partition（分区），默认值为 default 分区。
Form	string	否	转换的格式： JSONPATH CONSTANT	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	object	否	插入 DashVector 时表项的 Schema 字段定义，事件内容转换后结果必须是 Json 格式。
Form	string	否	转换的格式。 JSONPATH CONSTANT TEMPLATE	TEMPLATE
Value	string	否	Form 为 CONSTANT：常量值 Form 为 JSONPATH：JSONPath 提取内容 Form 为 TEMPLATE：模板变量说明 Value 字段不允许超过 10240 个字符。	{ "value1":"v1", "value2":"v2" }
Template	string	否	Schema 模板，仅当 Form 是 TEMPLATE 时需要填写，事件内容转换后必须是 Array(Json)格式，每个 Schema 对应一个 Json 对象，属性有且仅有 name, type（仅支持 INT、FLOAT、STRING、BOOL）, value 三个字段。	[ { "name": "schema1", "type": "INT", "value": "${value1}" }, { "name": "schema2", "type": "FLOAT", "value": "${value2}" } ]
RunOptions	object	否	运行环境参数。
MaximumTasks	long	否	并发数。	2
ErrorsTolerance	string	否	异常容忍策略：NONE（不容忍异常）、ALL（容忍所有异常）。	ALL
RetryStrategy	object	否	事件推送失败时的重试策略。
PushRetryStrategy	string	否	重试策略：BACKOFF_RETRY（退避重试）和 EXPONENTIAL_DECAY_RETRY（指数衰减重试）。	BACKOFF_RETRY
MaximumEventAgeInSeconds	long	否	最大重试时间。	512
MaximumRetryAttempts	long	否	最大重试次数。	2
DeadLetterQueue	object	否	是否启用死信队列。默认不启用死信队列，超过重试策略后的消息将被丢弃。
Arn	string	否	死信队列 ARN。	acs:ram::131733464781****:role/rdstoecsassumekms
BatchWindow	object	否	攒批窗口。
CountBasedWindow	integer	否	窗口中最大可容纳的事件数量。当达到此阈值，会触发窗口内的数据往下游推送。当存在多个窗口时，有一个窗口满足即触发。	100
TimeBasedWindow	integer	否	窗口中最大可容纳的时间范围内的事件（单位秒）。当达到此阈值，会触发窗口内的数据往下游推送。当存在多个窗口时，有一个窗口满足即触发。	10
Transforms	array<object>	否	Transform 相关配置
	object	否	云产品的 ARN，比如函数计算中函数的 ARN
Arn	string	否	云产品的 ARN，比如函数计算中函数的 ARN	acs:fc:cn-hangzhou:*****:services/demo-service.LATEST/functions/demo-func

返回参数

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

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间	变更内容概要	操作
2024-09-10	OpenAPI 错误码发生变更	查看变更详情
2024-09-09	OpenAPI 错误码发生变更	查看变更详情
2024-08-19	OpenAPI 错误码发生变更	查看变更详情
2024-07-12	OpenAPI 错误码发生变更	查看变更详情
2024-06-28	OpenAPI 错误码发生变更	查看变更详情
2024-05-31	OpenAPI 错误码发生变更	查看变更详情
2024-04-09	OpenAPI 错误码发生变更	查看变更详情
2024-02-21	OpenAPI 错误码发生变更	查看变更详情
2024-01-25	OpenAPI 错误码发生变更	查看变更详情
2023-12-28	OpenAPI 错误码发生变更	查看变更详情
2023-11-22	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-10-11	OpenAPI 错误码发生变更	查看变更详情
2023-09-13	OpenAPI 错误码发生变更	查看变更详情
2023-04-21	OpenAPI 错误码发生变更	查看变更详情
2023-04-06	OpenAPI 错误码发生变更	查看变更详情