ListEventStreamings - EventBridge - Alibaba Cloud Documentation Center

This operation queries event streams.

Operation description

This operation queries event streams.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
NamePrefix	string	No	The prefix of the event stream name.	name
Limit	integer	No	The maximum number of entries to return on each page. You can use this parameter with the NextToken parameter to implement paging. Important The value cannot exceed 100.	10
NextToken	string	No	If you set the Limit parameter and the returned results are not complete, the NextToken parameter is returned.	10
Tags	array<object>	No	Filters the results by tag.
	object	No	The tag.
Key	string	No	The tag key.	mns
Value	string	No	The tag value.	mnstest
SourceArn	string	No	The Alibaba Cloud Resource Name (ARN) of the event source.	acs:alikafka:cn-hangzhou:118609547428**:instance/alikafka_pre-cn-zxu36kvi**/topic/test-topic
SinkArn	string	No	The ARN of the event target.	acs:fc:cn-hangzhou:118609547428****:services/fw1.LATEST/functions/log1

Response elements

Element	Type	Description	Example
	object	The returned information.
Message	string	The error message.	The event streaming [xxxx] not existed!
RequestId	string	The unique identifier generated by Alibaba Cloud for the request.	283FF852-C4B8-58C9-9777-F88A5A16****
Data	object	The list of event streams.
EventStreamings	array<object>	The list of event streams.
	array<object>	The event stream entity.
EventStreamingName	string	The name of the event stream.	name
Description	string	The description of the event stream.	demo
Source	object	The event provider.
SourceMNSParameters	object	The Simple Message Queue (formerly MNS) source.
RegionId	string	The region ID.	cn-zhangjiakou
QueueName	string	The name of the MNS queue.	work4
IsBase64Decode	boolean	Specifies whether to enable Base64 encoding.	true
SourceRabbitMQParameters	object	The RabbitMQ source.
RegionId	string	The region ID.	cn-zhangjiakou
InstanceId	string	The ID of the RabbitMQ instance.	dbaudit-cn-7mz2hqo****
VirtualHostName	string	The name of the vhost of the RabbitMQ instance.	eb-connect
QueueName	string	The name of the queue in the RabbitMQ instance.	liuyang
SourceRocketMQParameters	object	The RocketMQ source.
RegionId	string	The region ID of the RocketMQ instance.	cn-chengdu
InstanceId	string	The ID of the RocketMQ instance.	i-f8zbher64dlm58pl****
Topic	string	The message topic.	topic_add_anima
Tag	string	The message filtering tag.	v1
Offset	string	The consumer offset. Valid values: CONSUMEFROMLASTOFFSET: Consumes messages from the latest offset. CONSUMEFROMFIRSTOFFSET: Consumes messages from the earliest offset. CONSUMEFROMTIMESTAMP: Consumes messages from a specified timestamp.	CONSUMEFROMTIMESTAMP
GroupID	string	The group ID of the RocketMQ instance.	GID_group1
Timestamp	integer	The timestamp. This parameter is valid only when the Offset parameter is set to CONSUMEFROMTIMESTAMP.	1670742074043
InstanceType	string	The instance type. Valid values: Cloud_4: Alibaba Cloud RocketMQ 4.0 instance (default) Cloud_5: Alibaba Cloud RocketMQ 5.0 instance SelfBuilt: Self-managed Apache RocketMQ cluster	Cloud_4
InstanceEndpoint	string	The instance endpoint.	registry-vpc.cn-hangzhou.aliyuncs.com
AuthType	string	The authentication type.	ACL
InstanceUsername	string	The instance username.	admin**
InstancePassword	string	The instance password.	123
InstanceVpcId	string	The ID of the Virtual Private Cloud (VPC).	vpc-bp1a4gmlk31hy***l3ss
InstanceVSwitchIds	string	The vSwitch information of the instance.	vsw-m5ev8asdc6h123456****
InstanceSecurityGroupId	string	The security group information of the instance.	sg-m5edtu24f12345****
InstanceNetwork	string	The network information of the instance: PublicNetwork PrivateNetwork	PublicNetwork
BodyDataType	string	The message encoding format: JSON Text Binary	JSON
Network	string	The network type. PublicNetwork PrivateNetwork	PublicNetwork
FilterType	string	The message filtering type.	Tag
FilterSql	string	The SQL filtering 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****
SourceRocketMQCheckpointParameters	object	The RocketMQ checkpoint source
RegionId	string	The region ID.	cn-hangzhou
InstanceType	string	The type of the RocketMQ instance.	Cloud_5
InstanceId	string	The ID of the RocketMQ instance.	rmq-cn-jte3w******
Topics	array	The topic of the RocketMQ instance.
	string	The topic of the RocketMQ instance.	myTopic
SourceApacheRocketMQCheckpointParameters	object	The Apache RocketMQ checkpoint source
RegionId	string	The region ID.	cn-hangzhou
Topics	array	The topic of the Apache RocketMQ instance.
	string	The topic of the Apache RocketMQ instance.	myTopic
InstanceEndpoint	string	The endpoint of the Apache RocketMQ instance.	192.168.1.1:9876
InstanceUsername	string	The username for the Apache RocketMQ instance.	admin
InstancePassword	string	The password for the Apache RocketMQ instance.	****
NetworkType	string	The network type.	PrivateNetwork
VpcId	string	The VPC ID.	vpc-adw1awdw*****
VSwitchId	string	The vSwitch ID.	vsw-dwaafds****
SecurityGroupId	string	The security group ID.	sg-mw43*****
SourceKafkaParameters	object	The Kafka source.
RegionId	string	The region ID of the instance.	cn-chengdu
InstanceId	string	The instance ID.	bastionhost-cn-i7m2gwt****
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. The value for a VPC is PublicNetwork.	Default
VpcId	string	The VPC ID of the user.	vpc-wz9ki1qdlx3cx5cbf****
VSwitchIds	string	The vSwitch ID.	vsw-bp1rmi8rind7eo50c****
SecurityGroupId	string	The security group ID.	sg-5ud5f3p0rqqis69****eho7cp
ValueDataType	string	The message body encoding and decoding format: JSON Text Binary	JSON
SourceMQTTParameters	object	The MQTT source.
RegionId	string	The region ID.	cn-qingdao
InstanceId	string	The instance ID.	bastionhost-cn-zvp27kc****
Topic	string	The topic name.	migration_instance
BodyDataType	string	The message encoding format: JSON Text Binary	JSON
SourceDTSParameters	object	The Data Transmission Service (DTS) source.
TaskId	string	The task ID.	1611b337285f44e2936a2c4170****
BrokerUrl	string	The network address and port number of the change tracking channel.	无
Topic	string	The subscription topic of the change tracking channel.	TP_TEST_UNDERWRITE_ISSUE
Sid	string	The consumer group ID.	HG9
Username	string	The account of the consumer group.	admin
Password	string	The password of the consumer group account.	123456
InitCheckPoint	string	The consumer offset, which is the UNIX timestamp when the SDK client consumes the first data entry.	1620962769
SourceSLSParameters	object	The Simple Log Service (SLS) source.
Project	string	The project in SLS.	dmmzk
LogStore	string	The Logstore in SLS.	waf-logstore
ConsumerGroup	string	The group ID of the consumer that subscribes to the topic.	go-dts-shelf-group
ConsumePosition	string	The start consumer offset. You can select the earliest or latest offset, which correspond to "begin" and "end". You can also start consumption from a specified time. Unit: seconds.	begin
RoleName	string	The role that is used to authorize EventBridge to read log content from SLS. When you create this role in the RAM console, you must select Alibaba Cloud Service for the trusted entity and EventBridge for the trusted service.	testRole
SourcePrometheusParameters	object	The Prometheus event source.
RegionId	string	The region ID.	cn-beijing
ClusterId	string	The cluster ID.	c83555068b6******ad213f565f209
DataType	string	The data type.	JSON
Labels	string	The labels.	__name__=.*
RoleName	string	The role used to access Prometheus data.	testRole
ExternalLabels	string	The custom tags attached to the event.	{"source":"prometheus-prod"}
SourceCustomizedKafkaParameters	object	The custom Kafka event source.
InstanceId	string	The instance ID.	gtm-cn-k2c2yfg****
SourceCustomizedKafkaConnectorParameters	object	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 Kafka 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" }
SourceOSSParameters	object	The Object Storage Service (OSS) event source.
RoleName	string	The name of the role that authorizes EventBridge to read files from OSS. The role must have at least the read-only permissions on OSS.	eventbridge_oss_role
BucketName	string	The name of the bucket in OSS.	bucket_abc
Prefix	string	The file path prefix.	fun/document/
LoadMode	string	The data loading mode. `single` indicates that a single document is loaded. `element` indicates that the document is loaded in chunks. Valid values: single and element. Default value: single.	single
LoadFormat	string	The document loader.	TextLoader
Delimiter	string	The separator. In chunk loading mode, this separator is used as the chunk identifier for the text. The default separator is the line feed character (\n).	\n
SourceOpenSourceRabbitMQParameters	object	The open source RabbitMQ source.
Endpoint	string	The instance endpoint.	192.168.1.1:9876
VirtualHostName	string	The name of the virtual host of the open source RabbitMQ instance.	Vhost1
QueueName	string	The name of the queue in the open source RabbitMQ instance.	demo
BodyDataType	string	The message body data type.	Json
Username	string	The username used to connect to the open source RabbitMQ instance.	admin
Password	string	The password used to connect to the open source RabbitMQ instance.	****
VpcId	string	The VPC ID.	vpc-m5e3sv4b12345****
VSwitchIds	string	The vSwitch ID.	vsw-m5ev8asdc6h12345****
SecurityGroupId	string	The security group ID.	sg-m5edtu24f12345****
NetworkType	string	The network type.	PrivateNetwork
AuthType	string	The authentication type.	ACL
SourceEventBusParameters	object	The EventBridge source.
EventBusName	string	The event bus name.	my-event-bus
EventRuleName	string	The event rule name.	my-event-rule
SourceMySQLParameters	SourceMySQLParameters	The MySQL source.
SourcePostgreSQLParameters	SourcePostgreSQLParameters
SourceRabbitMQMetaParameters	SourceRabbitMQMetaParameters
SourceRabbitMQMsgSyncParameters	SourceRabbitMQMsgSyncParameters
FilterPattern	string	The event filter pattern. If a pattern is not specified, all events are matched.	无
Transforms	array<object>	The transform configuration.
	object	The ARN of the cloud product, such as the ARN of a function in Function Compute.
Arn	string	The ARN of a cloud product, 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 Simple Message Queue (formerly MNS) queue.	MyQueue
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	None.	无
Body	object	The message body.
Value	string	The value before the transform.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The template format.	The value of ${key} is ${value}!
IsBase64Encode	object	Indicates whether to enable Base64 encoding.
Value	string	Indicates whether Base64 encoding is enabled.	true
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	None.	无
SinkFcParameters	object	The function target.
ServiceName	object	The name of the service.
Value	string	The name of the service.	myService
Form	string	The transform format. The default value is CONSTANT.	CONSTANT
Template	string	None	无
FunctionName	object	The name of the function.
Value	string	The name of the function.	mFunction
Form	string	The transform format. The default is CONSTANT.	CONSTANT
Template	string	None.	无
Concurrency	object	The delivery concurrency. The minimum value is 1.
Value	string	The delivery concurrency. The minimum value is 1.	1
Form	string	The transformation format. The default is CONSTANT.	CONSTANT
Template	string	No description is available.	无
Qualifier	object	The service alias for the function.
Value	string	The alias of the service to which the function belongs.	LATEST
Form	string	The transform format. The default value is CONSTANT.	CONSTANT
Template	string	None.	无
InvocationType	object	The invocation type. Sync: Synchronous. Async: Asynchronous.
Value	string	The invocation can be synchronous or asynchronous. Sync: Synchronous. Async: Asynchronous.	Async
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	None	无
Body	object	The content body sent to the function.
Value	string	The value before the transform.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The format of the template.	The value of ${key} is ${value}!
DataFormat	object	The transformation rule for the event content format.
Value	string	The value before the transformation.	{ "key": "value" }
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	The format of the template.	The value of ${key} is ${value}!
SinkRabbitMQParameters	object	The parameters for the RabbitMQ sink.
InstanceId	object	The target service is Message Queue for RabbitMQ.
Value	string	The ID of the ApsaraMQ for RabbitMQ instance.	si-296cd57939a1421b****
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	None.	无
VirtualHostName	object	The vhost name of the Message Queue for RabbitMQ instance.
Value	string	The name of the vhost of the ApsaraMQ for RabbitMQ instance.	rabbit-host
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	None.	无
TargetType	object	The target type.
Value	string	The target type. Valid values are Exchange (the exchange pattern) and Queue (the queue pattern).	Queue
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	None	无
Exchange	object	The Exchange pattern. This parameter is required only if the TargetType parameter is set to Exchange.
Value	string	The name of the exchange in the ApsaraMQ for RabbitMQ instance.	a_exchange
Form	string	The transform format. The default value is CONSTANT.	CONSTANT
Template	string	None	无
RoutingKey	object	The routing rule for the message. This parameter is required only if the TargetType parameter is set to Exchange.
Value	string	The routing rule for the message.	housekeeping
Form	string	The format of the transformation. The default value is CONSTANT.	CONSTANT
Template	string	None	无
QueueName	object	The Queue pattern. This parameter is required only when the TargetType parameter is set to Queue.
Value	string	The name of the queue for the instance.	MyQueue
Form	string	The transformation format. The default is CONSTANT.	CONSTANT
Template	string	None	无
Body	object	The message content.
Value	string	The value before the transform.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The template format.	The value of ${key} is ${value}!
MessageId	object	The message ID.
Value	string	The value before the transform.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The format of the template.	The value of ${key} is ${value}!
Properties	object	The filter properties.
Value	string	The value before the transformation.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The template format.	The value of ${key} is ${value}!
SinkKafkaParameters	object	The Kafka sink parameters.
InstanceId	object	The target service is Message Queue for Apache Kafka.
Value	string	The instance ID.	Defaut_1283278472_sad****
Form	string	The transform format. The default value is CONSTANT.	CONSTANT
Template	string	None.	无
CompressionType	string
Topic	object	The name of the topic.
Value	string	The topic name.	topic
Form	string	The transform format. The default value is CONSTANT.	CONSTANT
Template	string	None	无
Acks	object	The acknowledgment mode for writing data to Kafka: acks=0: No response from the server is required. This mode offers high performance but has a high risk of data loss. acks=1: A response is sent after the primary node writes the data. This mode offers medium performance and a medium risk of data loss. Data can be lost if the primary node goes down. acks=all: A response is sent only after the primary node writes the data and the secondary nodes sync it. This mode offers low performance but is very secure. Data is lost only if both the primary and all secondary nodes go down.
Value	string	The acknowledgment mode for writing data to Kafka: acks=0: The server does not send a response. This mode offers high performance with a high risk of data loss. acks=1: The server sends a response after the data is written to the primary node. This mode offers medium performance with a medium risk of data loss. Data can be lost if the primary node goes down. acks=all: The server sends a response only after the data is written to the primary node and synchronized to all secondary nodes. This mode offers low performance but ensures high data security. Data is lost only if the primary node and all secondary nodes go down.	1
Form	string	The transform format. The default is CONSTANT.	CONSTANT
Template	string	None.	无
Key	object	The identity of the message.
Value	string	The message identity.	key
Form	string	The format of the transformation. The default value is CONSTANT.	CONSTANT
Template	string	None	无
Value	object	The content of the message.
Value	string	The value before the transform.	{ "key": "value" }
Form	string	The format of the transformation.	TEMPLATE
Template	string	The template format.	The value of ${key} is ${value}!
SinkRocketMQParameters	object	The RocketMQ sink.
InstanceId	object	The target service type is Message Queue for Apache RocketMQ.
Value	string	The ID of the Message Queue for Apache RocketMQ instance.	MQ_INST_164901546557**_BAAN**
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	None	无
Topic	object	The topic of the Message Queue for Apache RocketMQ instance.
Value	string	The topic of the Message Queue for Apache RocketMQ instance.	topic
Form	string	The transform format. The default value is CONSTANT.	CONSTANT
Template	string	None	无
Body	object	The message content.
Value	string	The value before the transform.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The format of the template.	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 format.	The value of ${key} is ${value}!
Keys	object	The filter properties.
Value	string	The value before the transform.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The format of the template.	The value of ${key} is ${value}!
Tags	object	The filter properties.
Value	string	The value before the transformation.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The template format.	The value of ${key} is ${value}!
InstanceType	object	The instance type.
Value	string	The instance type. Valid values: Cloud_4: An Alibaba Cloud RocketMQ 4.0 instance (Default) Cloud_5: An Alibaba Cloud RocketMQ 5.0 instance SelfBuilt: A self-built Apache RocketMQ cluster	Cloud_4
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	None	无
InstanceEndpoint	object	The endpoint of the instance.
Value	string	The instance endpoint.	vbr-8vbsvkkbpf3vb0zef****
Form	string	The transform format. The default is CONSTANT.	CONSTANT
Template	string	None	无
InstanceUsername	object	The instance username.
Value	string	The instance username.	admin
Form	string	The transform format. The default value is CONSTANT.	CONSTANT
Template	string	None	无
InstancePassword	object	The instance password.
Value	string	The instance password.	admin******
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	Not applicable.	无
VpcId	object	The ID of the VPC.
Value	string	The VPC ID.	vbr-8vb835n3zf9shwlvb****
Form	string	The format of the event transformation. The default value is CONSTANT.	CONSTANT
Template	string	None.	无
VSwitchIds	object	The vSwitch IDs.
Value	string	The vSwitch ID.	vbr-8vb835n3zf9shwl****mp
Form	string	The transformation format. The default is CONSTANT.	CONSTANT
Template	string	None	无
SecurityGroupId	object	The security group ID.
Value	string	The ID of the security group.	b4bf375515f6440f942e3a20c33d****
Form	string	The transform format. The default value is CONSTANT.	CONSTANT
Template	string	None	无
Network	object	The network type. PublicNetwork PrivateNetwork
Value	string	The network type. PublicNetwork PrivateNetwork	PublicNetwork
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	None.	无
DeliveryOrderType	object	The delivery order type for messages.
Value	string	The delivery order type.	Orderly
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	None	无
ShardingKey	object	The sharding key for the message. This key controls message partitioning.
Value	string	The value of the sharding key.	order_id
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	The template format.	无
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	The Sink RocketMQ Checkpoint parameters.
InstanceType	string	The instance type of Message Queue for Apache RocketMQ.	Cloud_5
InstanceId	string	The RocketMQ instance ID.	MQ_INST_1825725063814405_BZ******
Topic	object	The topic of the Message Queue for Apache RocketMQ instance.
Value	string	The name of the topic.	myTopic
Form	string	The transform format. The default value is CONSTANT.	CONSTANT
Template	string	The style of the template.	无
Group	object	The consumer group for Message Queue for Apache RocketMQ.
Value	string	The group ID of the consumer group.	GID_******
Form	string	The transformation format. The default is CONSTANT.	CONSTANT
Template	string	The template style.	无
ConsumeTimestamp	object	The consumer offset.
Value	string	The timestamp.	1636597951964
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	The template style.	无
SinkApacheRocketMQCheckpointParameters	object	The Sink Apache RocketMQ Checkpoint parameters.
Topic	object	The name of the topic for the Apache RocketMQ instance.
Value	string	The name of the topic.	myTopic
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	The style of the template.	无
Group	object	The information about the consumer group for Apache RocketMQ.
Value	string	The Group ID of the consumer group.	GID_******
Form	string	The transform format. The default value is CONSTANT.	CONSTANT
Template	string	The template style.	无
ConsumeTimestamp	object	The consumer offset.
Value	string	The timestamp.	1636597951964
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	The format of the template.	无
InstanceEndpoint	string	The endpoint of the Apache RocketMQ instance.	192.168.1.1:9876
InstanceUsername	string	The username for the Apache RocketMQ instance.	admin
InstancePassword	string	The password for the Apache RocketMQ instance.	****
NetworkType	string	The network type.	PrivateNetwork
VpcId	string	The VPC ID.	vpc-2zehizpoendb3****
VSwitchId	string	The vSwitch ID.	vsw-wz9qqeovkwjxlu9uc****
SecurityGroupId	string	The ID of the security group.	sg-2vcgdxz7o1n9zapp****
SinkSLSParameters	object	The parameters for the Simple Log Service (SLS) sink.
Project	object	The Simple Log Service (SLS) log project.
Value	string	The Simple Log Service project.	test-project
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	None.	无
LogStore	object	The Logstore of Simple Log Service (SLS).
Value	string	The Simple Log Service (SLS) Logstore.	test-logstore
Form	string	The transform format. The default value is CONSTANT.	CONSTANT
Template	string	None	无
Topic	object	The topic of the log. This corresponds to the `topic` reserved field in SLS.
Value	string	The topic of the log. This corresponds to the topic reserved field in SLS.	topic
Form	string	The transform format. The default value is CONSTANT.	CONSTANT
Template	string	None	无
Body	object	The content sent to SLS.
Value	string	The value before the transformation.	{ "key": "value" }
Form	string	The transformation format.	TEMPLATE
Template	string	The template format.	The value of ${key} is ${value}!
RoleName	object	To authorize EventBridge to read SLS logs using this role, create the role in the RAM console. When creating the role, select 'Alibaba Cloud Service' and set 'Trusted Service' to 'Event Bus'.
Value	string	The role that authorizes EventBridge to read SLS logs. When you create this role in the RAM console, select "Alibaba Cloud Service" and set "Trusted Service" to "EventBridge".	test-role
Form	string	The transform format. The default is CONSTANT.	CONSTANT
Template	string	None.	无
ContentType	object	The data format for Simple Log Service (SLS). Valid values: JSON KeyValue
Value	string	The data format for SLS. Valid values: JSON KeyValue	JSON
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	None.	无
ContentSchema	object	The key-value pairs for custom logs. This parameter is valid 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 transform format. The default value is CONSTANT.	CONSTANT
Template	string	None	无
SinkFnfParameters	object	The Sink Fnf parameters.
FlowName	object	The flow name.
Value	string	The flow name.	test-streaming-fnf
Form	string	The transformation format. The default is CONSTANT.	CONSTANT
Template	string	The template style.	无
ExecutionName	object	The execution name.
Value	string	The execution name.	123
Form	string	The transformation format. The default value is CONSTANT.	CONSTANT
Template	string	The format of the template.	无
Input	object	The input for the execution.
Value	string	The input for the execution.	123
Form	string	The transform format. The default value is 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. The default is CONSTANT.	CONSTANT
Template	string	The style of the template.	无
SinkDataHubParameters	object	The DataHub sink parameters.
Project	object	The name of the DataHub project.
Value	string	The DataHub project name.	demo-project
Form	string	The format of the transformation. The default value is CONSTANT.	CONSTANT
Template	string	None	无
Topic	object	The name of the DataHub topic.
Value	string	The name of the DataHub topic.	demo-topic
Form	string	The transform format. The default value is CONSTANT.	CONSTANT
Template	string	None	无
TopicType	object	The topic type. Valid values: TUPLE BLOB
Value	string	The type of the DataHub topic. Valid values: TUPLE BLOB	TUPLE
Form	string	The format of the transformation. The default value is CONSTANT.	CONSTANT
Template	string	None.	无
TopicSchema	object	The content pattern of the topic. The type is TUPLE.
Value	string	The content pattern for a topic of the TUPLE type.	{"k1":"value1","k2":"value2"}
Form	string	The format of the transform. The default value is CONSTANT.	CONSTANT
Template	string	None.	无
Body	object	The template for the record content. The data type is BLOB.
Value	string	The template for the content of a BLOB record.	无
Form	string	The transformation format.	ORIGINAL
Template	string	None.	无
RoleName	object	The role that authorizes EventBridge to read logs from SLS. When you create this role in the RAM console, select 'Alibaba Cloud Service' and set 'Trusted Service' to 'EventBridge'.
Value	string	To grant EventBridge permission to read SLS log content using this role, create the role in the RAM console. When you create the role, select Alibaba Cloud Service and set the Trusted Service to EventBridge.	testRole
Form	string	The transform format. The default is CONSTANT.	CONSTANT
Template	string	None.	无
SinkCustomizedKafkaParameters	object	The Sink Kafka parameters.
InstanceId	string	The ID of the Kafka instance.	90be1f96-4229-4535-bb76-34b4f6fb2b71
SinkCustomizedKafkaConnectorParameters	object	The sink Kafka connector parameters.
ConnectorPackageUrl	string	The download link for the file in OSS.	"https://examplebucket.oss-cn-hangzhou.aliyuncs.com/testDoc/Old_Homebrew/2024-06-26%2022%3A34%3A08/opt/homebrew/homebrew/Library/Homebrew/test/support/fixtures/cask/AppWithBinary.zip?OSSAccessKeyId=ri&Expires=1725539627&Signature=rb8q3OpV2i3gZJ"
ConnectorParameters	object	The result of parsing the properties file in the current ZIP package.
Name	string	The name of the connector.	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 DashVector sink parameters.
InstanceId	string	The instance ID.	vrs-cn-lbj3ru1***
Collection	string	The name of the collection.	collection1
ApiKey	string	The API key created in the DashVector console.	Q34nExQH7sQ****
Operation	string	The operation type for the DashVector database.	Upsert
Network	string	The network type.	PublicNetwork
PrimaryKeyId	object	The primary key ID for inserting or deleting records. If you do not specify a value, a random primary key ID is used.
Form	string	The transformation format.	JSONPATH
Value	string	If Form is JSONPATH, the value is the content fetched by the JSONPath expression. If Form is TEMPLATE, the value is the template variable. Note: The Value field cannot exceed 10240 characters.	$.data.requestId
Template	string	The template for the primary key ID. This parameter is required only when Form is set to TEMPLATE.	${ID}
Partition	object	The partition. The default value is the default partition.
Form	string	The transformation format.	CONSTANT
Value	string	If Form is CONSTANT: The constant value. If Form is JSONPATH: The content to fetch using JSONPath. Note: The Value field cannot exceed 10,240 characters.	default
Template	string	None.	无
Vector	object	The vector of the record to insert 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 definitions for the fields of a table entry that is inserted into DashVector. The transformed event content 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	The parameters for the open-source RabbitMQ sink.
Endpoint	string	The endpoint of the RabbitMQ instance.	192.168.1.1:9876
VirtualHostName	string	The name of the RabbitMQ virtual host.	Vhost1
TargetType	string	The target type.	exchange
Exchange	string	The name of the exchange used for message routing.	my_exchange
QueueName	string	The name of the queue used to store messages.	my_queue
Username	string	The username for identity verification.	admin
Password	string	The password for identity verification.	****
VpcId	string	The VPC ID.	vpc-2zehizpoendb3****
VSwitchIds	string	The vSwitch ID.	vsw-wz9qqeovkwjxlu9uc****
SecurityGroupId	string	The security group ID.	sg-2vcgdxz7o1n9zapp****
NetworkType	string	The network type.	PrivateNetwork
AuthType	string	The authentication type.	ACL
RoutingKey	object	The routing rule for the message. This parameter is required only when the TargetType parameter is set to Exchange.
Form	string	The data format. The default value is JSONPATH.	JSONPATH
Value	string	The routing rule for the message.	housekeeping
Template	string	The template format.	The value of ${key} is ${value}!
Body	object	The message body.
Form	string	The transformation format.	TEMPLATE
Value	string	The value before the transformation.	{ "key": "value" }
Template	string	The template format.	The value of ${key} is ${value}!
MessageId	object	The message ID.
Form	string	The transformation format.	TEMPLATE
Value	string	The value before the transform.	{ "key": "value" }
Template	string	The template format.	The value of ${key} is ${value}!
Properties	object	The filter properties.
Form	string	The transformation format.	TEMPLATE
Value	string	The value before the transformation.	{ "key": "value" }
Template	string	The template format.	The value of ${key} is ${value}!
SinkBaiLianParameters	SinkBaiLianParameters	The Sink BaiLian parameters.
SinkHttpsParameters	SinkHttpsParameters
SinkApiDestinationParameters	SinkApiDestinationParameters
SinkOSSParameters	SinkOSSParameters
SinkRabbitMQMetaParameters	SinkRabbitMQMetaParameters
SinkRabbitMQMsgSyncParameters	SinkRabbitMQMsgSyncParameters
SinkMQTTParameters	SinkMQTTParameters
RunOptions	object	The runtime environment parameters.
MaximumTasks	integer	The maximum number of concurrent tasks.	2
RetryStrategy	object	The retry policy for a failed event push.
PushRetryStrategy	string	The retry policy. Valid values: BACKOFF_RETRY (backoff retry) and EXPONENTIAL_DECAY_RETRY (exponential decay retry).	EXPONENTIAL_DECAY_RETRY
ErrorsTolerance	string	The error tolerance policy. `NONE` means no errors are tolerated. `ALL` means all errors are tolerated.	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::159787121179****:role/aliyunsaedefaultrole
Network	string	The network type of the dead-letter queue.	PrivateNetwork
VpcId	string	The ID of the VPC where the dead-letter queue is located.	vpc-2zehizpoendb3****
VSwitchIds	string	The ID of the virtual switch for the dead-letter queue.	vsw-m5ev8asdc6h12345****
SecurityGroupId	string	The security group ID of the instance where the dead-letter queue is located.	sg-2vcgdxz7o1n9zapp****
BatchWindow	object	The batch window.
CountBasedWindow	integer	The maximum number of events per window. When this threshold is met, data is pushed downstream. If multiple windows exist, the first one to meet its condition triggers the push.	100
TimeBasedWindow	integer	The maximum time window in seconds. When this time threshold is reached, the data in the window is pushed downstream. If multiple window conditions exist, the push is triggered as soon as one condition is met.	10
BusinessOption	object
BusinessMode	string
MinCapacityUnitCount	integer
MaxCapacityUnitCount	integer
Throttling	integer
Status	string	The status of the event stream.	RUNNING
NextToken	string	The token that marks the last read position. If this parameter is empty, all data has been read. To continue reading, set the NextToken request parameter to this value for your next call.	177
Total	integer	The total number of records.	10
Code	string	The return code. Success: The request was successful. Other values indicate an error code. For details, 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.