UpdateEventStreaming

Modifies the basic information, event source information, event filtering pattern, or event target information of an event stream.

Operation description

Modifies the basic information, event source information, event filtering pattern, or event target information of an event stream.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eventbridge:UpdateEventStreaming

update

*EventStreaming

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

None

Request parameters

Parameter	Type	Required	Description	Example
EventStreamingName	string	Yes	The name of the event stream.	myeventstreaming
Description	string	No	The description of the event stream.	rocketmq2mns
FilterPattern	string	No	The event filtering rule. If you do not specify this parameter, all events are matched. For more information, see https://www.alibabacloud.com/help/en/eventbridge/user-guide/event-patterns.	{ "source": [ { "prefix": "acs:mns" } ], "type": [ { "prefix": "mns:Queue" } ], "subject": [ { "prefix": "acs:mns:cn-hangzhou:123456789098****:queues/zeus" } ] }
Source	object	No	The event provider. You must select exactly one Source type.
SourceMNSParameters	object	No	The Source Simple Message Queue (formerly MNS) parameters.
RegionId	string	No	The region ID.	cn-hangzhou
QueueName	string	No	The queue name.	queue_api_1642474203601
IsBase64Decode	boolean	No	Specifies whether to enable Base64 decoding. Default value: true.	true
SourceRabbitMQParameters	object	No	The Source RabbitMQ parameters.
RegionId	string	No	The region ID.	cn-hangzhou
InstanceId	string	No	The ID of the ApsaraMQ for RabbitMQ instance.	i-f8z9lqkldlb4oxsxwwub
VirtualHostName	string	No	The vhost name of the ApsaraMQ for RabbitMQ instance.	eb-connect
QueueName	string	No	The queue name of the ApsaraMQ for RabbitMQ instance.	demo
SourceKafkaParameters	object	No	The Source Kafka parameters.
RegionId	string	No	The region ID.	cn-zhangjiakou
InstanceId	string	No	The instance ID.	i-8vbh4a5b9yfhgkkzm****
Topic	string	No	The topic name.	topic_empower_1641539400786
ConsumerGroup	string	No	The Group ID of the consumer that subscribes to the topic.	DEFAULT_GROUP
OffsetReset	string	No	The offset.	latest
Network	string	No	The network configuration. Default value: Default. Set the value to PublicNetwork for VPC networks.	Default
VpcId	string	No	The VPC ID.	vpc-2ze6p0o345nykmekxt****
VSwitchIds	string	No	The vSwitch ID.	vsw-wz9t1l1e8eu2om****
SecurityGroupId	string	No	The security group ID.	sg-uf6jcm3y5hcs7hkl****
ValueDataType	string	No	The encoding and decoding parameter. Valid values: a. Json: Bytes are decoded to a character string by using UTF-8 and then parsed as JSON. b. Text: Bytes are decoded to a character string by using UTF-8 and placed directly into the payload. c. Binary: Bytes are encoded to a character string by using Base64 encoding and placed into the payload.	Text
SourceRocketMQParameters	object	No	The Source RocketMQ parameters.
RegionId	string	No	The region ID of the ApsaraMQ for RocketMQ instance.	cn-shanghai
InstanceId	string	No	The instance ID of the ApsaraMQ for RocketMQ instance.	i-f8z9a9mcgwri1c1id****
Topic	string	No	The topic name.	TOPIC-cainiao-pcs-order-process-inBoundConditionCheck
Tag	string	No	The filter tag of the message.	test
Offset	string	No	The consumption offset of the message. Valid values: CONSUMEFROMLASTOFFSET: Consumption starts from the latest offset. CONSUMEFROMFIRSTOFFSET: Consumption starts from the earliest offset. CONSUMEFROMTIMESTAMP: Consumption starts from the offset at a specified point in time. Default value: CONSUMEFROMLAST_OFFSET.	CONSUMEFROMLASTOFFSET
GroupID	string	No	The Group ID of the ApsaraMQ for RocketMQ instance.	GID_test
Timestamp	integer	No	The timestamp. This parameter is valid only when the Offset parameter is set to CONSUMEFROMTIMESTAMP.	1670656652009
InstanceType	string	No	The instance type. Valid values: Cloud_4 (default): Alibaba Cloud RocketMQ 4.0 instance. Cloud_5: Alibaba Cloud RocketMQ 5.0 instance. SelfBuilt: self-managed Apache RocketMQ instance.	Cloud_5
InstanceEndpoint	string	No	The instance endpoint.	reg****-vpc.cn-zhangjiakou.aliyuncs.com
InstanceUsername	string	No	The instance username.	admin
InstancePassword	string	No	The instance password.	admin
AuthType	string	No	The authentication type.	ACL
InstanceVpcId	string	No	The VPC information of the instance.	vpc-m5e3sv4b12345****
InstanceVSwitchIds	string	No	The vSwitch information of the instance.	vsw-m5ev8asdc6h12****
InstanceSecurityGroupId	string	No	The security group information of the instance.	sg-m5edtu24f12345****
InstanceNetwork	string	No	The network information of the instance. Valid values: PublicNetwork PrivateNetwork	PublicNetwork
BodyDataType	string	No	The message encoding format. Valid values: Json Text Binary	Json
FilterType	string	No	The message filter type.	Tag
FilterSql	string	No	The SQL filter statement.	index > 10
VpcId	string	No	The VPC ID of the instance.	vpc-m5e3sv4b12345****
VSwitchIds	string	No	The vSwitch ID.	vsw-m5ev8asdc6h12345****
SecurityGroupId	string	No	The security group ID.	sg-m5edtu24f12345****
Network	string	No	The network type. Valid values: PublicNetwork PrivateNetwork	PublicNetwork
SourceRocketMQCheckpointParameters	object	No	The Source RocketMQ checkpoint parameters.
RegionId	string	No	The region ID.	cn-hangzhou
InstanceType	string	No	The type of the ApsaraMQ for RocketMQ instance.	Cloud_5
InstanceId	string	No	The instance ID of the ApsaraMQ for RocketMQ instance.	rmq-cn-jte3w******
Topics	array	No	The topic of the ApsaraMQ for RocketMQ instance.
	string	No	The topic of the ApsaraMQ for RocketMQ instance.	myTopic
SourceApacheRocketMQCheckpointParameters	object	No	The Source RocketMQ checkpoint parameters.
RegionId	string	No	The region ID.	cn-hangzhou
Topics	array	No	The topic of the Apache RocketMQ instance.
	string	No	The topic of the Apache RocketMQ instance.	myTopic
InstanceEndpoint	string	No	The endpoint of the Apache RocketMQ instance.	192.168.1.1:9876
InstanceUsername	string	No	The username of the Apache RocketMQ instance.	admin
InstancePassword	string	No	The password of the Apache RocketMQ instance.	****
NetworkType	string	No	The network type. Valid values: PublicNetwork PrivateNetwork	PrivateNetwork
VpcId	string	No	VPC ID。	vpc-adw1awdw*****
VSwitchId	string	No	The vSwitch ID.	vsw-dwaafds****
SecurityGroupId	string	No	The security group ID.	sg-mw43*****
SourceMQTTParameters	object	No	The Source MQTT parameters.
RegionId	string	No	The region ID.	cn-shanghai
InstanceId	string	No	The instance ID.	i-bp1dsudbecqwt61j****
Topic	string	No	The topic name.	topic_empower_1642400400779
BodyDataType	string	No	The message encoding format. Valid values: JSON Text Binary	JSON
NetworkType	string	No	The network type.
VpcId	string	No	VPC ID。
VSwitchIds	string	No	The vSwitch ID.
SecurityGroupId	string	No	The security group ID.
SourceDTSParameters	object	No	The Source DTS parameters.
TaskId	string	No	The task ID.	f86e5814-b223-482c-b768-3b873297****
BrokerUrl	string	No	The network address and port number of the data subscription channel.
Topic	string	No	The subscription topic of the data subscription channel.	LTC_CACHE_PRD
Sid	string	No	The consumer group ID.	hkprdb
Username	string	No	The account of the consumer group.	admin
Password	string	No	The password of the consumer group account.	admin
InitCheckPoint	integer	No	The consumption checkpoint, which is the timestamp when the SDK client consumes the first data record. The value is a UNIX timestamp.	1620962769
SourceSLSParameters	object	No	The Source SLS parameters.
RoleName	string	No	The role name that grants authorization to the event bus EventBridge to read SLS log content. When you create the role in the Resource Access Management (RAM) console, select Alibaba Cloud Service as the trusted entity and select event bus as the trusted service.	testRole
SourcePrometheusParameters	object	No	The Source Prometheus event source.
RegionId	string	No	The region ID of the instance.	cn-hangzhou
ClusterId	string	No	The cluster ID.	c83555068b6******ad213f565f209
DataType	string	No	The data type.	Json
Labels	string	No	The labels.	__name__=.*
RoleName	string	No	The task role name.	test-role
ExternalLabels	string	No	The external labels appended to the event stream.	{"env":"test"}
SourceCustomizedKafkaParameters	object	No	The custom Kafka event source.
InstanceId	string	No	The instance ID of the ApsaraMQ for Kafka instance.	r-8vb64581862c****
SourceCustomizedKafkaConnectorParameters	object	No	The custom connector Apache Kafka event source.
ConnectorPackageUrl	string	No	The download URL of the OSS resource ZIP package.	"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	No	The connector parameters.
Name	string	No	The connector name.	test-name
Config	object	No	The connector configuration.	{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" }
WorkerParameters	object	No	The instance configuration.	{ "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	No
Bootstraps	string	No
SslKeystoreCertificateChain	string	No	[Required for mutual authentication] Kafka client certificate chain. Provide this parameter when the Kafka server enables mutual SSL authentication (ssl.client.auth=required). Format: Base64-encoded PEM format containing the client certificate and the complete certificate chain (client certificate first, followed by intermediate CA certificates, with the root CA certificate being optional). Ensure that each PEM file starts with '-----BEGIN CERTIFICATE-----' and ends with '-----END CERTIFICATE-----', then Base64-encode the concatenated content.
SslKeyPassword	string	No	[Required for encrypted private keys] Kafka client private key password. Provide the decryption password when the client private key is encrypted (the PEM file contains 'Proc-Type: 4,ENCRYPTED' or 'ENCRYPTED' markers). Leave this parameter empty if the private key is not encrypted. This password is used only to decrypt the private key and is unrelated to Kafka authentication.
SslTruststoreCertificates	string	No	[Required for SSL] Kafka server trust certificate. Used to authenticate the SSL certificate of the Kafka broker and prevent man-in-the-middle attacks. Format: Base64 encoding of PEM format, typically containing the CA certificate or the server certificate of the Kafka server. Example: Base64-encode the PEM file content of the CA certificate (ensure it starts with '-----BEGIN CERTIFICATE-----' and ends with '-----END CERTIFICATE-----'). If Kafka uses a self-signed certificate, provide the CA certificate that issued the certificate.
SslKeystoreKey	object	No	[Required for bidirectional authentication] SSL private key configuration object. Provide the client private key when the Kafka server enables bidirectional SSL authentication. Only KMS pattern is supported: specify the Key Management Service EPS resource that stores the private key by using KmsArn. The system retrieves the private key content from KMS only in memory, which provides higher security. Configuration example: {"KmsArn": "acs:kms:ap-southeast-1:123456789:secret/ssl-key-xxxx", "KmsSecretValueKey": "keystore_private_key"}
KmsArn	string	No	[Required] The KMS resource ARN that stores the SSL private key. Used to locate the Key Management Service instance that stores the client private key. Format example: 'acs:kms:ap-southeast-1:123456789:secret/ssl-keystore-key-xxxx'. Obtain this value from the ARN information of the corresponding key in the KMS console.
KmsSecretValueKey	string	No	[KMS KV mode] The key name in the KMS credential. When the KMS credential is stored as a key-value (KV) structure, specify this parameter to indicate the key corresponding to the SSL private key. Example: if the KMS credential is '{"ssl_keystore_key":"-----BEGIN PRIVATE KEY-----...","ssl_truststore_key":"..."}', enter 'ssl_keystore_key'. Leave this parameter empty if the KMS credential is in plain text mode (directly storing the PEM content of the private key).
Topic	string	No
ConsumerGroup	string	No
OffsetReset	string	No
ValueDataType	string	No
VpcId	string	No
VSwitchIds	string	No
SecurityGroupId	string	No
NetworkType	string	No
SecurityProtocol	string	No
SaslMechanism	string	No
SaslUser	string	No
SaslPassword	string	No
SourceOSSParameters	object	No	The Source OSS event source.
RoleName	string	No	The role name that grants authorization to the event bus EventBridge to read OSS files. The role must have at least read-only permissions on OSS.	eventbridge_oss_role
BucketName	string	No	The name of the OSS bucket.	bucket_abc
Prefix	string	No	The file path prefix.	fun/document/
LoadMode	string	No	The data loading mode. The value single indicates single-document loading, and the value element indicates chunked loading. Valid values: single/element. Default value: single.	single
LoadFormat	string	No	The document loader.	TextLoader
Delimiter	string	No	The delimiter. In chunked loading mode, this delimiter is used as the text chunking identifier. The default delimiter is the newline character \n.	\n
SourceEventBusParameters	object	No	The Source EventBus parameters.
EventBusName	string	No	The event bus name.	my-event-bus
EventRuleName	string	No	The event rule name.	my-event-rule
SourceOpenSourceRabbitMQParameters	object	No	The Source open source RabbitMQ parameters.
Endpoint	string	No	The instance endpoint.	192.168.1.1:9876
VirtualHostName	string	No	The virtual host name of the open source RabbitMQ instance.	Vhost1
QueueName	string	No	The queue name of the open source RabbitMQ instance.	demo
BodyDataType	string	No	The message body data type.	Json
Username	string	No	The username used to connect to the open source RabbitMQ instance.	admin
Password	string	No	The password used to connect to the open source RabbitMQ instance.	****
VpcId	string	No	VPC ID。	vpc-m5e3sv4b12345****
VSwitchIds	string	No	The vSwitch ID.	vsw-m5ev8asdc6h12345****
SecurityGroupId	string	No	The security group ID.	sg-m5edtu24f12345****
NetworkType	string	No	The network type. Valid values: PublicNetwork PrivateNetwork	PrivateNetwork
AuthType	string	No	The authentication type.	ACL
SourceMySQLParameters	SourceMySQLParameters	No	The Source MySQL parameters.
SourcePostgreSQLParameters	SourcePostgreSQLParameters	No
SourceRabbitMQMetaParameters	SourceRabbitMQMetaParameters	No
SourceRabbitMQMsgSyncParameters	SourceRabbitMQMsgSyncParameters	No
SourceFeiShuDocsParameters	SourceFeiShuDocsParameters	No
Metadata	string	No
Sink	object	No	The event target. You must select exactly one Sink type.
SinkMNSParameters	object	No	The Simple Message Queue (formerly MNS) event target.
QueueName	object	No	The target service type is Simple Message Queue (formerly MNS).
Value	string	No	The name of the Simple Message Queue (formerly MNS) queue.	MyQueue
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Body	object	No	The message content.
Value	string	No	The value before transformation.	{ "key": "value" }
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
IsBase64Encode	object	No	Specifies whether to enable Base64 encoding.
Value	string	No	Specifies whether to enable Base64 encoding.	true
Form	string	No	The event transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
SinkEventHouseParameters	object	No	The event target name.
CatalogName	string	No	The catalog name.	demo
NamespaceName	string	No	The namespace of the destination table.	name1
EventTableName	string	No	The name of the destination table.	demo-table
MappingRules	array<object>	No	The field mapping rules.
	array<object>	No	The field mapping rules.
ColumnValue	object	No	The column value extraction rule.
Value	string	No	The extraction path, such as $.data.value.name.	$.data.value
Form	string	No	The transformation method, such as JSONPATH.	JSONPATH
Template	string	No	The template configuration.	The value of ${key} is ${value}!
ColumnName	string	No	The column name.	age
ColumnType	string	No	The column type.	text
SinkFcParameters	object	No	The function target.
ServiceName	object	No	The service name.
Value	string	No	The service name.	myService
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
FunctionName	object	No	The function name.
Value	string	No	The function name.	mFunction
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Concurrency	object	No	The delivery concurrency. Minimum value: 1.
Value	string	No	The delivery concurrency. Minimum value: 1.	1
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Qualifier	object	No	The alias of the service to which the function belongs.
Value	string	No	The alias of the service to which the function belongs.	LATEST
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
InvocationType	object	No	The invocation type. Valid values: Sync: synchronous. Async: asynchronous.
Value	string	No	The invocation type.	Async
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Body	object	No	The content body sent to the function.
Value	string	No	The value before transformation.	{ "key": "value" }
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
DataFormat	object	No	The format transformation rule for event content.
Value	string	No	The value before transformation.	{ "key": "value" }
Form	string	No	The transformation format. Valid values: ORIGINAL: complete event JSONPATH: partial event CONSTANT: constant TEMPLATE: template	JSONPATH
Template	string	No	The template style.	$.data.key
SinkRabbitMQParameters	object	No	The Sink RabbitMQ parameters.
InstanceId	object	No	The event target type is MSMQ for RabbitMQ.
Value	string	No	The instance ID of ApsaraMQ for RabbitMQ.	amqp-cn-2r42e73o****
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
VirtualHostName	object	No	The vhost name of the MSMQ for RabbitMQ instance.
Value	string	No	The vhost name of the ApsaraMQ for RabbitMQ instance.	rabbit-host
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
TargetType	object	No	The target type.
Value	string	No	The target type. Valid values: Exchange: Exchange mode. Queue: Queue mode.	Exchange/Queue
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Exchange	object	No	The Exchange mode. This parameter is required only when the TargetType parameter is set to Exchange.
Value	string	No	The exchange name of the ApsaraMQ for RabbitMQ instance.	a_exchange
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
RoutingKey	object	No	The routing rule of the message. This parameter is required only when the TargetType parameter is set to Exchange.
Value	string	No	The routing rule of the message.	housekeeping
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
QueueName	object	No	The Queue mode. This parameter is required only when the TargetType parameter is set to Queue.
Value	string	No	The name of the queue of the instance.	MyQueue
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Body	object	No	The message content.
Value	string	No	The value before transformation.	{ "key": "value" }
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
MessageId	object	No	The message ID.
Value	string	No	The value before transformation.	{ "key": "value" }
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
Properties	object	No	The filter properties.
Value	string	No	The value before transformation.	{ "key": "value" }
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
SinkKafkaParameters	object	No	The Sink Kafka parameters.
InstanceId	object	No	The event target type is MSMQ for Apache Kafka.
Value	string	No	The instance ID.	Defaut_1283278472_s****
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
CompressionType	string	No
Topic	object	No	The topic name.
Value	string	No	The topic name.	test
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
DynamicTopic	object	No	Specifies the destination topic strategy for message routing. If both the Topic parameter and the DynamicTopic parameter are specified, the DynamicTopic parameter takes precedence. Two configuration modes are supported: 1. Static constant mode: Specify a fixed topic name string (such as "order_created"). All messages are sent to this topic. 2. Dynamic extraction mode: Specify a standard JSONPath expression (such as "$.user.id" or "$.metadata.category"). The system parses the upstream message body and
Value	string	No	The value.
Form	string	No	The transform type. Valid values: CONSTANT: constant value. JSONPATH: extract from upstream based on a JSONPath expression.
Template	string	No	The template.
Headers	object	No	The additional metadata of the Kafka message.
Value	string	No	The value before transformation.	{ "key": "value" }
Form	string	No	The transformation format. Valid values: ORIGINAL: complete event JSONPATH: partial event CONSTANT: constant TEMPLATE: template	CONSTANT
Template	string	No	The template style.	The value of ${key} is ${value}!
Acks	object	No	The acknowledgment mode for writing to Kafka: acks=0: No response is required from the server. This mode delivers higher performance but carries a greater risk of data loss. acks=1: A response is returned after the primary node writes successfully. This mode delivers moderate performance with a moderate risk of data loss. Data loss may occur if the primary node goes down. acks=all: A response is returned only after the primary node writes successfully and the secondary nodes complete synchronization. This mode delivers lower performance but provides greater data safety. Data loss occurs only if both the primary and secondary nodes go down.
Value	string	No	The acknowledgment mode for writing to Kafka: acks=0: No response is required from the server. This mode delivers higher performance but carries a higher risk of data loss. acks=1: A response is returned after the primary node writes successfully. This mode delivers moderate performance with a moderate risk of data loss. Data loss may occur if the primary node goes down. acks=all: A response is returned only after the primary node writes successfully and the secondary nodes complete synchronization. This mode delivers lower performance but provides stronger data safety. Data loss occurs only if both the primary and secondary nodes go down.	1
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Key	object	No	The identifier of the message.
Value	string	No	The identifier of the message.	key
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	object	No	The message body content.
Value	string	No	The value before transformation.	{ "key": "value" }
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
SinkApacheKafkaParameters	object	No	The description.
Bootstraps	string	No
Topic	string	No
DynamicTopic	object	No	Specifies the destination topic strategy for message routing. If both the Topic parameter and the DynamicTopic parameter are specified, the DynamicTopic parameter takes precedence. Two configuration modes are supported: 1. Static constant mode: Specify a fixed topic name string (such as "order_created"). All messages are sent to this topic. 2. Dynamic extraction mode: Specify a standard JSONPath expression (such as "$.user.id" or "$.metadata.category"). The system parses the upstream message body and
Value	string	No	The value.
Form	string	No	The transform type. Valid values: CONSTANT: constant value. JSONPATH: extract from upstream based on a JSONPath expression.
Template	string	No	The template.
Acks	string	No
Key	object	No
Value	string	No
Form	string	No
Template	string	No
Value	object	No
Value	string	No
Form	string	No
Template	string	No
CompressionType	string	No
SecurityProtocol	string	No
SaslMechanism	string	No
SaslUser	string	No
VpcId	object	No
Value	string	No
Form	string	No
Template	string	No
VSwitchIds	object	No
Value	string	No
Form	string	No
Template	string	No
SecurityGroupId	object	No
Value	string	No
Form	string	No
Template	string	No
NetworkType	object	No
Value	string	No
Form	string	No
Template	string	No
Headers	object	No
Value	string	No
Form	string	No
Template	string	No
SaslPassword	string	No
SslKeystoreCertificateChain	string	No	[Required for mutual authentication] Kafka client certificate chain. Provide this parameter when the Kafka server enables mutual SSL authentication (ssl.client.auth=required). Format: Base64-encoded PEM format containing the client certificate and the complete certificate chain (client certificate first, followed by intermediate CA certificates, with the root CA certificate being optional). Ensure that each PEM file starts with '-----BEGIN CERTIFICATE-----' and ends with '-----END CERTIFICATE-----', then Base64-encode the concatenated content.
SslKeyPassword	string	No	[Required for encrypted private keys] Kafka client private key password. Provide the decryption password when the client private key is encrypted (the PEM file contains 'Proc-Type: 4,ENCRYPTED' or 'ENCRYPTED' markers). Leave this parameter empty if the private key is not encrypted. This password is used only to decrypt the private key and is unrelated to Kafka authentication.
SslTruststoreCertificates	string	No	[Required for SSL] The Kafka server trust certificate. Used to authenticate the legitimacy of the Kafka Broker SSL certificate and prevent man-in-the-middle attacks. Format: Base64 encoding of PEM format, typically containing the CA certificate or the server certificate of the Kafka server. Example: Base64-encode the PEM file content of the CA certificate (ensure it begins with '-----BEGIN CERTIFICATE-----' and ends with '-----END CERTIFICATE-----'). If Kafka uses a self-signed certificate, provide the CA certificate that issued it.
SslKeystoreKey	object	No	[Required for bidirectional authentication] The SSL private key configuration object. When the Kafka server enables bidirectional SSL authentication, a client private key is required. Only KMS pattern is supported for the key: specify the Key Management Service EPS resource that stores the private key through KmsArn. The system retrieves the private key content from KMS only in memory, providing higher security. Configuration example: {"KmsArn": "acs:kms:ap-southeast-1:123456789:secret/ssl-key-xxxx", "KmsSecretValueKey": "keystore_private_key"}\n"
KmsArn	string	No	[Required] The KMS resource ARN that stores the SSL private key. Used to locate the Key Management Service instance that stores the client private key. Format example: 'acs:kms:ap-southeast-1:123456789:secret/ssl-keystore-key-xxxx'. Obtain this value from the ARN information of the corresponding key in the KMS console.
KmsSecretValueKey	string	No	[KMS KV mode] The key name in the KMS credential. When the KMS credential is stored as a key-value (KV) structure, specify this parameter to indicate the key corresponding to the SSL private key. Example: if the KMS credential is '{"ssl_keystore_key":"-----BEGIN PRIVATE KEY-----...","ssl_truststore_key":"..."}', enter 'ssl_keystore_key'. Leave this parameter empty if the KMS credential is in plain text mode (directly storing the PEM content of the private key).
SinkRocketMQParameters	object	No	Sink RocketMQ Parameters
InstanceId	object	No	The event target type is MSMQ for RocketMQ.
Value	string	No	The instance ID of ApsaraMQ for RocketMQ.	MQ_INST_164901546557**_BAAN**
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Topic	object	No	The topic of the MSMQ for RocketMQ instance.
Value	string	No	The topic of the ApsaraMQ for RocketMQ instance.	Mytopic
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Body	object	No	The message content.
Value	string	No	The value before transformation.	{ "key": "value" }
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
Properties	object	No	The filter properties.
Value	string	No	The value before transformation.	{ "key": "value" }
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
Keys	object	No	The filter properties.
Value	string	No	The value before transformation.	{ "key": "value" }
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
Tags	object	No	The filter properties.
Value	string	No	The value before transformation.	{ "key": "value" }
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
InstanceType	object	No	The instance type.
Value	string	No	The instance type. Valid values: Cloud_4: Alibaba Cloud RocketMQ 4.0 instance (default) Cloud_5: Alibaba Cloud RocketMQ 5.0 instance SelfBuilt: self-managed Apache RocketMQ cluster	Cloud_4
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
InstanceEndpoint	object	No	The instance endpoint.
Value	string	No	The instance endpoint.	vbr-8vbsvkkbpf3vb0zef****
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
InstanceUsername	object	No	The instance username.
Value	string	No	The instance username.	admin
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
InstancePassword	object	No	The instance password.
Value	string	No	The instance password.	admin****
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
VpcId	object	No	The VPC ID.
Value	string	No	The VPC ID.	vbr-8vb835n3zf9shwlvb****
Form	string	No	The event transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
VSwitchIds	object	No	The vSwitch ID.
Value	string	No	The vSwitch ID.	vbr-8vb835n3zf9shwl****mp
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
SecurityGroupId	object	No	The security group ID.
Value	string	No	The security group ID.	b4bf375515f6440f942e3a20c33d****
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Network	object	No	The network type. Valid values: PublicNetwork PrivateNetwork
Value	string	No	The network type. Valid values: PublicNetwork PrivateNetwork	PublicNetwork
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
DeliveryOrderType	object	No	The delivery order type of messages. Optional. Defaults to concurrent delivery.
Value	string	No	The delivery order type. Valid values: Orderly: ordered delivery. Concurrently: concurrent delivery.	Concurrently
Form	string	No	The transform format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
ShardingKey	object	No	The sharding key of the message. Note When DeliveryOrderType is set to Orderly, this specifies the event content transformation rule for the ShardingKey property when writing messages downstream. When the source is RocketMQ, ShardingKey can be empty. In this case, the message ShardingKey is generated by concatenating the upstream BrokerName and QueueId.
Value	string	No	The sharding key value.	order_id
Form	string	No	The transform format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
SinkDorisParameters	object	No	The event source type.
QueryEndpoint	object	No
Value	string	No
Form	string	No
Template	string	No
FeHttpEndpoint	object	No
Value	string	No
Form	string	No
Template	string	No
BeHttpEndpoint	object	No
Value	string	No
Form	string	No
Template	string	No
UserName	object	No
Value	string	No
Form	string	No
Template	string	No
Password	object	No
Value	string	No
Form	string	No
Template	string	No
Database	object	No
Value	string	No
Form	string	No
Template	string	No
Body	object	No
Value	string	No
Form	string	No
Template	string	No
Table	object	No
Value	string	No
Form	string	No
Template	string	No
NetworkType	object	No
Value	string	No
Form	string	No
Template	string	No
VpcId	object	No
Value	string	No
Form	string	No
Template	string	No
VSwitchIds	object	No
Value	string	No
Form	string	No
Template	string	No
SecurityGroupId	object	No
Value	string	No
Form	string	No
Template	string	No
SinkRocketMQCheckpointParameters	object	No	Sink RocketMQ Checkpoint Parameters
InstanceType	string	No	The instance type. Valid values: Cloud_4: Alibaba Cloud RocketMQ 4.0 instance Cloud_5: Alibaba Cloud RocketMQ 5.0 instance	Cloud_4
InstanceId	string	No	The instance ID.	MQ_INST_164901546557**_BAAN**
Topic	object	No	The topic of the MSMQ for RocketMQ instance.
Value	string	No	The topic name of the ApsaraMQ for RocketMQ instance.	Mytopic
Form	string	No	The transform format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
ConsumeTimestamp	object	No	The timestamp of message consumption.
Value	string	No	The timestamp.	1570761026400
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
Group	object	No	The Group ID of the consumer group.
Value	string	No	Group ID	GID_EVENTBRIDGE_1736234******
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
SinkApacheRocketMQCheckpointParameters	object	No	Sink Apache RocketMQ Checkpoint Parameters
Topic	object	No	The topic of the RocketMQ instance.
Value	string	No	The topic name of the RocketMQ instance.	Mytopic
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
ConsumeTimestamp	object	No	The timestamp of message consumption.
Value	string	No	The timestamp.	1570761026400
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
Group	object	No	The Group ID of the consumer group.
Value	string	No	Group ID	GID_EVENTBRIDGE_1736234******
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
InstanceEndpoint	string	No	The instance endpoint.	192.168.1.1:9876
InstanceUsername	string	No	The username required for authentication.	admin
InstancePassword	string	No	The password for the username.	****
NetworkType	string	No	The network type. Valid values: PublicNetwork PrivateNetwork	PrivateNetwork
VpcId	string	No	The VPC ID.	vpc-2zeccak5pb0j3ay******
VSwitchId	string	No	The vSwitch ID.	vsw-uf62oqt1twuevrt******
SecurityGroupId	string	No	The security group ID.	sg-2ze5bmpw6adn0q******
SinkSLSParameters	object	No	Sink SLS Parameters
Project	object	No	The project of Simple Log Service.
Value	string	No	The project of Simple Log Service.	test-project
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
LogStore	object	No	The Logstore of Simple Log Service.
Value	string	No	The Logstore of Simple Log Service.	test-logstore
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Topic	object	No	The topic where the log resides, corresponding to the Simple Log Service reserved field "topic".
Value	string	No	The topic where the log resides, corresponding to the Simple Log Service reserved field "topic".	testTopic
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Body	object	No	The content sent to Simple Log Service.
Value	string	No	The value before transformation.	{ "key": "value" }
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
RoleName	object	No	The role that provides authorization for the event bus EventBridge to read Simple Log Service log content. When creating the role in the Resource Access Management (RAM) console, select "Alibaba Cloud Service" and set "Trusted Service" to "event bus".
Value	string	No	The role that provides authorization for the event bus EventBridge to read Simple Log Service log content. When creating the role in the Resource Access Management (RAM) console, select "Alibaba Cloud Service" and set "Trusted Service" to "event bus".	testRole
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
ContentType	object	No	The data format of Simple Log Service. You can select the default format or configure specified key-value pairs. Valid values: JSON KeyValue
Value	string	No	The data format of Simple Log Service.	JSON
Form	string	No	The transformation format.	CONSTANT
Template	string	No	The template style.
ContentSchema	object	No	The custom log key-value pairs. This parameter takes effect only when ContentType is set to KeyValue. Each key-value pair is represented by Key_n and Value_n.
Value	string	No	The custom key-value pairs.	{"Key_1":{"form":"CONSTANT","value":"demoKey"},"Value_1":{"form":"JSONPATH","value":"$.data.value"}}
Form	string	No	The transformation format.	CONSTANT
Template	string	No	The template style.
SinkFnfParameters	object	No	The Sink Fnf parameters.
FlowName	object	No	The flow name.
Value	string	No	The flow name.	test-streaming-fnf
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
ExecutionName	object	No	The execution name.
Value	string	No	The execution name.	123
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
Input	object	No	The execution input information.
Value	string	No	The execution input information.	123
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
RoleName	object	No	The role configuration.
Value	string	No	The role configuration.	Al**FNF-x**
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
SinkPrometheusParameters	object	No	The Sink Prometheus parameters.
URL	object	No	The Prometheus Remote Write URL.
Value	string	No	The Prometheus Remote Write URL.	https://cn-hangzhou.arms.aliyuncs.com/prometheus/167275**/c5b7faeb2e8994641***d5c559f/cn-hangzhou/api/v3/write
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
HeaderParameters	object	No	The data structure of request header parameters.
Value	string	No	If Form is CONSTANT: a constant value. If Form is JSONPATH: content extracted by using a JSONPath expression. If Form is TEMPLATE: a template variable. Note: The Value field cannot exceed 10,240 characters.	name
Form	string	No	The transform format. Valid values: JSONPATH CONSTANT TEMPLATE	TEMPLATE
Template	string	No	The HTTP request header template. Specify this parameter when Form is set to TEMPLATE. The result after event content transformation must be in JSON format.	{ "user_name":"${name}" }
AuthorizationType	object	No	The authentication type.
Value	string	No	The authentication type.	BASIC_AUTH
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Username	object	No	The username.
Value	string	No	The username.	***admin
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Password	object	No	The password.
Value	string	No	The password.	abc
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Data	object	No	The metric content.
Value	string	No	The metric content.	$.data
Form	string	No	The transform format. Default value: JSONPATH.	JSONPATH
Template	string	No	None.
NetworkType	object	No	The network type.
Value	string	No	The network type. Valid values: PublicNetwork PrivateNetwork	PrivateNetwork
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
VpcId	object	No	VPC ID。
Value	string	No	VPC ID。	vpc-adw1awdw*****
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
VSwitchId	object	No	The vSwitch ID.
Value	string	No	The vSwitch ID.	vsw-dwaafds****
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
SecurityGroupId	object	No	The security group ID.
Value	string	No	The security group ID.	sg-mw43*****
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
SinkDataHubParameters	object	No	The Sink DataHub parameters.
Project	object	No	The DataHub project name.
Value	string	No	The DataHub project name.	demo-project
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Topic	object	No	The DataHub topic name.
Value	string	No	The DataHub topic name.	demo-topic
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
TopicType	object	No	The topic type. Valid values: TUPLE BLOB
Value	string	No	The topic type. Valid values: TUPLE BLOB	TUPLE
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
TopicSchema	object	No	The topic content schema for the TUPLE type.
Value	string	No	The topic content schema for the TUPLE type.	{"k1":"value1","k2":"value2"}
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	{"k1":"${k1}","k2":"${k2}"}
Body	object	No	The record content template for the BLOB type.
Value	string	No	The record content template for the BLOB type.
Form	string	No	The transformation format.	ORIGINAL
Template	string	No	None.
RoleName	object	No	The task role name.
Value	string	No	The task role name.	test-role
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
ContentType	object	No	The data format. You can select the default format or configure specified key-value pairs. Valid values: JSON KeyValue
Value	string	No	The value before transformation.	JSON
Form	string	No	The transformation format.	CONSTANT
Template	string	No	The template style.
ContentSchema	object	No	The custom log key-value pairs. This parameter takes effect only when ContentType is set to KeyValue. Each key-value pair is represented by Key_n and Value_n.
Value	string	No	The value before transformation.	{"Key_1":{"form":"CONSTANT","value":"demoKey"},"Value_1":{"form":"JSONPATH","value":"$.data.value"}}
Form	string	No	The template style.	CONSTANT
Template	string	No	The template style.
SinkCustomizedKafkaParameters	object	No	The Sink Kafka parameters.
InstanceId	string	No	The instance ID of MSMQ for Apache Kafka.	90be1f96-4229-4535-bb76-34b4f6fb2b71
SinkCustomizedKafkaConnectorParameters	object	No	The Sink Kafka connector parameters.
ConnectorPackageUrl	string	No	The OSS file download URL.	"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	No	Parses the properties file in the current ZIP package.
Name	string	No	The connector name.	mongo-sink
Config	object	No	The connector configuration.	{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" }
WorkerParameters	object	No	The instance configuration.	{ "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	No	The Sink DashVector parameters.
InstanceId	string	No	The instance ID.	vrs-cn-lbj3ru1***
Collection	string	No	The collection name.	collection1
ApiKey	string	No	The API key created in the DashVector console.	Q34nExQH7sQ****
Operation	string	No	The DashVector database operation type. Valid values: Delete Upsert	Upsert
Network	string	No	The network type. Valid values: PrivateNetwork PublicNetwork	PublicNetwork
PrimaryKeyId	object	No	The primary key ID for inserting or deleting records. If this field is not specified, a random primary key ID is used.
Form	string	No	The transform format. Valid values: JSONPATH TEMPLATE	JSONPATH
Value	string	No	If Form is JSONPATH: content extracted by using a JSONPath expression. If Form is TEMPLATE: a template variable. Note The Value field cannot exceed 10,240 characters.	$.data.requestId
Template	string	No	The primary key ID template. Specify this parameter only when Form is set to TEMPLATE.	${ID}
Partition	object	No	The partition. Default value: default.
Form	string	No	The transform format. Valid values: JSONPATH CONSTANT	CONSTANT
Value	string	No	If Form is CONSTANT: a constant value. If Form is JSONPATH: content extracted by using a JSONPath expression. Note The Value field cannot exceed 10,240 characters.	default
Template	string	No	None.
Vector	object	No	The vector for the record to be inserted into DashVector.
Form	string	No	The transformation format.	JSONPATH
Value	string	No	The content extracted by using a JSONPath expression. Note The Value field cannot exceed 10,240 characters.	$.data.messageBody
Template	string	No	None.
DashVectorSchemaParameters	array<object>	No	The schema field definition for table entries when inserting into DashVector. The result after event content transformation must be in JSON format.
	array<object>	No
Name	object	No
Form	string	No
Value	string	No
Template	string	No
Type	object	No
Form	string	No
Value	string	No
Template	string	No
Value	object	No
Form	string	No
Value	string	No
Template	string	No
SinkOpenSourceRabbitMQParameters	object	No	Sink Open Source RabbitMQ Parameters
Endpoint	string	No	The endpoint.	192.168.1.1:9876
VirtualHostName	string	No	The virtual host name of RabbitMQ.	Vhost1
TargetType	string	No	The target type for message delivery. Valid values: Exchange: Messages are routed through an exchange. Queue: Messages are delivered directly to a specified queue.	Exchange
Exchange	string	No	The exchange name in RabbitMQ. This parameter takes effect when TargetType is set to Exchange.	my-exchange
QueueName	string	No	The queue name in RabbitMQ. This parameter takes effect only when TargetType is set to Queue.	my-queue
Username	string	No	The username for accessing the RabbitMQ instance.	admin
Password	string	No	The password for accessing the RabbitMQ instance.	****
VpcId	string	No	The VPC ID.	vpc-uf6of9452b2pba82c ****
VSwitchIds	string	No	The vSwitch ID.	vsw-uf6of9452b2pba82c ****
SecurityGroupId	string	No	The security group ID.	sg-uf6of9452b2pba82c ****
NetworkType	string	No	The network type. Valid values: PrivateNetwork PublicNetwork	PublicNetwork
AuthType	string	No	The authentication type. Valid values: ACL No configuration required	ACL
RoutingKey	object	No	The message routing key.
Form	string	No	The transform format. Default value: CONSTANT.	CONSTANT
Value	string	No	The routing key value.	{"Form": "CONSTANT", "Value": "my-routing-key"}
Template	string	No	The template style.	The value of ${key} is ${value}!
Body	object	No	The message body content.
Form	string	No	The transform format. Default value: CONSTANT.	CONSTANT
Value	string	No	The raw data value.	{"key": "value"}
Template	string	No	The template style.	The value of ${key} is ${value}!
MessageId	object	No	The unique identifier of the message.
Form	string	No	The transform format. Default value: CONSTANT.	CONSTANT
Value	string	No	The message ID value.	12345
Template	string	No	The template style.
Properties	object	No	The additional properties of the message.
Form	string	No	The transform format. Default value: CONSTANT.	CONSTANT
Value	string	No	The property content.	{"env": "prod"}
Template	string	No	The template style.	The value of ${key} is ${value}!
SinkBaiLianParameters	SinkBaiLianParameters	No	Sink BaiLian Parameters
SinkDataWorksTriggerParameters	SinkDataWorksTriggerParameters	No
SinkHttpsParameters	SinkHttpsParameters	No	The HTTPS target parameters.
SinkApiDestinationParameters	SinkApiDestinationParameters	No	The ApiDestination target parameters.
SinkOSSParameters	SinkOSSParameters	No
SinkRabbitMQMetaParameters	SinkRabbitMQMetaParameters	No
SinkRabbitMQMsgSyncParameters	SinkRabbitMQMsgSyncParameters	No
SinkMQTTParameters	SinkMQTTParameters	No
SinkAgentRunParameters	SinkAgentRunParameters	No
RunOptions	object	No	The runtime environment parameters.
MaximumTasks	integer	No	The concurrency.	2
ErrorsTolerance	string	No	The error tolerance policy: NONE (no error tolerance) or ALL (tolerate all errors).	ALL
RetryStrategy	object	No	The retry policy when event push fails.
PushRetryStrategy	string	No	The retry policy: BACKOFF_RETRY (backoff retry) or EXPONENTIAL_DECAY_RETRY (exponential decay retry).	BACKOFF_RETRY
MaximumEventAgeInSeconds	integer	No	The maximum retry time.	512
MaximumRetryAttempts	integer	No	The maximum number of retry attempts.	2
DeadLetterQueue	object	No	Specifies whether to enable the dead-letter queue. The dead-letter queue is disabled by default. Messages that exceed the retry policy are discarded.
Arn	string	No	The ARN of the dead-letter queue.	acs:ram::131733464781****:role/rdstoecsassumekms
Network	string	No	The network type of the dead-letter queue. Valid values: PrivateNetwork PublicNetwork	PrivateNetwork
VpcId	string	No	The VPC ID where the dead-letter queue resides.	vpc-2zehizpoendb3****
VSwitchIds	string	No	The vSwitch ID where the dead-letter queue resides.	vsw-m5ev8asdc6h12345****
SecurityGroupId	string	No	The security group ID of the instance where the dead-letter queue resides.	sg-2vcgdxz7o1n9zapp****
BatchWindow	object	No	The batch window.
CountBasedWindow	integer	No	The maximum number of events that the window can contain. When this threshold is reached, the data in the window is pushed downstream. If multiple windows exist, a push is triggered when any window meets the threshold.	100
TimeBasedWindow	integer	No	The maximum time range (in seconds) of events that the window can contain. When this threshold is reached, the data in the window is pushed downstream. If multiple windows exist, a push is triggered when any window meets the threshold.	10
BusinessOption	object	No
BusinessMode	string	No
MinCapacityUnitCount	integer	No
MaxCapacityUnitCount	integer	No
Throttling	integer	No
Transforms	array<object>	No	The Transform-related configurations.
	object	No	The ARN of the cloud service resource, such as the ARN of a function in Function Compute.
Arn	string	No	The ARN of the cloud service resource, such as the ARN of a function in Function Compute.	acs:fc:cn-hangzhou:*****:services/demo-service.LATEST/functions/demo-func
DashScopeTransformParameters	DashScopeTransformParameters	No
BaiLianAgentTransformParameters	BaiLianAgentTransformParameters	No

Response elements

Element	Type	Description	Example
	object	The response parameters.
Message	string	The error message.	The name [xxxx] of event streaming in request is already exist!
RequestId	string	The request ID generated by Alibaba Cloud for this request.	0FDD73AA-7A2D-5BD4-B4C0-88AFEBF5F0F5
Code	string	The response code. Valid values: Success: The request was successful. Other values indicate error codes. For more information, see Error codes.	Success
Success	boolean	Returns true if the operation is successful.	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
403	ServiceNotEnable	Service not enable

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.