GetEventStreaming

Retrieves the details of an event stream.

Operation description

Retrieves the details 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:GetEventStreaming

get

*EventStreaming

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

None

Request parameters

Parameter	Type	Required	Description	Example
EventStreamingName	string	Yes	The name of the event stream to query.	myeventstreaming

Response elements

Element	Type	Description	Example
	object	The response parameters.
Message	string	The error message.	The event streaming [xxxx] not existed!
RequestId	string	The request ID.	7892F480-58C9-5067-AB35-8A7BEF****
Data	object	The returned data.
EventStreamingName	string	The name of the event stream.	rocketmq-sync
Description	string	The description of the event stream.	RocketMQ-to-RocketMQ
Source	object	The event source.
SourceMNSParameters	object	The parameters for the Simple Message Queue (formerly MNS) source.
RegionId	string	The region ID.	cn-hangzhou
QueueName	string	The name of the queue on the Simple Message Queue (formerly MNS) instance.	demo
IsBase64Decode	boolean	Indicates whether Base64 decoding is enabled.	true
SourceRabbitMQParameters	object	The parameters for the RabbitMQ source.
RegionId	string	The region ID.	cn-hangzhou
InstanceId	string	The instance ID of the ApsaraMQ for RabbitMQ message queue instance.	i-f8z9a9mcgwri1c1i****
VirtualHostName	string	The name of the vhost on the ApsaraMQ for RabbitMQ message queue instance.	eb-connect
QueueName	string	The name of the queue on the ApsaraMQ for RabbitMQ message queue instance.	comp
SourceRocketMQParameters	object	The parameters for the RocketMQ source.
RegionId	string	The region ID of the ApsaraMQ for RocketMQ message queue instance.	cn-hangzhou
InstanceId	string	The instance ID of the ApsaraMQ for RocketMQ message queue instance.	i-f8zbher64dlm58pl****
Topic	string	The topic of the message.	topic_add_anima
Tag	string	The filter tag of the message.	v1
Offset	string	The consumption offset of the message. Valid values: CONSUME_FROM_LAST_OFFSET: consumption starts from the latest offset. CONSUME_FROM_FIRST_OFFSET: consumption starts from the earliest offset. CONSUME_FROM_TIMESTAMP: consumption starts from the offset at a specified point in time.	CONSUMEFROMLASTOFFSET
GroupID	string	The Group ID of the ApsaraMQ for RocketMQ message queue instance.	GID_group1
Timestamp	integer	The timestamp. This parameter is valid only when the Offset parameter is set to CONSUME_FROM_TIMESTAMP.	1636597951964
InstanceType	string	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
InstanceEndpoint	string	The instance endpoint.	reg****-vpc.cn-zhangjiakou.aliyuncs.com
AuthType	string	The authentication type.	ACL
InstanceUsername	string	The instance username.	xxxa
InstancePassword	string	The instance password.	xxxa
InstanceVpcId	string	The VPC ID of the instance.	vpc-m5e3sv4b12345****
InstanceVSwitchIds	string	The vSwitch IDs of the instance.	vsw-m5ev8asdc6h12****
InstanceSecurityGroupId	string	The security group ID of the instance.	sg-m5edtu24f12345****
InstanceNetwork	string	The network type of the instance. Valid values: PublicNetwork PrivateNetwork	PublicNetwork
BodyDataType	string	The encoding format of the message body. Valid values: Json Text Binary	Json
FilterType	string	The message filter type.	Tag
FilterSql	string	The SQL filter statement.	index > 10
VpcId	string	The VPC ID.	vpc-m5e3sv4b12345****
VSwitchIds	string	The vSwitch ID.	vsw-m5ev8asdc6h12345****
SecurityGroupId	string	The security group ID.	sg-m5edtu24f12345****
Network	string	The network type. Valid values: PublicNetwork PrivateNetwork	PublicNetwork
SourceRocketMQCheckpointParameters	object	The parameters for the RocketMQ checkpoint source.
RegionId	string	The region ID.	cn-hangzhou
InstanceType	string	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
InstanceId	string	The instance ID.	rmp-cn-jte3w******
Topics	array	The message topics.
	string	The message topics.	opic_add_anima
SourceApacheRocketMQCheckpointParameters	object	The parameters for the RocketMQ checkpoint source.
RegionId	string	The region ID.	cn-hangzhou
InstanceId	string	The RocketMQ instance ID.	MQ_INST_164901546557**_BAAN**
Topics	array	The list of topics.
	string	The list of topics to consume.	["Topic_1","Topic_2"]
InstanceEndpoint	string	The instance endpoint.	registry-vpc.cn-hangzhou.aliyuncs.com
InstanceUsername	string	The instance username.	admin
InstancePassword	string	The instance password.	123456
NetworkType	string	The network type.	PrivateNetwork
VpcId	string	VPC ID。	vpc-adw1awdw*****
VSwitchId	string	The vSwitch ID.	vsw-dwaafds****
SecurityGroupId	string	The security group ID.	sg-mw43*****
SourceKafkaParameters	object	The parameters for the Kafka source.
RegionId	string	The region ID of the instance.	cn-hangzhou
InstanceId	string	The instance ID.	i-bp1fbtrnqmjvgq66****
Topic	string	The topic name.	topic_empower_1642473600414
ConsumerGroup	string	The group ID of the consumer that subscribes to the topic.	GID_TEST
OffsetReset	string	The offset.	latest
Network	string	The network configuration. Default value: Default. Set this parameter to PublicNetwork for VPC networks.	Default
VpcId	string	VPC ID	vpc-2zehizpoendb3****
VSwitchIds	string	The vSwitch ID.	vsw-wz9qqeovkwjxlu9uc****
SecurityGroupId	string	The security group ID.	sg-2vcgdxz7o1n9zapp****
ValueDataType	string	The encoding and decoding format. Valid values: JSON: bytes are decoded to a string by using UTF-8 encoding and then parsed as JSON. Text: bytes are decoded to a string by using UTF-8 encoding and placed directly into the payload. Binary: bytes are encoded to a string by using Base64 encoding and placed into the payload.	Text
SourceMQTTParameters	object	The parameters for the MQTT source.
RegionId	string	The region ID.	cn-shanghai
InstanceId	string	The instance ID.	i-2ze06wqdwk0uq14k****
Topic	string	The topic name.	TOPIC-cainiao-pcs-wms-instock-noPrealertPrintLabel
BodyDataType	string	The encoding format of the message body. Valid values: JSON Text Binary	JSON
NetworkType	string	The network type.
VpcId	string	VPC ID。
VSwitchIds	string	The vSwitch ID.
SecurityGroupId	string	The security group ID.
SourceDTSParameters	object	The parameters for the Data Transmission Service (DTS) source.
TaskId	string	The task ID.	f86e5814-b223-482c-b768-3b873297****
BrokerUrl	string	The network address and port number of the data subscription channel.
Topic	string	The subscription topic of the data subscription channel.	TP_TEST_UNDERWRITE_ISSUE
Sid	string	The consumer group ID.	HD1
Username	string	The account of the consumer group.	admin
Password	string	The password of the consumer group account.	admin****
InitCheckPoint	string	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	The parameters for the Simple Log Service (SLS) source.
Project	string	The Simple Log Service project.	dmmzk
LogStore	string	The Simple Log Service Logstore.	waf-logstore
ConsumerGroup	string	The consumer group.
ConsumePosition	string	The starting consumption position. You can select the earliest or latest position, which corresponds to "begin" and "end" respectively. You can also start consumption from a specified time in seconds.	begin
RoleName	string	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	The parameters for the Prometheus event source.
RegionId	string	The region ID.	cn-hangzhou
ClusterId	string	The cluster ID.	c83555068b6******ad213f565f209
DataType	string	The data type.	Json
Labels	string	The labels.	__name__=.*
RoleName	string	The task role name.	test-role
ExternalLabels	string	The external labels appended to the event stream.	{"env":"test"}
SourceCustomizedKafkaParameters	object	The parameters for the custom Kafka event source.
InstanceId	string	The instance ID of the Message Queue for Apache Kafka message queue instance.	r-8vb64581862c****
SourceCustomizedKafkaConnectorParameters	object	The parameters for the custom Apache Kafka connector event source.
ConnectorPackageUrl	string	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	The connector parameters.
Name	string	The connector name.	test-name
Config	object	The connector configuration.	{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" }
WorkerParameters	object	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
Bootstraps	string
Topic	string
ConsumerGroup	string
OffsetReset	string
ValueDataType	string
VpcId	string
VSwitchIds	string
SecurityGroupId	string
NetworkType	string
SecurityProtocol	string
SaslMechanism	string
SaslUser	string
SaslPassword	string
SslTruststoreCertificates	string	[Required for SSL] The Kafka server trust certificate. Used to verify the SSL certificate of the Kafka broker and prevent man-in-the-middle attacks. Format: Base64-encoded 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.
SslKeystoreCertificateChain	string	[Required for mutual authentication] The Kafka client certificate chain. 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, intermediate CA certificate next, root CA certificate optional). Note: Ensure each PEM file content starts with '-----BEGIN CERTIFICATE-----' and ends with '-----END CERTIFICATE-----', then Base64-encode the concatenated content.
SslKeyPassword	string	[Required for encrypted private key] The Kafka client private key password. Required when the client private key is encrypted (the PEM file contains 'Proc-Type: 4,ENCRYPTED' or 'ENCRYPTED' markers). Leave empty if the private key is not encrypted. Note: This password is used only to decrypt the private key and is unrelated to Kafka authentication.
SslKeystoreKey	object	[Required for bidirectional authentication] The SSL private key configuration object. Required when the Kafka server enables bidirectional SSL authentication. The key supports only KMS mode: specify the Key Management Service (KMS) resource that stores the private key by using KmsArn. The system retrieves the private key content from KMS only in memory for higher security. Configuration example: {"KmsArn": "acs:kms:cn-hangzhou:123456789:secret/ssl-key-xxxx", "KmsSecretValueKey": "keystore_private_key"}
KmsArn	string	[Required] The KMS resource ARN that stores the SSL private key. Used to locate the KMS instance that stores the client private key. Format example: 'acs:kms:cn-hangzhou:123456789:secret/ssl-keystore-key-xxxx'. You can view the ARN of the corresponding key in the KMS console.
KmsSecretValueKey	string	[KMS KV mode] The key name in the KMS secret. When the KMS secret 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 secret is '{"ssl_keystore_key":"-----BEGIN PRIVATE KEY-----...","ssl_truststore_key":"..."}', specify 'ssl_keystore_key'. Leave this parameter empty if the KMS secret is in plain text mode (directly stores the PEM content of the private key).
SourceOSSParameters	object	The parameters for the OSS event source.
RoleName	string	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	The name of the OSS bucket.	bucket_abc
Prefix	string	The file path prefix.	fun/document/
LoadMode	string	The data loading mode. A value of single indicates single-document loading, and a value of element indicates chunked loading. Valid values: single/element. Default value: single.	single
LoadFormat	string	The document loader.	TextLoader
Delimiter	string	The delimiter. In chunked loading mode, this delimiter is used as the text chunking identifier. The default delimiter is the newline character .	\n
SourceOpenSourceRabbitMQParameters	object	The parameters for the open source RabbitMQ source.
Endpoint	string	The endpoint of the open source RabbitMQ instance.	192.168.1.100:5672
VirtualHostName	string	The name of the vhost on the open source RabbitMQ instance.	eb-connect
QueueName	string	The name of the queue on the open source RabbitMQ instance.	demo
BodyDataType	string	The encoding format of the message body. Valid values: JSON Text Binary	Json
Username	string	The username.	admin
Password	string	The password.	******
VpcId	string	The VPC ID.	vpc-bp1vllc1lnw1v657******
VSwitchIds	string	The vSwitch ID.	vsw-uf65zhil5oukof5******
SecurityGroupId	string	The security group ID.	sg-2ze65razphjfz3******
NetworkType	string	The network type. Valid values: PublicNetwork PrivateNetwork	PrivateNetwork
AuthType	string	The authentication type.	ACL
SourceEventBusParameters	object	The parameters for the event bus source.
EventBusName	string	The name of the event bus.	demo
EventRuleName	string	The name of the event rule.	test
SourceMySQLParameters	SourceMySQLParameters	The parameters for the MySQL source.
SourcePostgreSQLParameters	SourcePostgreSQLParameters
SourceRabbitMQMetaParameters	SourceRabbitMQMetaParameters
SourceRabbitMQMsgSyncParameters	SourceRabbitMQMsgSyncParameters
SourceFeiShuDocsParameters	SourceFeiShuDocsParameters
Metadata	string
FilterPattern	string	The event filtering rule. If not specified, all events are matched.
Transforms	array<object>	The event transformer configurations.
	object	The Alibaba Cloud Resource Name (ARN) of the cloud resource, such as the ARN of a function in Function Compute.
Arn	string	The Alibaba Cloud Resource Name (ARN) of the cloud resource, such as the ARN of a function in Function Compute.	acs:fc:cn-hangzhou:*****:services/demo-service.LATEST/functions/demo-func
DashScopeTransformParameters	DashScopeTransformParameters
BaiLianAgentTransformParameters	BaiLianAgentTransformParameters
Sink	object	The event target.
SinkMNSParameters	object	The Simple Message Queue (formerly MNS) event target.
QueueName	object	The target service type is Simple Message Queue (formerly MNS).
Value	string	The name of the queue on the Simple Message Queue (formerly MNS) instance.	MyQueue
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
Body	object	The message content.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The template style.	The value of ${key} is ${value}!
IsBase64Encode	object	Indicates whether Base64 decoding is enabled.
Value	string	Specifies whether to enable Base64 encoding.	true
Form	string	The event transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
SinkRabbitMQParameters	object	The parameters for the RabbitMQ sink.
InstanceId	object	The target service type is ApsaraMQ for RabbitMQ message queue.
Value	string	The instance ID of the ApsaraMQ for RabbitMQ message queue instance.	e5c9b727-e06c-4d7e-84d5-f8ce644e****
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	The value of ${key} is ${value}!
VirtualHostName	object	The name of the vhost on the ApsaraMQ for RabbitMQ message queue instance.
Value	string	The name of the vhost on the ApsaraMQ for RabbitMQ message queue instance.	rabbit-host
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
TargetType	object	The target type.
Value	string	The target type. Valid values: Exchange: Exchange mode. Queue: Queue mode.	Exchange/Queue
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	The value of ${key} is ${value}!
Exchange	object	The Exchange mode. This parameter is required only when TargetType is set to Exchange.
Value	string	The name of the exchange in the MSMQ for RabbitMQ instance.	a_exchange
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	The value of ${key} is ${value}!
RoutingKey	object	The routing rule of the message. This parameter is required only when TargetType is set to Exchange.
Value	string	The routing rule of the message.	housekeeping
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	The value of ${key} is ${value}!
QueueName	object	The Queue mode. This parameter is required only when TargetType is set to Queue.
Value	string	The name of the queue on the instance.	MyQueue
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	The value of ${key} is ${value}!
Body	object	The message content.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The template style.	The value of ${key} is ${value}!
MessageId	object	The message ID.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The template style.	The value of ${key} is ${value}!
Properties	object	The filter properties.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The template style.	The value of ${key} is ${value}!
SinkFcParameters	object	The function target.
ServiceName	object	The service name.
Value	string	The service name.	myService
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	The value of ${key} is ${value}!
FunctionName	object	The function name.
Value	string	The function name.	mFunction
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	The value of ${key} is ${value}!
Concurrency	object	The delivery concurrency. Minimum value: 1.
Value	string	The delivery concurrency. Minimum value: 1.	1
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	The value of ${key} is ${value}!
Qualifier	object	The service version.
Value	string	The service version.	LATEST
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	The value of ${key} is ${value}!
InvocationType	object	The invocation type. Valid values: Sync: synchronous. Async: asynchronous.
Value	string	The invocation type. Valid values: Sync: synchronous. Async: asynchronous.	Async
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	The value of ${key} is ${value}!
Body	object	The content body sent to the function.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The transformation format. Valid values: ORIGINAL: complete event JSONPATH: partial event CONSTANT: constant TEMPLATE: template For more information, see Event transformation.	TEMPLATE
Template	string	The template style.	The value of ${key} is ${value}!
DataFormat	object	The format conversion rule for event content.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The transformation format. Valid values: ORIGINAL: complete event JSONPATH: partial event CONSTANT: constant TEMPLATE: template	JSONPATH
Template	string	The template style.	$.data.key
SinkKafkaParameters	object	The parameters for the Kafka sink.
InstanceId	object	The target service type is MSMQ for Apache Kafka.
Value	string	The instance ID.	Defaut_1283278472_s****
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	The value of ${key} is ${value}!
DynamicTopic	object	Specifies the target 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 (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.
Value	string	The value.
Form	string	The transformation type. Valid values: CONSTANT: fixed value. JSONPATH: extracted from upstream based on the path.
Template	string	The template. [_single.resp.200.props.Data.Sink.SinkKafkaParameters.Topic
Topic	object	The topic name.
Value	string	The topic name.	test
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	The value of ${key} is ${value}!
CompressionType	string
Acks	object	The acknowledgment mode for writing to Kafka: acks=0: No response is required from the server. This mode offers higher performance but a greater risk of data loss. acks=1: A response is returned after the primary node on the server successfully writes the data. This mode offers moderate performance and 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 successfully writes the data and the secondary nodes complete synchronization. This mode offers lower performance but higher data safety. Data loss occurs only if both the primary and secondary nodes go down.
Value	string	The acknowledgment mode for writing to Kafka: acks=0: No response is required from the server. This mode offers higher performance but a greater risk of data loss. acks=1: A response is returned after the primary node on the server successfully writes the data. This mode offers moderate performance and 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 successfully writes the data and the secondary nodes complete synchronization. This mode offers lower performance but higher data safety. Data loss occurs only if both the primary and secondary nodes go down.	1
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	The value of ${key} is ${value}!
Key	object	The message key.
Value	string	The message key.	key
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	The value of ${key} is ${value}!
Headers	object	The additional metadata of the Kafka message.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The transformation format. Valid values: ORIGINAL: complete event JSONPATH: partial event CONSTANT: constant TEMPLATE: template	CONSTANT
Template	string	The template style.	The value of ${key} is ${value}!
Value	object	The message body.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The template style.	The value of ${key} is ${value}!
SinkApacheKafkaParameters	object	The description information.
Bootstraps	string
Topic	string
DynamicTopic	object	Specifies the target 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 (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.
Value	string	The value.
Form	string	The transformation type. Valid values: CONSTANT: fixed value. JSONPATH: extracted from upstream based on the path.
Template	string	The template. [_single.resp.200.props.Data.Sink.SinkKafkaParameters.Topic
Acks	string
CompressionType	string
Key	object
Value	string
Form	string
Template	string
Headers	object
Value	string
Form	string
Template	string
Value	object
Value	string
Form	string
Template	string
SecurityProtocol	string
SaslMechanism	string
SaslUser	string
VpcId	object
Value	string
Form	string
Template	string
VSwitchIds	object
Value	string
Form	string
Template	string
SecurityGroupId	object
Value	string
Form	string
Template	string
NetworkType	object
Value	string
Form	string
Template	string
SaslPassword	string
SslTruststoreCertificates	string	[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.
SslKeystoreCertificateChain	string	[Required for mutual authentication] The Kafka client certificate chain. 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, intermediate CA certificate next, root CA certificate optional). Note: Ensure each PEM file content starts with '-----BEGIN CERTIFICATE-----' and ends with '-----END CERTIFICATE-----', then Base64-encode the concatenated content.
SslKeyPassword	string	[Required for encrypted private key] The Kafka client private key password. Required when the client private key is encrypted (the PEM file contains 'Proc-Type: 4,ENCRYPTED' or 'ENCRYPTED' markers). Leave empty if the private key is not encrypted. Note: This password is used only to decrypt the private key and is unrelated to Kafka authentication.
SslKeystoreKey	object	[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 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"}
KmsArn	string	[Required] The KMS resource ARN that stores the SSL private key. Used to locate the KMS instance that stores the client private key. Format example: 'acs:kms:cn-hangzhou:123456789:secret/ssl-keystore-key-xxxx'. You can view the ARN of the corresponding key in the KMS console.
KmsSecretValueKey	string	[KMS KV mode] The key name in the KMS secret. When the KMS secret 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 secret is '{"ssl_keystore_key":"-----BEGIN PRIVATE KEY-----...","ssl_truststore_key":"..."}', specify 'ssl_keystore_key'. Leave this parameter empty if the KMS secret is in plain text mode (directly stores the PEM content of the private key).
SinkRocketMQParameters	object	Sink RocketMQ Parameters
InstanceId	object	The target service type is MSMQ for RocketMQ.
Value	string	The instance ID of the MSMQ for RocketMQ instance.	MQ_INST_164901546557**_BAAN**
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	The value of ${key} is ${value}!
Topic	object	The topic of the MSMQ for RocketMQ instance.
Value	string	The topic name of the MSMQ for RocketMQ instance.	Mytopic
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.	The value of ${key} is ${value}!
Body	object	The message content.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The template style.	The value of ${key} is ${value}!
Properties	object	The filter properties.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The template style.	The value of ${key} is ${value}!
Keys	object	The filter properties.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The template style.	The value of ${key} is ${value}!
Tags	object	The filter properties.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The template style.	The value of ${key} is ${value}!
InstanceType	object	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
Value	string	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
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	None.
InstanceEndpoint	object	The instance endpoint.
Value	string	The instance endpoint.	vbr-8vbsvkkbpf3vb0zef****
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	None.
InstanceUsername	object	The instance username.
Value	string	The instance username.	admin
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	None.
InstancePassword	object	The instance password.
Value	string	The instance password.	admin****
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	None.
VpcId	object	The VPC ID.
Value	string	The VPC ID.	vbr-8vb835n3zf9shwlvb****
Form	string	The event transformation format. Default value: CONSTANT.	CONSTANT
Template	string	None.
VSwitchIds	object	The vSwitch ID.
Value	string	The vSwitch ID.	vbr-8vb835n3zf9shwl****mp
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	None.
SecurityGroupId	object	The security group ID.
Value	string	The security group ID.	b4bf375515f6440f942e3a20c33d****
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	None.
Network	object	The network type. Valid values: PublicNetwork PrivateNetwork
Value	string	The network type. Valid values: PublicNetwork PrivateNetwork	PublicNetwork
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	None.
DeliveryOrderType	object	The delivery order type of messages. Optional. The default value is concurrent delivery.
Value	string	The delivery order type. Valid values: Orderly: Ordered delivery. Concurrently: Concurrent delivery.	Concurrently
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
ShardingKey	object	The sharding key of the message. Note ShardingKey is required when DeliveryOrderType is set to Orderly. When Source is RocketMQ, ShardingKey can be left empty. In this case, the upstream BrokerName and QueueId are concatenated to generate the message ShardingKey.
Value	string	The sharding key value.	order_id
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
SinkDorisParameters	object
QueryEndpoint	object
Value	string
Form	string
Template	string
FeHttpEndpoint	object
Value	string
Form	string
Template	string
BeHttpEndpoint	object
Value	string
Form	string
Template	string
UserName	object
Value	string
Form	string
Template	string
Password	object
Value	string
Form	string
Template	string
Database	object
Value	string
Form	string
Template	string
Table	object
Value	string
Form	string
Template	string
Body	object
Value	string
Form	string
Template	string
NetworkType	object
Value	string
Form	string
Template	string
VpcId	object
Value	string
Form	string
Template	string
VSwitchIds	object
Value	string
Form	string
Template	string
SecurityGroupId	object
Value	string
Form	string
Template	string
SinkRocketMQCheckpointParameters	object	Sink RocketMQ Checkpoint Parameters
InstanceType	string	The instance type. Valid values: Cloud_4: ApsaraMQ for RocketMQ 4.0 instance. Cloud_5: ApsaraMQ for RocketMQ 5.0 instance.	Cloud_4
InstanceId	string	The instance ID.	MQ_INST_164901546557**_BAAN**
Topic	object	The topic of the MSMQ for RocketMQ instance.
Value	string	The topic name of the MSMQ for RocketMQ instance.	Mytopic
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
Group	object	The Group ID of the consumer group.
Value	string	Group ID	GID_EVENTBRIDGE_1736234******
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
ConsumeTimestamp	object	The timestamp of message consumption.
Value	string	The timestamp.	1570761026400
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
SinkApacheRocketMQCheckpointParameters	object	Sink Apache RocketMQ Checkpoint Parameters
Topic	object	The topic of the RocketMQ instance.
Value	string	The topic name of the RabbitMQ instance.	Mytopic
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
Group	object	The Group ID of the consumer group.
Value	string	Group ID	GID_EVENTBRIDGE_1736234******
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
ConsumeTimestamp	object	The timestamp of message consumption.
Value	string	The timestamp.	1570761026400
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
InstanceEndpoint	string	The instance endpoint.	192.168.1.1:9876
InstanceUsername	string	The username required for authentication.	admin
InstancePassword	string	The password for the username.	****
NetworkType	string	The network type.	PrivateNetwork
VpcId	string	The VPC ID.	vpc-2zeccak5pb0j3ay******
VSwitchId	string	The vSwitch ID.	vsw-uf62oqt1twuevrt******
SecurityGroupId	string	The security group ID.	sg-2ze5bmpw6adn0q******
SinkSLSParameters	object	Sink SLS Parameters
Project	object	The Simple Log Service project.
Value	string	The Simple Log Service project.	test-project
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
LogStore	object	The Simple Log Service Logstore.
Value	string	The Simple Log Service Logstore.	test-logstore
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
Topic	object	The topic where the log resides, corresponding to the Simple Log Service reserved field "topic".
Value	string	The topic where the log resides, corresponding to the Simple Log Service reserved field "topic".	testTopic
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
Body	object	The content sent to Simple Log Service.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The template style.	The value of ${key} is ${value}!
RoleName	object	To grant authorization to the event bus EventBridge to use this role to read Simple Log Service log content, the following condition must be met: when creating the role used by the service in the Resource Access Management (RAM) console, select "Alibaba Cloud Service" and set "Trusted Service" to "event bus".
Value	string	To grant authorization to the event bus EventBridge to use this role to read Simple Log Service log content, the following condition must be met: when creating the role used by the service in the Resource Access Management (RAM) console, select "Alibaba Cloud Service" and set "Trusted Service" to "event bus".	testRole
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
ContentType	object	The Simple Log Service data format. You can select the default format or configure a specified key-value pair. Valid values: JSON KeyValue
Value	string	The value before transformation.	JSON
Form	string	The transformation format.	CONSTANT
Template	string	The template style.
ContentSchema	object	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	The value before transformation.	{"Key_1":{"form":"CONSTANT","value":"demoKey"},"Value_1":{"form":"JSONPATH","value":"$.data.value"}}
Form	string	The template style.	CONSTANT
Template	string	The template style.
SinkFnfParameters	object	The Sink CloudFlow parameters.
FlowName	object	The flow name.
Value	string	The flow name.	test-streaming-fnf
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
ExecutionName	object	The execution name.
Value	string	The execution name.	123
Form	string	The transformation format. Default value: CONSTANT. Valid values: JSONPATH: partial event. CONSTANT: constant. TEMPLATE: template. For more information, see Event transformation.	CONSTANT
Template	string	The template style.
Input	object	The execution input information.
Value	string	The execution input information.	123
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
RoleName	object	The role configuration.
Value	string	The role configuration.	Al**FNF-x**
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	The template style.
SinkDataHubParameters	object	The Sink DataHub parameters.
Project	object	The DataHub project name.
Value	string	The DataHub project name.	demo-project
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	None.
Topic	object	The DataHub topic name.
Value	string	The DataHub topic name.	demo-topic
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	None.
TopicType	object	The topic type. Valid values: TUPLE BLOB
Value	string	The topic type. Valid values: TUPLE BLOB	TUPLE
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	None.
TopicSchema	object	The topic content schema for the TUPLE type.
Value	string	The topic content schema for the TUPLE type.	{"k1":"value1","k2":"value2"}
Form	string	The transformation format.	TEMPLATE
Template	string	The template style.	{"k1":"${k1}","k2":"${k2}"}
Body	object	The Record content template for the BLOB type.
Value	string	The Record content template for the BLOB type.
Form	string	The transformation format.	ORIGINAL
Template	string	None.
RoleName	object	The task role name.
Value	string	The task role name.	test-role
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Template	string	None.
SinkCustomizedKafkaParameters	object	The Sink Kafka parameters.
InstanceId	string	The instance ID of the MSMQ for Apache Kafka instance.	90be1f96-4229-4535-bb76-34b4f6fb****
SinkCustomizedKafkaConnectorParameters	object	The Sink Kafka connector parameters.
ConnectorPackageUrl	string	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=rb8q3OpV******"
ConnectorParameters	object	Parses the properties file in the current ZIP package.
Name	string	The connector name.	mongo-sink
Config	object	The connector configuration.	{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" }
WorkerParameters	object	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	The Sink DashVector parameters.
InstanceId	string	The instance ID.	vrs-cn-lbj3ru1***
Collection	string	The collection name.	collection1
ApiKey	string	The API key created in the DashVector console.	Q34nExQH7sQ****
Operation	string	The DashVector database operation type.	Upsert
Network	string	The network type.	PublicNetwork
PrimaryKeyId	object	The primary key ID for inserting or deleting records. If this field is not specified, a random primary key ID is used.
Form	string	The transformation format.	JSONPATH
Value	string	If Form is JSONPATH: the content extracted by JSONPath. If Form is TEMPLATE: the template variable. Note: The Value field cannot exceed 10,240 characters.	$.data.requestId
Template	string	The primary key ID template. This parameter is required only when Form is set to TEMPLATE.	${ID}
Partition	object	The partition. Default value: default.
Form	string	The transformation format.	CONSTANT
Value	string	If Form is CONSTANT: the constant value. If Form is JSONPATH: the content extracted by JSONPath. Note: The Value field cannot exceed 10,240 characters.	default
Template	string	None.
Vector	object	The vector of the record inserted into DashVector.
Form	string	The transformation format.	JSONPATH
Value	string	The content extracted by JSONPath. Note: The Value field cannot exceed 10,240 characters.	$.data.messageBody
Template	string	None.
DashVectorSchemaParameters	array<object>	The schema field definition of the table entry when inserting into DashVector. The result of event content transformation must be in JSON format.
	array<object>
Name	object
Form	string
Value	string
Template	string
Type	object
Form	string
Value	string
Template	string
Value	object
Form	string
Value	string
Template	string
SinkOpenSourceRabbitMQParameters	object	Sink Open Source RabbitMQ Parameters
Endpoint	string	The endpoint.	192.168.1.1:9876
VirtualHostName	string	The virtual host name of RabbitMQ.	vhost1
TargetType	string	The target type for message delivery. This parameter takes effect only when TargetType is set to Exchange.	Exchange
Exchange	string	The exchange name in RabbitMQ.	my-exchange
QueueName	string	The queue name in RabbitMQ. This parameter takes effect only when TargetType is set to Queue.	my-queue
Username	string	The username for accessing the RabbitMQ instance.	admin
Password	string	The password for accessing the RabbitMQ instance.	****
VpcId	string	The VPC ID.	vpc-uf6of9452b2pba82c ****
VSwitchIds	string	The vSwitch ID.	vsw-uf6of9452b2pba82c ****
SecurityGroupId	string	The security group ID.	sg-uf6of9452b2pba82c ****
NetworkType	string	The network type.	PublicNetwork
AuthType	string	The authentication type.	ACL
RoutingKey	object	The message routing key.
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Value	string	The routing key value.	{"Form": "CONSTANT", "Value": "my-routing-key"}
Template	string	The template style.	The value of ${key} is ${value}!
Body	object	The message body content.
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Value	string	The raw data value.	{"key": "value"}
Template	string	The template style.	The value of ${key} is ${value}!
MessageId	object	The unique identifier of the message.
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Value	string	The message ID value.	12345
Template	string	The template style.
Properties	object	The additional properties of the message.
Form	string	The transformation format. Default value: CONSTANT.	CONSTANT
Value	string	The property content.	{"env": "prod"}
Template	string	The template style.	The value of ${key} is ${value}!
SinkBaiLianParameters	SinkBaiLianParameters	Sink BaiLian Parameters
SinkDataWorksTriggerParameters	SinkDataWorksTriggerParameters
SinkHttpsParameters	SinkHttpsParameters	The HTTPS target parameters.
SinkApiDestinationParameters	SinkApiDestinationParameters	The ApiDestination target parameters.
SinkOSSParameters	SinkOSSParameters
SinkRabbitMQMetaParameters	SinkRabbitMQMetaParameters
SinkRabbitMQMsgSyncParameters	SinkRabbitMQMsgSyncParameters
SinkMQTTParameters	SinkMQTTParameters
SinkAgentRunParameters	SinkAgentRunParameters
RunOptions	object	The runtime environment parameters.
MaximumTasks	integer	The concurrency.	2
RetryStrategy	object	The retry strategy when event delivery fails.
PushRetryStrategy	string	The retry strategy: BACKOFF_RETRY (backoff retry) or EXPONENTIALDECAY_RETRY (exponential decay retry).	BACKOFF_RETRY
MaximumEventAgeInSeconds	number	The maximum retry time.	512
MaximumRetryAttempts	number	The maximum number of retry attempts.	2
ErrorsTolerance	string	The fault tolerance policy: NONE (no fault tolerance) or ALL (tolerate all exceptions).	ALL
DeadLetterQueue	object	Specifies whether to enable the dead-letter queue. By default, the dead-letter queue is disabled, and messages that exceed the retry policy are discarded.
Arn	string	The ARN of the dead-letter queue.	acs:ram::155020394332****:role/edskmstoecs
Network	string	The network type of the dead-letter queue.	PrivateNetwork
VpcId	string	The VPC ID where the dead-letter queue resides.	vpc-2zehizpoendb3****
VSwitchIds	string	The vSwitch ID where the dead-letter queue resides.	vsw-m5ev8asdc6h12345****
SecurityGroupId	string	The security group ID of the instance where the dead-letter queue resides.	sg-2vcgdxz7o1n9zapp****
BatchWindow	object	The batching window.
CountBasedWindow	integer	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, data is pushed when any one window meets the threshold.	100
TimeBasedWindow	integer	The maximum time range (in seconds) for events in the window. When this threshold is reached, the data in the window is pushed downstream. If multiple windows exist, data is pushed when any one window meets the threshold.	10
BusinessOption	object
BusinessMode	string
MinCapacityUnitCount	integer
MaxCapacityUnitCount	integer
Throttling	integer
Status	string	The status of the retrieved event stream.	RUNNING
DetailedStatus	object	The detailed status.
TPS	number	The transactions per second.	5
DelayTime	integer	The delay time.	3
DiffOffset	integer	The difference offset.	0
Extensions	object	The extension properties.	{ "test": "test", "test2": 1 }
Code	string	The response code. Success indicates a successful operation. Other values indicate error codes. For more information, see Error codes.	Success
Success	boolean	Returns true if the operation is successful.	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.