Call UpdateEventStreaming to update an event stream - EventBridge - Alibaba Cloud - EventBridge

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.
SourceApacheKafkaParameters	object	No
Bootstraps	string	No
ConsumerGroup	string	No
NetworkType	string	No
OffsetReset	string	No
SaslMechanism	string	No
SaslPassword	string	No
SaslUser	string	No
SecurityGroupId	string	No
SecurityProtocol	string	No
SslKeyPassword	string	No	[Required for encrypted private keys] The password for the Kafka client private key. If the client private key is encrypted with a password (the PEM file contains the 'Proc-Type: 4,ENCRYPTED' or 'ENCRYPTED' marker), provide the decryption password. Leave this parameter empty if the private key is not encrypted. This password is used only to decrypt the private key and is not related to Kafka authentication.
SslKeystoreCertificateChain	string	No	[Required for mutual authentication] The Kafka client certificate chain. This parameter is required 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 begins with '-----BEGIN CERTIFICATE-----' and ends with '-----END CERTIFICATE-----', then Base64-encode the concatenated content.
SslKeystoreKey	object	No	[Required for bidirectional authentication] The SSL private key configuration object. When the Kafka server enables bidirectional SSL authentication, the client private key is required. 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:cn-hangzhou: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:cn-hangzhou:123456789:secret/ssl-keystore-key-xxxx'. You can 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. If the KMS credential is stored in a key-value (KV) structure, specify this parameter to indicate the key that corresponds to the SSL private key. Example: if the KMS credential is '{"ssl_keystore_key":"-----BEGIN PRIVATE KEY-----...","ssl_truststore_key":"..."}', set this parameter to 'ssl_keystore_key'. If the KMS credential is in plain text mode (the PEM content of the private key is stored directly), leave this parameter empty.
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-encoded PEM format, typically containing the CA certificate of the Kafka server or the server certificate itself. 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 the certificate.
Topic	string	No
VSwitchIds	string	No
ValueDataType	string	No
VpcId	string	No
SourceApacheRocketMQCheckpointParameters	object	No	The Source RocketMQ Checkpoint source.
InstanceEndpoint	string	No	The endpoint of the Apache RocketMQ instance.	192.168.1.1:9876
InstancePassword	string	No	The password of the Apache RocketMQ instance.	****
InstanceUsername	string	No	The username of the Apache RocketMQ instance.	admin
NetworkType	string	No	The network type. Valid values: PublicNetwork PrivateNetwork	PrivateNetwork
RegionId	string	No	The region ID.	cn-hangzhou
SecurityGroupId	string	No	The security group ID.	sg-mw43*****
Topics	array	No	The topics of the Apache RocketMQ instance.
	string	No	The topics of the Apache RocketMQ instance.	myTopic
VSwitchId	string	No	The vSwitch ID.	vsw-dwaafds****
VpcId	string	No	VPC ID。	vpc-adw1awdw*****
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.
Config	object	No	The connector configuration.	{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" }
Name	string	No	The connector name.	test-name
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" }
SourceCustomizedKafkaParameters	object	No	The custom Kafka event source.
InstanceId	string	No	The instance ID of ApsaraMQ for Kafka.	r-8vb64581862c****
SourceDTSParameters	object	No	The Source DTS source.
BrokerUrl	string	No	The network address and port number of the data subscription channel.
InitCheckPoint	integer	No	The consumer offset, which is the timestamp when the SDK client consumes the first data record. The value is a UNIX timestamp.	1620962769
Password	string	No	The password of the consumer group account.	admin
Sid	string	No	The consumer group ID.	hkprdb
TaskId	string	No	The task ID.	f86e5814-b223-482c-b768-3b873297****
Topic	string	No	The subscription topic of the data subscription channel.	LTC_CACHE_PRD
Username	string	No	The username of the consumer group account.	admin
SourceEventBusParameters	object	No	The Source EventBus source.
EventBusName	string	No	The event bus name.	my-event-bus
EventRuleName	string	No	The event rule name.	my-event-rule
SourceFeiShuDocsParameters	SourceFeiShuDocsParameters	No
SourceJDBCParameters	SourceJDBCParameters	No
SourceKafkaParameters	object	No	The Source Kafka source.
ConsumerGroup	string	No	The Group ID of the consumer that subscribes to the topic.	DEFAULT_GROUP
InstanceId	string	No	The instance ID.	i-8vbh4a5b9yfhgkkzm****
Network	string	No	The network configuration. Default value: Default. Set this parameter to PublicNetwork for VPC networks.	Default
OffsetReset	string	No	The offset.	latest
RegionId	string	No	The region ID.	cn-zhangjiakou
SecurityGroupId	string	No	The security group ID.	sg-uf6jcm3y5hcs7hkl****
Topic	string	No	The topic name.	topic_empower_1641539400786
VSwitchIds	string	No	The vSwitch ID.	vsw-wz9t1l1e8eu2om****
ValueDataType	string	No	The encoding and decoding parameter. Valid values: Json: The existing logic. Bytes are decoded to a character string by using UTF-8 encoding and parsed as JSON. Text: Bytes are decoded to a character string by using UTF-8 encoding and placed directly into the payload. Binary: Bytes are encoded to a character string by using Base64 encoding and placed into the payload.	Text
VpcId	string	No	The ID of the virtual private cloud (VPC).	vpc-2ze6p0o345nykmekxt****
SourceMNSParameters	object	No	The Source Simple Message Queue (formerly MNS) parameters.
IsBase64Decode	boolean	No	Specifies whether to enable Base64 encoding. Default value: true.	true
QueueName	string	No	The queue name.	queue_api_1642474203601
RegionId	string	No	The region ID.	cn-hangzhou
SourceMQTTParameters	object	No	The Source MQTT source.
BodyDataType	string	No	The message encoding format. Valid values: JSON Text Binary	JSON
InstanceId	string	No	The instance ID.	i-bp1dsudbecqwt61j****
NetworkType	string	No	The network type.
RegionId	string	No	The region ID.	cn-shanghai
SecurityGroupId	string	No	The security group ID.
Topic	string	No	The topic name.	topic_empower_1642400400779
VSwitchIds	string	No	The vSwitch IDs.
VpcId	string	No	VPC ID。
SourceMySQLParameters	SourceMySQLParameters	No	The Source MySQL source.
SourceOSSParameters	object	No	The Source OSS event source.
BucketName	string	No	The name of the bucket in Object Storage Service (OSS).	bucket_abc
Delimiter	string	No	The delimiter. In chunked loading mode, this delimiter is used as the chunk identifier for text. By default, the newline character \n is used as the delimiter.	\n
FileExtensions	array	No	The whitelist of OSS object file extensions. Objects are filtered during the scanning phase, and only objects whose extensions match the whitelist are imported into the knowledge base. Supported extensions: txt/md/markdown/html/htm/pdf/doc/docx/ppt/pptx/xls/xlsx (case-insensitive). If this parameter is not specified or is empty, no filtering by extension is applied.	["pdf","docx"]
	string	No	The extension type.	txt
LoadFormat	string	No	The document loader.	TextLoader
LoadMode	string	No	The data loading mode. A value of single indicates single-document loading, and a value of element indicates chunked loading. Valid values: single and element. Default value: single.	single
Prefix	string	No	The file path prefix.	fun/document/
RoleName	string	No	The name of the role that provides authorization for the event bus EventBridge to read OSS files. The role must have at least read-only permissions on OSS.	eventbridge_oss_role
SourceOpenSourceRabbitMQParameters	object	No	The Source open-source RabbitMQ event source.
AuthType	string	No	The authentication type.	ACL
BodyDataType	string	No	The data type of the message body.	Json
Endpoint	string	No	The instance endpoint.	192.168.1.1:9876
NetworkType	string	No	The network type. Valid values: PublicNetwork PrivateNetwork	PrivateNetwork
Password	string	No	The password used to connect to the open-source RabbitMQ instance.	****
QueueName	string	No	The queue name of the open-source RabbitMQ instance.	demo
SecurityGroupId	string	No	The security group ID.	sg-m5edtu24f12345****
Username	string	No	The username used to connect to the open-source RabbitMQ instance.	admin
VSwitchIds	string	No	The vSwitch ID.	vsw-m5ev8asdc6h12345****
VirtualHostName	string	No	The virtual host name of the open-source RabbitMQ instance.	Vhost1
VpcId	string	No	VPC ID。	vpc-m5e3sv4b12345****
SourcePostgreSQLParameters	SourcePostgreSQLParameters	No
SourcePrometheusParameters	object	No	The Source Prometheus event source.
ClusterId	string	No	The cluster ID.	c83555068b6******ad213f565f209
DataType	string	No	The data type.	Json
ExternalLabels	string	No	The external labels appended to the event stream.	{"env":"test"}
Labels	string	No	The labels.	__name__=.*
RegionId	string	No	The region ID of the instance.	cn-hangzhou
RoleName	string	No	The task role name.	test-role
SourceRabbitMQMetaParameters	SourceRabbitMQMetaParameters	No
SourceRabbitMQMsgSyncParameters	SourceRabbitMQMsgSyncParameters	No
SourceRabbitMQParameters	object	No	The Source RabbitMQ event source.
InstanceId	string	No	The instance ID of the ApsaraMQ for RabbitMQ instance.	i-f8z9lqkldlb4oxsxwwub
QueueName	string	No	The name of the queue on the ApsaraMQ for RabbitMQ instance.	demo
RegionId	string	No	The region ID.	cn-hangzhou
VirtualHostName	string	No	The name of the vhost on the ApsaraMQ for RabbitMQ instance.	eb-connect
SourceRocketMQCheckpointParameters	object	No	The Source RocketMQ Checkpoint source.
InstanceId	string	No	The instance ID of the ApsaraMQ for RocketMQ instance.	rmq-cn-jte3w******
InstanceType	string	No	The type of the ApsaraMQ for RocketMQ instance.	Cloud_5
RegionId	string	No	The region ID.	cn-hangzhou
Topics	array	No	The topics of the ApsaraMQ for RocketMQ instance.
	string	No	The topics of the ApsaraMQ for RocketMQ instance.	myTopic
SourceRocketMQParameters	object	No	The Source RocketMQ event source.
AuthType	string	No	The authentication type.	ACL
BodyDataType	string	No	The encoding format of the message body. Valid values: Json Text Binary	Json
FilterSql	string	No	The SQL filter statement.	index > 10
FilterType	string	No	The message filter type.	Tag
GroupID	string	No	The group ID of the ApsaraMQ for RocketMQ instance.	GID_test
InstanceEndpoint	string	No	The instance endpoint.	reg****-vpc.cn-zhangjiakou.aliyuncs.com
InstanceId	string	No	The instance ID of the ApsaraMQ for RocketMQ instance.	i-f8z9a9mcgwri1c1id****
InstanceNetwork	string	No	The instance network information. Valid values: PublicNetwork PrivateNetwork	PublicNetwork
InstancePassword	string	No	The instance password.	admin
InstanceSecurityGroupId	string	No	The security group information of the instance.	sg-m5edtu24f12345****
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
InstanceUsername	string	No	The instance username.	admin
InstanceVSwitchIds	string	No	The vSwitch information of the instance.	vsw-m5ev8asdc6h12****
InstanceVpcId	string	No	The VPC information of the instance.	vpc-m5e3sv4b12345****
Network	string	No	The network type. Valid values: PublicNetwork PrivateNetwork	PublicNetwork
Offset	string	No	The consumption offset of the message. Valid values: CONSUMEFROMLASTOFFSET: starts consumption from the latest offset. CONSUMEFROMFIRSTOFFSET: starts consumption from the earliest offset. CONSUMEFROMTIMESTAMP: starts consumption from the offset at a specified point in time. Default value: CONSUMEFROMLAST_OFFSET.	CONSUMEFROMLASTOFFSET
RegionId	string	No	The region ID of the ApsaraMQ for RocketMQ instance.	cn-shanghai
SecurityGroupId	string	No	The security group ID.	sg-m5edtu24f12345****
Tag	string	No	The filter tag of the message.	test
Timestamp	integer	No	The timestamp. This parameter takes effect only when the Offset parameter is set to CONSUMEFROMTIMESTAMP.	1670656652009
Topic	string	No	The topic name.	TOPIC-cainiao-pcs-order-process-inBoundConditionCheck
VSwitchIds	string	No	The vSwitch ID.	vsw-m5ev8asdc6h12345****
VpcId	string	No	The VPC ID of the instance.	vpc-m5e3sv4b12345****
SourceSLSParameters	object	No	The Source Simple Log Service (SLS) event source.
RoleName	string	No	The name of the role that provides authorization for the event bus EventBridge to read SLS log content. When you create the role in the Resource Access Management (RAM) console, set the trusted entity type to Alibaba Cloud Service and set the trusted service to event bus.	testRole
Metadata	string	No	The generic JSON Configurations for the event source. This parameter is mutually exclusive with Source.
Sink	object	No	The event target. You must select exactly one type of Sink.
SinkAgentRunParameters	SinkAgentRunParameters	No
SinkApacheKafkaParameters	object	No	The description.
Acks	string	No
Bootstraps	string	No
CompressionType	string	No
DynamicTopic	object	No	Specifies the target Topic routing strategy for messages. If both the Topic parameter and the DynamicTopic parameter are specified, the value of the DynamicTopic parameter takes precedence. The following two configuration modes are supported: 1. Static constant mode: Directly specify a fixed Topic name string (for example, "order_created"). All messages are sent to this Topic. 2. Dynamic extraction mode: Specify a standard JSONPath expression (for example, "$.user.id" or "$.metadata.category"). The system parses the upstream message body and extracts the value of the matching field as the target Topic name.
Form	string	No	The transformation type. Valid values: CONSTANT: fixed value. JSONPATH: extracts the value from the upstream based on a path.
Template	string	No	The template.
Value	string	No	The value.
Headers	object	No
Form	string	No
Template	string	No
Value	string	No
Key	object	No
Form	string	No
Template	string	No
Value	string	No
NetworkType	object	No
Form	string	No
Template	string	No
Value	string	No
SaslMechanism	string	No
SaslPassword	string	No
SaslUser	string	No
SecurityGroupId	object	No
Form	string	No
Template	string	No
Value	string	No
SecurityProtocol	string	No
SslKeyPassword	string	No	[Required for encrypted private keys] The password for the Kafka client private key. If the client private key is encrypted with a password (the PEM file contains the 'Proc-Type: 4,ENCRYPTED' or 'ENCRYPTED' marker), provide the decryption password. Leave this parameter empty if the private key is not encrypted. This password is used only to decrypt the private key and is not related to Kafka authentication.
SslKeystoreCertificateChain	string	No	[Required for mutual authentication] The Kafka client certificate chain. This parameter is required 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 begins with '-----BEGIN CERTIFICATE-----' and ends with '-----END CERTIFICATE-----', then Base64-encode the concatenated content.
SslKeystoreKey	object	No	[Required for bidirectional authentication] The SSL private key configuration object. When the Kafka server enables bidirectional SSL authentication, you must provide the client private key. Only KMS pattern is supported for the key: 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:cn-hangzhou: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:cn-hangzhou:123456789:secret/ssl-keystore-key-xxxx'. You can 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. If the KMS credential is stored in a key-value (KV) structure, specify this parameter to indicate the key that corresponds to the SSL private key. Example: if the KMS credential is '{"ssl_keystore_key":"-----BEGIN PRIVATE KEY-----...","ssl_truststore_key":"..."}', set this parameter to 'ssl_keystore_key'. If the KMS credential is in plain text mode (the PEM content of the private key is stored directly), leave this parameter empty.
SslTruststoreCertificates	string	No	[Required for SSL scenarios] The trusted certificate of the Kafka server. This certificate is used to authenticate the validity of the SSL certificate of the Kafka broker and prevent man-in-the-middle attacks. Format requirement: Base64 encoding of PEM format, which typically contains the CA certificate or the server certificate of the Kafka server. Example: Base64-encode the content of the CA signing certificate PEM file (make sure the content starts with '-----BEGIN CERTIFICATE-----' and ends with '-----END CERTIFICATE-----'). If Kafka uses a self-signed certificate, provide the CA certificate that issued the certificate.
Topic	string	No
VSwitchIds	object	No
Form	string	No
Template	string	No
Value	string	No
Value	object	No
Form	string	No
Template	string	No
Value	string	No
VpcId	object	No
Form	string	No
Template	string	No
Value	string	No
SinkApacheRocketMQCheckpointParameters	object	No	Sink Apache RocketMQ Checkpoint Parameters
ConsumeTimestamp	object	No	The timestamp for message consumption.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
Value	string	No	The timestamp.	1570761026400
Group	object	No	The Group ID of the consumer group.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
Value	string	No	Group ID	GID_EVENTBRIDGE_1736234******
InstanceEndpoint	string	No	The instance endpoint.	192.168.1.1:9876
InstancePassword	string	No	The password for authentication.	****
InstanceUsername	string	No	The username for authentication.	admin
NetworkType	string	No	The network type. Valid values: PublicNetwork PrivateNetwork	PrivateNetwork
SecurityGroupId	string	No	The security group ID.	sg-2ze5bmpw6adn0q******
Topic	object	No	The Topic of the RocketMQ instance.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
Value	string	No	The name of the Topic of the RocketMQ instance.	Mytopic
VSwitchId	string	No	The vSwitch ID.	vsw-uf62oqt1twuevrt******
VpcId	string	No	The ID of the virtual private cloud (VPC).	vpc-2zeccak5pb0j3ay******
SinkApiDestinationParameters	SinkApiDestinationParameters	No	The ApiDestination target parameters.
SinkBaiLianParameters	SinkBaiLianParameters	No	Sink BaiLian Parameters
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.
Config	object	No	The connector configuration.	{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" }
Name	string	No	The connector name.	mongo-sink
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" }
SinkCustomizedKafkaParameters	object	No	The Sink Kafka parameters.
InstanceId	string	No	The instance ID of ApsaraMQ for Kafka.	90be1f96-4229-4535-bb76-34b4f6fb2b71
SinkDashVectorParameters	object	No	The Sink DashVector parameters.
ApiKey	string	No	The API key created in the DashVector console.	Q34nExQH7sQ****
Collection	string	No	The collection name.	collection1
DashVectorSchemaParameters	array<object>	No	The schema field definition of the table entry when data is inserted into DashVector. The result after event content transformation must be in JSON format.
	array<object>	No
Name	object	No
Form	string	No
Template	string	No
Value	string	No
Type	object	No
Form	string	No
Template	string	No
Value	string	No
Value	object	No
Form	string	No
Template	string	No
Value	string	No
InstanceId	string	No	The instance ID.	vrs-cn-lbj3ru1***
Network	string	No	The network type. Valid values: PrivateNetwork PublicNetwork	PublicNetwork
Operation	string	No	The DashVector database operation type. Valid values: Delete Upsert	Upsert
Partition	object	No	The partition. Default value: default.
Form	string	No	The transformation format. Valid values: JSONPATH CONSTANT	CONSTANT
Template	string	No	None.
Value	string	No	If Form is set to CONSTANT: a constant value. If Form is set to JSONPATH: the content extracted by using JSONPath. Note The Value field cannot exceed 10,240 characters.	default
PrimaryKeyId	object	No	The primary key ID used when inserting or deleting records. If this field is not specified, a random primary key ID is used.
Form	string	No	The transformation format. Valid values: JSONPATH TEMPLATE	JSONPATH
Template	string	No	The primary key ID template. This field is required only when Form is set to TEMPLATE.	${ID}
Value	string	No	If Form is set to JSONPATH: the content extracted by using JSONPath. If Form is set to TEMPLATE: the template variable. Note The Value field cannot exceed 10,240 characters.	$.data.requestId
Vector	object	No	The vector of the record inserted into DashVector.
Form	string	No	The transformation format.	JSONPATH
Template	string	No	None.
Value	string	No	The content extracted by using JSONPath. Note The Value field cannot exceed 10,240 characters.	$.data.messageBody
SinkDataHubParameters	object	No	The Sink DataHub parameters.
Body	object	No	The record content template of the BLOB type.
Form	string	No	The transformation format.	ORIGINAL
Template	string	No	None.
Value	string	No	The record content template of the BLOB type.
ContentSchema	object	No	The key-value pairs of the custom log. This parameter takes effect only when ContentType is set to KeyValue. Each key-value pair is represented by Key_n and Value_n.
Form	string	No	The template style.	CONSTANT
Template	string	No	The template style.
Value	string	No	The value before transformation.	{"Key_1":{"form":"CONSTANT","value":"demoKey"},"Value_1":{"form":"JSONPATH","value":"$.data.value"}}
ContentType	object	No	The data format. You can select the default format or configure a specified key-value pair. Valid values: JSON KeyValue
Form	string	No	The transformation format.	CONSTANT
Template	string	No	The template style.
Value	string	No	The value before transformation.	JSON
Project	object	No	The DataHub project name.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The DataHub project name.	demo-project
RoleName	object	No	The role name of the task.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The task role name.	test-role
Topic	object	No	The DataHub topic name.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The DataHub topic name.	demo-topic
TopicSchema	object	No	The topic content schema of the TUPLE type.
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	{"k1":"${k1}","k2":"${k2}"}
Value	string	No	The topic content schema of the TUPLE type.	{"k1":"value1","k2":"value2"}
TopicType	object	No	The topic type. Valid values: TUPLE BLOB
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The topic type. Valid values: TUPLE BLOB	TUPLE
SinkDataWorksTriggerParameters	SinkDataWorksTriggerParameters	No
SinkDorisParameters	object	No	The event source type.
BeHttpEndpoint	object	No
Form	string	No
Template	string	No
Value	string	No
Body	object	No
Form	string	No
Template	string	No
Value	string	No
Database	object	No
Form	string	No
Template	string	No
Value	string	No
FeHttpEndpoint	object	No
Form	string	No
Template	string	No
Value	string	No
NetworkType	object	No
Form	string	No
Template	string	No
Value	string	No
Password	object	No
Form	string	No
Template	string	No
Value	string	No
QueryEndpoint	object	No
Form	string	No
Template	string	No
Value	string	No
SecurityGroupId	object	No
Form	string	No
Template	string	No
Value	string	No
Table	object	No
Form	string	No
Template	string	No
Value	string	No
UserName	object	No
Form	string	No
Template	string	No
Value	string	No
VSwitchIds	object	No
Form	string	No
Template	string	No
Value	string	No
VpcId	object	No
Form	string	No
Template	string	No
Value	string	No
SinkEventHouseParameters	object	No	The event target name.
CatalogName	string	No	The catalog name.	demo
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.
ColumnName	string	No	The column name.	age
ColumnType	string	No	The column type.	text
ColumnValue	object	No	The extraction rule for the column value.
Form	string	No	The transformation method, such as JSONPATH.	JSONPATH
Template	string	No	The template configuration.	The value of ${key} is ${value}!
Value	string	No	The extraction path, such as $.data.value.name.	$.data.value
NamespaceName	string	No	The namespace of the destination table.	name1
SinkFcParameters	object	No	The function target.
Body	object	No	The content body sent to the function.
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
Value	string	No	The value before transformation.	{ "key": "value" }
Concurrency	object	No	The delivery concurrency. The minimum value is 1.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The delivery concurrency. The minimum value is 1.	1
DataFormat	object	No	The format conversion rule for event content.
Form	string	No	The conversion format. Valid values: ORIGINAL: complete event JSONPATH: partial event CONSTANT: constant TEMPLATE: template	JSONPATH
Template	string	No	The template style.	$.data.key
Value	string	No	The value before transformation.	{ "key": "value" }
FunctionName	object	No	The function name.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The function name.	mFunction
InvocationType	object	No	The invocation type. Valid values: Sync: Synchronous. Async: Asynchronous.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The invocation type.	Async
Qualifier	object	No	The alias of the service to which the function belongs.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The alias of the service to which the function belongs.	LATEST
ServiceName	object	No	The name of the service.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The name of the service.	myService
SinkFnfParameters	object	No	The Sink Fnf parameters.
ExecutionName	object	No	The execution name.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
Value	string	No	The execution name.	123
FlowName	object	No	The flow name.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
Value	string	No	The flow name.	test-streaming-fnf
Input	object	No	The execution input information.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
Value	string	No	The execution input information.	123
RoleName	object	No	The role configuration.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
Value	string	No	The role configuration.	Al**FNF-x**
SinkHttpsParameters	SinkHttpsParameters	No	The HTTPS target parameters.
SinkKafkaParameters	object	No	The Sink Kafka parameters.
Acks	object	No	The acknowledgment mode for writing to Kafka. Valid values: acks=0: No response is required from the server. This mode delivers high performance but has a high risk of data loss. acks=1: A response is returned after the primary node on the server writes the data. This mode delivers moderate performance and has 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 on the server writes the data and the secondary nodes synchronize the data. This mode delivers lower performance but provides higher data security. Data loss occurs only if both the primary and secondary nodes go down.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The acknowledgment mode for writing to Kafka. Valid values: acks=0: No response is required from the server. This mode delivers high performance but has a high risk of data loss. acks=1: A response is returned after the primary node on the server writes the data. This mode delivers moderate performance and has 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 on the server writes the data and the secondary nodes synchronize the data. This mode delivers lower performance but provides higher data security. Data loss occurs only if both the primary and secondary nodes go down.	1
CompressionType	string	No
DynamicTopic	object	No	Specifies the target Topic routing strategy for messages. If both the Topic parameter and the DynamicTopic parameter are specified, the value of the DynamicTopic parameter takes precedence. The following two configuration modes are supported: 1. Static constant mode: Directly specify a fixed Topic name string (for example, "order_created"). All messages are sent to this Topic. 2. Dynamic extraction mode: Specify a standard JSONPath expression (for example, "$.user.id" or "$.metadata.category"). The system parses the upstream message body and extracts the value of the matching field as the target Topic name.
Form	string	No	The transformation type. Valid values: CONSTANT: fixed value. JSONPATH: extracts the value from the upstream based on a path.
Template	string	No	The template.
Value	string	No	The value.
Headers	object	No	The additional metadata of the Kafka message.
Form	string	No	The conversion 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}!
Value	string	No	The value before transformation.	{ "key": "value" }
InstanceId	object	No	The target service type is ApsaraMQ for Kafka.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The instance ID.	Defaut_1283278472_s****
Key	object	No	The identifier of the message.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The identifier of the message.	key
Topic	object	No	The topic name.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The topic name.	test
Value	object	No	The message body.
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
Value	string	No	The value before transformation.	{ "key": "value" }
SinkKnowledgeBaseParameters	SinkKnowledgeBaseParameters	No	The parameters for delivering the event stream to an EventHouse knowledge base. Specify this parameter only when the Sink type is knowledge base.
SinkMNSParameters	object	No	The Simple Message Queue (formerly MNS) event target.
Body	object	No	The message content.
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
Value	string	No	The value before transformation.	{ "key": "value" }
IsBase64Encode	object	No	Specifies whether to enable Base64 encoding.
Form	string	No	The format of the event transformation. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	Enables Base64 encoding.	true
QueueName	object	No	The target service type is Simple Message Queue (formerly MNS).
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The name of the queue in Simple Message Queue (formerly MNS).	MyQueue
SinkMQTTParameters	SinkMQTTParameters	No
SinkOSSParameters	SinkOSSParameters	No
SinkOpenSourceRabbitMQParameters	object	No	Sink Open Source RabbitMQ Parameters
AuthType	string	No	The authentication type. Valid values: ACL No configuration required	ACL
Body	object	No	The message body.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.	The value of ${key} is ${value}!
Value	string	No	The raw data value.	{"key": "value"}
Endpoint	string	No	The endpoint.	192.168.1.1:9876
Exchange	string	No	The exchange name in RabbitMQ. This parameter takes effect only when TargetType is set to Exchange.	my-exchange
MessageId	object	No	The unique identifier of the message.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
Value	string	No	The message ID value.	12345
NetworkType	string	No	The network type. Valid values: PrivateNetwork PublicNetwork	PublicNetwork
Password	string	No	The password for accessing the RabbitMQ instance.	****
Properties	object	No	The additional properties of the message.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.	The value of ${key} is ${value}!
Value	string	No	The property content.	{"env": "prod"}
QueueName	string	No	The queue name in RabbitMQ. This parameter takes effect only when TargetType is set to Queue.	my-queue
RoutingKey	object	No	The message routing key.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.	The value of ${key} is ${value}!
Value	string	No	The routing key value.	{"Form": "CONSTANT", "Value": "my-routing-key"}
SecurityGroupId	string	No	The security group ID.	sg-uf6of9452b2pba82c ****
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
Username	string	No	The username for accessing the RabbitMQ instance.	admin
VSwitchIds	string	No	The vSwitch ID.	vsw-uf6of9452b2pba82c ****
VirtualHostName	string	No	The virtual host name of RabbitMQ.	Vhost1
VpcId	string	No	The VPC ID.	vpc-uf6of9452b2pba82c ****
SinkPrometheusParameters	object	No	The Sink Prometheus parameters.
AuthorizationType	object	No	The authentication method.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The authentication method.	BASIC_AUTH
Data	object	No	The metric content.
Form	string	No	The transformation format. Default value: JSONPATH.	JSONPATH
Template	string	No	None.
Value	string	No	The metric content.	$.data
HeaderParameters	object	No	The data structure of the request header parameters.
Form	string	No	The transformation 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}" }
Value	string	No	If Form is set to CONSTANT: a constant value. If Form is set to JSONPATH: a JSONPath expression used to extract content. If Form is set to TEMPLATE: a template variable. Note: The Value field cannot exceed 10,240 characters.	name
NetworkType	object	No	The network type.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The network type. Valid values: PublicNetwork PrivateNetwork	PrivateNetwork
Password	object	No	The password.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The password.	abc
SecurityGroupId	object	No	The security group ID.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The security group ID.	sg-mw43*****
URL	object	No	The Prometheus Remote Write URL.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The Prometheus Remote Write URL.	https://cn-hangzhou.arms.aliyuncs.com/prometheus/167275**/c5b7faeb2e8994641***d5c559f/cn-hangzhou/api/v3/write
Username	object	No	The username.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The username.	***admin
VSwitchId	object	No	The vSwitch ID.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The vSwitch ID.	vsw-dwaafds****
VpcId	object	No	VPC ID。
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	VPC ID。	vpc-adw1awdw*****
SinkRabbitMQMetaParameters	SinkRabbitMQMetaParameters	No
SinkRabbitMQMsgSyncParameters	SinkRabbitMQMsgSyncParameters	No
SinkRabbitMQParameters	object	No	The Sink RabbitMQ parameters.
Body	object	No	The message content.
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
Value	string	No	The value before transformation.	{ "key": "value" }
Exchange	object	No	The Exchange mode. Configure this parameter only when TargetType is set to Exchange.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The name of the Exchange in the ApsaraMQ for RabbitMQ instance.	a_exchange
InstanceId	object	No	The event target type is ApsaraMQ for RabbitMQ.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The instance ID of the ApsaraMQ for RabbitMQ instance.	amqp-cn-2r42e73o****
MessageId	object	No	The message ID.
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
Value	string	No	The value before transformation.	{ "key": "value" }
Properties	object	No	The filter properties.
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
Value	string	No	The value before transformation.	{ "key": "value" }
QueueName	object	No	The Queue mode. Configure this parameter only when TargetType is set to Queue.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The name of the Queue in the instance.	MyQueue
RoutingKey	object	No	The routing rule of the message. Configure this parameter only when TargetType is set to Exchange.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The routing rule of the message.	housekeeping
TargetType	object	No	The target type.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The target type. Valid values: Exchange: Exchange mode. Queue: Queue mode.	Exchange/Queue
VirtualHostName	object	No	The name of the Vhost in the ApsaraMQ for RabbitMQ instance.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The name of the Vhost in the ApsaraMQ for RabbitMQ instance.	rabbit-host
SinkRocketMQCheckpointParameters	object	No	Sink RocketMQ Checkpoint Parameters
ConsumeTimestamp	object	No	The timestamp for message consumption.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
Value	string	No	The timestamp.	1570761026400
Group	object	No	The Group ID of the consumer group.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
Value	string	No	Group ID	GID_EVENTBRIDGE_1736234******
InstanceId	string	No	The instance ID.	MQ_INST_164901546557**_BAAN**
InstanceType	string	No	The instance type. Valid values: Cloud_4: ApsaraMQ for RocketMQ 4.0 instance. Cloud_5: ApsaraMQ for RocketMQ 5.0 instance.	Cloud_4
Topic	object	No	The topic of the ApsaraMQ for RocketMQ instance.
Form	string	No	The format of the transformation. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
Value	string	No	The topic name of the ApsaraMQ for RocketMQ instance.	Mytopic
SinkRocketMQParameters	object	No	Sink RocketMQ Parameters
Body	object	No	The message content.
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
Value	string	No	The value before transformation.	{ "key": "value" }
DeliveryOrderType	object	No	The delivery order type of messages. This parameter is optional. Default value: concurrent delivery.
Form	string	No	The format of the transformation. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
Value	string	No	The delivery order type. Valid values: Orderly: Ordered delivery. Concurrently: Concurrent delivery.	Concurrently
InstanceEndpoint	object	No	The instance endpoint.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The instance endpoint.	vbr-8vbsvkkbpf3vb0zef****
InstanceId	object	No	The event target type is ApsaraMQ for RocketMQ.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The instance ID of ApsaraMQ for RocketMQ.	MQ_INST_164901546557**_BAAN**
InstancePassword	object	No	The instance password.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The instance password.	admin****
InstanceType	object	No	The instance type.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The instance type. Valid values: Cloud_4: ApsaraMQ for RocketMQ 4.0 instance (default). Cloud_5: ApsaraMQ for RocketMQ 5.0 instance. SelfBuilt: self-managed Apache RocketMQ cluster.	Cloud_4
InstanceUsername	object	No	The instance username.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The instance username.	admin
Keys	object	No	The filter properties.
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
Value	string	No	The value before transformation.	{ "key": "value" }
Network	object	No	The network type. Valid values: PublicNetwork PrivateNetwork
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The network type. Valid values: PublicNetwork PrivateNetwork	PublicNetwork
Properties	object	No	The filter properties.
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
Value	string	No	The value before transformation.	{ "key": "value" }
SecurityGroupId	object	No	The security group ID.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The security group ID.	b4bf375515f6440f942e3a20c33d****
ShardingKey	object	No	The sharding key of the message. Note If DeliveryOrderType is set to Orderly, this parameter specifies the event content transformation rule for the ShardingKey property when messages are written to the downstream. If the source is RocketMQ, ShardingKey can be left empty. In this case, the upstream BrokerName and QueueId are concatenated to generate the message ShardingKey.
Form	string	No	The format of the transformation. Default value: CONSTANT.	CONSTANT
Template	string	No	The template style.
Value	string	No	The sharding key value.	order_id
Tags	object	No	The filter properties.
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
Value	string	No	The value before transformation.	{ "key": "value" }
Topic	object	No	The topic of the ApsaraMQ for RocketMQ instance.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The topic of the ApsaraMQ for RocketMQ instance.	Mytopic
VSwitchIds	object	No	The vSwitch ID.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The vSwitch ID.	vbr-8vb835n3zf9shwl****mp
VpcId	object	No	The VPC ID.
Form	string	No	The format of the event transformation. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The VPC ID.	vbr-8vb835n3zf9shwlvb****
SinkSLSParameters	object	No	Sink SLS Parameters
Body	object	No	The content sent to Simple Log Service (SLS).
Form	string	No	The transformation format.	TEMPLATE
Template	string	No	The template style.	The value of ${key} is ${value}!
Value	string	No	The value before transformation.	{ "key": "value" }
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.
Form	string	No	The transformation format.	CONSTANT
Template	string	No	The template style.
Value	string	No	The custom key-value pair.	{"Key_1":{"form":"CONSTANT","value":"demoKey"},"Value_1":{"form":"JSONPATH","value":"$.data.value"}}
ContentType	object	No	The data format of SLS. You can select the default format or configure specified key-value pairs. Valid values: JSON KeyValue
Form	string	No	The transformation format.	CONSTANT
Template	string	No	The template style.
Value	string	No	The data format of SLS.	JSON
LogStore	object	No	The Logstore of SLS.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The Logstore of SLS.	test-logstore
Project	object	No	The project of SLS.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The project of SLS.	test-project
RoleName	object	No	The role used for authorization of the event bus EventBridge to read SLS log content. To use this role, the following conditions must be met: when you create the role for the service in the Resource Access Management (RAM) console, set the trusted entity type to Alibaba Cloud Service and set the trusted service to event bus.
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The role used for authorization of the event bus EventBridge to read SLS log content. To use this role, the following conditions must be met: when you create the role for the service in the Resource Access Management (RAM) console, set the trusted entity type to Alibaba Cloud Service and set the trusted service to event bus.	testRole
Topic	object	No	The topic of the log, which corresponds to the SLS reserved field "topic".
Form	string	No	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	No	None.
Value	string	No	The topic of the log, which corresponds to the SLS reserved field "topic".	testTopic
RunOptions	object	No	The runtime parameters.
BatchWindow	object	No	The batching 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 one of the windows 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 one of the windows meets the threshold.	10
BusinessOption	object	No
BusinessMode	string	No
MaxCapacityUnitCount	integer	No
MinCapacityUnitCount	integer	No
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
SecurityGroupId	string	No	The security group ID of the instance where the dead-letter queue resides.	sg-2vcgdxz7o1n9zapp****
VSwitchIds	string	No	The vSwitch ID of the dead-letter queue.	vsw-m5ev8asdc6h12345****
VpcId	string	No	The VPC ID of the dead-letter queue.	vpc-2zehizpoendb3****
ErrorsTolerance	string	No	The error tolerance policy. Valid values: NONE (no tolerance for errors) and ALL (tolerate all errors).	ALL
MaximumTasks	integer	No	The concurrency.	2
RetryStrategy	object	No	The retry policy when event pushing fails.
MaximumEventAgeInSeconds	integer	No	The maximum retry time.	512
MaximumRetryAttempts	integer	No	The maximum number of retry attempts.	2
PushRetryStrategy	string	No	The retry policy. Valid values: BACKOFF_RETRY (backoff retry) and EXPONENTIAL_DECAY_RETRY (exponential decay retry).	BACKOFF_RETRY
Throttling	integer	No
Transforms	array<object>	No	The transform-related configurations.
	object	No	The ARN of the Alibaba Cloud service, such as the ARN of a function in Function Compute.
AiChunkTransformParameters	AiChunkTransformParameters	No	The AI local text chunking parameters.
AiClassifyTransformParameters	AiClassifyTransformParameters	No	The AI text classification parameters.
AiEmbedTransformParameters	AiEmbedTransformParameters	No	The AI text embedding parameters.
AiExtractTransformParameters	AiExtractTransformParameters	No	The AI information extraction parameters.
AiFilterTransformParameters	AiFilterTransformParameters	No	The AI conditional filtering parameters.
AiPrepSearchTransformParameters	AiPrepSearchTransformParameters	No	The AI semantic chunking parameters.
AiRedactTransformParameters	AiRedactTransformParameters	No	The AI data masking parameters.
AiSentimentAnalysisTransformParameters	AiSentimentAnalysisTransformParameters	No	The AI emotion analysis parameters.
AiSummarizeTransformParameters	AiSummarizeTransformParameters	No	The AI summarization parameters.
AiTranslateTransformParameters	AiTranslateTransformParameters	No	The AI translation parameters.
Arn	string	No	The ARN of the Alibaba Cloud service, such as the ARN of a function in Function Compute.	acs:fc:cn-hangzhou:*****:services/demo-service.LATEST/functions/demo-func
BaiLianAgentTransformParameters	BaiLianAgentTransformParameters	No
DashScopeTransformParameters	DashScopeTransformParameters	No

Response elements

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

Examples

Success response

JSON format

{
  "Code": "Success",
  "Message": "The name [xxxx] of event streaming in request is already exist!",
  "RequestId": "0FDD73AA-7A2D-5BD4-B4C0-88AFEBF5F0F5",
  "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.