ListEventStreamings - EventBridge - Alibaba Cloud Documentation Center

Queries event streams.

Operation description

You can call this API operation to query event streams.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
eventbridge:ListEventStreamings	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
NamePrefix	string	No	The name of the event stream that you want to query.	name
Limit	long	No	The maximum number of entries to be returned in a call. You can use this parameter and NextToken to implement paging. A maximum of 100 entries can be returned in a call.	10
NextToken	string	No	If you configure Limit and excess return values exist, this parameter is returned.	10
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 parameters

Parameter	Type	Description	Example
	object
Message	string	The returned error message.	The event streaming [xxxx] not existed!
RequestId	string	The request ID.	283FF852-C4B8-58C9-9777-F88A5A16A79F
Data	object	The returned data.
EventStreamings	array<object>	The event streams.
EventStreamings	object
EventStreamingName	string	The name of the event stream.	name
Description	string	The description of the event stream.	demo
Source	object	The event provider, which is also known as the event source.
SourceMNSParameters	object	The parameters that are returned if Message Queue (MNS) is specified as the event source.
RegionId	string	The ID of the region where the MNS queue resides.	cn-zhangjiakou
QueueName	string	The name of the MNS queue.	work4
IsBase64Decode	boolean	Indicates whether Base64 encoding is enabled.	true
SourceRabbitMQParameters	object	The parameters that are returned if ApsaraMQ for RabbitMQ is specified as the event source.
RegionId	string	The ID of the region where the ApsaraMQ for RabbitMQ instance resides.	cn-zhangjiakou
InstanceId	string	The ID of the ApsaraMQ for RabbitMQ instance.	dbaudit-cn-7mz2hqolc06
VirtualHostName	string	The name of the vhost to which the ApsaraMQ for RabbitMQ instance belongs.	eb-connect
QueueName	string	The name of the queue on the ApsaraMQ for RabbitMQ instance.	liuyang
SourceRocketMQParameters	object	The parameters that are returned if ApsaraMQ for RocketMQ is specified as the event source.
RegionId	string	The ID of the region where the ApsaraMQ for RocketMQ instance resides.	cn-chengdu
InstanceId	string	The ID of the ApsaraMQ for RocketMQ instance	i-f8zbher64dlm58plyfte
Topic	string	The topic from which messages are sent.	topic_add_anima
Tag	string	The tag that is used to filter messages.	v1
Offset	string	The offset from which messages are consumed. Valid values: CONSUMEFROMLASTOFFSET: Messages are consumed from the latest offset. CONSUMEFROMFIRSTOFFSET: Messages are consumed from the earliest offset. CONSUME_FROM_TIMESTAMP: Messages are consumed from the offset at the specified point in time.	CONSUMEFROMTIMESTAMP
GroupID	string	The ID of the consumer group on the ApsaraMQ for RocketMQ instance.	GID_group1
Timestamp	long	The timestamp that indicates the time from which messages are consumed. This parameter is valid only if Offset is set to CONSUMEFROMTIMESTAMP.	1670742074043
InstanceType	string	The type of the ApsaraMQ for RocketMQ instance.	2
InstanceEndpoint	string	The endpoint that is used to access the ApsaraMQ for RocketMQ instance.	registry-vpc.cn-hangzhou.aliyuncs.com
AuthType	string	The authentication method.	ACL
InstanceUsername	string	The username that is used to access the ApsaraMQ for RocketMQ instance.	admin**
InstancePassword	string	The password that is used to access the ApsaraMQ for RocketMQ instance.	123
InstanceVpcId	string	The ID of the virtual private cloud (VPC) to which the ApsaraMQ for RocketMQ instance belongs.	vpc-bp1a4gmlk31hy***l3ss
InstanceVSwitchIds	string	The ID of the vSwitch with which the ApsaraMQ for RocketMQ instance is associated.	vsw-m5ev8asdc6h123456****
InstanceSecurityGroupId	string	The ID of the security group to which the ApsaraMQ for RocketMQ instance belongs.	sg-m5edtu24f12345****
InstanceNetwork	string	The network type of the ApsaraMQ for RocketMQ instance. Valid values: PublicNetwork PrivateNetwork	PublicNetwork
SourceKafkaParameters	object	The parameters that are returned if ApsaraMQ for Kafka is specified as the event source.
RegionId	string	The ID of the region where the ApsaraMQ for Kafka instance resides.	cn-chengdu
InstanceId	string	The ID of the ApsaraMQ for Kafka instance.	bastionhost-cn-i7m2gwt7z1n
Topic	string	The name of the topic on the ApsaraMQ for Kafka instance.	topic_empower_1642473600414
ConsumerGroup	string	The group ID of the consumer that subscribes to the topic.	GID_TEST
OffsetReset	string	The offset from which messages are consumed.	latest
Network	string	The network type. Default value: Default. The value PublicNetwork indicates a VPC.	Default
VpcId	string	The ID of the VPC to which the ApsaraMQ for Kafka instance belongs.	vpc-wz9ki1qdlx3cx5cbbhowf
VSwitchIds	string	The ID of the vSwitch with which the ApsaraMQ for Kafka instance is associated.	vsw-bp1rmi8rind7eo50cbied
SecurityGroupId	string	The ID of the security group to which the ApsaraMQ for Kafka instance belongs.	sg-5ud5f3p0rqqis69tpp8eho7cp
SourceMQTTParameters	object	The parameters that are returned if ApsaraMQ for MQTT is specified as the event source.
RegionId	string	The ID of the region where the ApsaraMQ for MQTT instance resides.	cn-qingdao
InstanceId	string	The ID of the ApsaraMQ for MQTT instance.	bastionhost-cn-zvp27kcha1r
Topic	string	The name of the topic on the ApsaraMQ for MQTT instance.	migration_instance
SourceDTSParameters	object	The parameters that are returned if Data Transmission Service (DTS) is specified as the event source.
TaskId	string	The task ID.	1611b337285f44e2936a2c4170bbbb7f
BrokerUrl	string	The URL and port number of the change tracking instance.
Topic	string	The name of the tracked topic of the change tracking instance.	TP_TEST_UNDERWRITE_ISSUE
Sid	string	The consumer group ID.	HG9
Username	string	The consumer group username.	admin
Password	string	The consumer group password.	123456
InitCheckPoint	string	The UNIX timestamp that is generated when the SDK client consumes the first data record.	1620962769
SourceSLSParameters	object	The parameters that are returned if Simple Log Service is specified as the event source.
Project	string	The Simple Log Service project.	dmmzk
LogStore	string	The Simple Log Service Logstore.	waf-logstore
ConsumerGroup	string	The group ID of the consumer that subscribes to the topic.	go-dts-shelf-group
ConsumePosition	string	The consumer offset. The value begin indicates the earliest offset. The value end indicates the latest offset. You can also specify a time in seconds to start message consumption.	begin
RoleName	string	The role name. If you want to authorize EventBridge to use this role to read logs in Simple Log Service, you must select Alibaba Cloud Service for Selected Trusted Entity and EventBridge for Select Trusted Service when you create the role in the Resource Access Management (RAM) console.	testRole
FilterPattern	string	The rule that is used to filter events. If you leave this parameter empty, all events are matched.
Transforms	array<object>	The transformation-related configurations.
Transforms	object
Arn	string	The Alibaba Cloud Resource Name (ARN) of the cloud service, such as the ARN of a Function Compute function.	acs:fc:cn-hangzhou:*****:services/demo-service.LATEST/functions/demo-func
Sink	object	The event target.
SinkMNSParameters	object	The parameters that are returned if MNS is specified as the event target.
QueueName	object	The name of the MNS queue.
Value	string	The name of the MNS queue.	MyQueue
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
Body	object	The message content.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The method that is used to transform events.	TEMPLATE
Template	string	The template based on which events are transformed.	The value of ${key} is ${value}!
IsBase64Encode	object	Indicates whether Base64 encoding is enabled.
Value	string	Indicates that Base64 encoding is enabled.	true
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
SinkFcParameters	object	The parameters that are returned if Function Compute is specified as the event target.
ServiceName	object	The service name.
Value	string	The service name.	myService
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
FunctionName	object	The function name.
Value	string	The function name.	mFunction
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
Concurrency	object	The delivery concurrency. Minimum value: 1.
Value	string	The delivery concurrency. Minimum value: 1.	1
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
Qualifier	object	The alias of the service to which the function belongs.
Value	string	The alias of the service to which the function belongs.	LATEST
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
InvocationType	object	The invocation mode. Valid values: Sync Async
Value	string	The invocation mode. Valid values: Sync Async	Async
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
Body	object	The message body that is delivered to Function Compute.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The method that is used to transform events.	TEMPLATE
Template	string	The template based on which events are transformed.	The value of ${key} is ${value}!
SinkRabbitMQParameters	object	The parameters that are returned if ApsaraMQ for RabbitMQ is specified as the event target.
InstanceId	object	The ID of the ApsaraMQ for RabbitMQ instance.
Value	string	The ID of the ApsaraMQ for RabbitMQ instance.	si-296cd57939a1421b94ec
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
VirtualHostName	object	The name of the vhost to which the ApsaraMQ for RabbitMQ instance belongs.
Value	string	The name of the vhost to which the ApsaraMQ for RabbitMQ instance belongs.	rabbit-host
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
TargetType	object	The type of the resource to which events are delivered.
Value	string	The type of the resource to which events are delivered. Valid values: Exchange and Queue.	Queue
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
Exchange	object	The exchange mode. This parameter is required only if TargetType is set to Exchange.
Value	string	The name of the exchange on the ApsaraMQ for RabbitMQ instance.	a_exchange
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
RoutingKey	object	The rule that is used to route messages. This parameter is required only if TargetType is set to Exchange.
Value	string	The rule that is used to route messages.	housekeeping
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
QueueName	object	The queue mode. This parameter is required only if TargetType is set to Queue.
Value	string	The name of the queue on the ApsaraMQ for RabbitMQ instance.	MyQueue
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
Body	object	The message content.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The method that is used to transform events.	TEMPLATE
Template	string	The template based on which events are transformed.	The value of ${key} is ${value}!
MessageId	object	The message ID.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The method that is used to transform events.	TEMPLATE
Template	string	The template based on which events are transformed.	The value of ${key} is ${value}!
Properties	object	The properties that are used to filter messages.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The method that is used to transform events.	TEMPLATE
Template	string	The template based on which events are transformed.	The value of ${key} is ${value}!
SinkKafkaParameters	object	The parameters that are returned if ApsaraMQ for Kafka is specified as the event target.
InstanceId	object	The ID of the ApsaraMQ for Kafka instance.
Value	string	The ID of the ApsaraMQ for Kafka instance.	Defaut_1283278472_sadkj
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
Topic	object	The name of the topic on the ApsaraMQ for Kafka instance.
Value	string	The name of the topic on the ApsaraMQ for Kafka instance.	topic
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
Acks	object	The acknowledgment (ACK) mode. If you set this parameter to 0, no response is returned from the broker. In this mode, the performance is high, but the risk of data loss is also high. If you set this parameter to 1, a response is returned when data is written to the leader. In this mode, the performance and the risk of data loss are moderate. Data loss may occur if a failure occurs on the leader. If you set this parameter to all, a response is returned when data is written to the leader and synchronized to the followers. In this mode, the performance is low, but the risk of data loss is also low. Data loss occurs if the leader and the followers fail at the same time.
Value	string	The ACK mode. If you set this parameter to 0, no response is returned from the broker. In this mode, the performance is high, but the risk of data loss is also high. If you set this parameter to 1, a response is returned when data is written to the leader. In this mode, the performance and the risk of data loss are moderate. Data loss may occur if a failure occurs on the leader. If you set this parameter to all, a response is returned when data is written to the leader and synchronized to the followers. In this mode, the performance is low, but the risk of data loss is also low. Data loss occurs if the leader and the followers fail at the same time.	1
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
Key	object	The message key.
Value	string	The message key.	key
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
Value	object	The message body.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The method that is used to transform events.	TEMPLATE
Template	string	The template based on which events are transformed.	The value of ${key} is ${value}!
SinkRocketMQParameters	object	The parameters that are returned if ApsaraMQ for RocketMQ is specified as the event target.
InstanceId	object	The ID of the ApsaraMQ for RocketMQ instance.
Value	string	The ID of the ApsaraMQ for RocketMQ instance.	MQ_INST_164901546557**_BAAN**
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
Topic	object	The topic on the ApsaraMQ for RocketMQ instance.
Value	string	The topic on the ApsaraMQ for RocketMQ instance.	topic
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
Body	object	The message content.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The method that is used to transform events.	TEMPLATE
Template	string	The template based on which events are transformed.	The value of ${key} is ${value}!
Properties	object	The properties that are used to filter messages.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The method that is used to transform events.	TEMPLATE
Template	string	The template based on which events are transformed.	The value of ${key} is ${value}!
Keys	object	The keys that are used to filter messages.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The method that is used to transform events.	TEMPLATE
Template	string	The template based on which events are transformed.	The value of ${key} is ${value}!
Tags	object	The tags that are used to filter messages.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The method that is used to transform events.	TEMPLATE
Template	string	The template based on which events are transformed.	The value of ${key} is ${value}!
SinkSLSParameters	object	The parameters that are returned if Simple Log Service is specified as the event target.
Project	object	The Simple Log Service project.
Value	string	The Simple Log Service project.	test-project
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
LogStore	object	The Simple Log Service Logstore.
Value	string	The Simple Log Service Logstore.	test-logstore
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
Topic	object	The name of the topic in which logs are stored. The topic corresponds to the topic reserved field in Simple Log Service.
Value	string	The name of the topic in which logs are stored. The topic corresponds to the topic reserved field in Simple Log Service.	topic
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
Body	object	The message body that is sent to Simple Log Service.
Value	string	The value before transformation.	{ "key": "value" }
Form	string	The method that is used to transform events.	TEMPLATE
Template	string	The template based on which events are transformed.	The value of ${key} is ${value}!
RoleName	object	The role name. If you want to authorize EventBridge to use this role to read logs in Log Service, you must select Alibaba Cloud Service for Selected Trusted Entity and EventBridge for Select Trusted Service when you create the role in the RAM console.
Value	string	The role name. If you want to authorize EventBridge to use this role to read logs in Log Service, you must select Alibaba Cloud Service for Selected Trusted Entity and EventBridge for Select Trusted Service when you create the role in the RAM console.	test-role
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	None.
SinkFnfParameters	object	The parameters that are returned if CloudFlow is specified as the event target.
FlowName	object	The flow name.
Value	string	The flow name.	test-streaming-fnf
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	The template based on which events are transformed.	None
ExecutionName	object	The execution name.
Value	string	The execution name.	123
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	The template based on which events are transformed.	None
Input	object	The input information of the execution.
Value	string	The input information of the execution.	123
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	The template based on which events are transformed.	None
RoleName	object	The role name.
Value	string	The role configuration.	Al**FNF-x**
Form	string	The method that is used to transform events. Default value: CONSTANT.	CONSTANT
Template	string	The template based on which events are transformed.	None
RunOptions	object	The parameters that are returned for the runtime environment.
MaximumTasks	integer	The maximum number of concurrent tasks.	2
RetryStrategy	object	The retry policy that is used if events fail to be pushed.
PushRetryStrategy	string	The retry policy. Valid values: BACKOFF_RETRY and EXPONENTIAL_DECAY_RETRY.	EXPONENTIALDECAY_RETRY
MaximumEventAgeInSeconds	float	The maximum timeout period for a retry.	512
MaximumRetryAttempts	float	The maximum number of retries.	2
ErrorsTolerance	string	The exception tolerance policy. Valid values: NONE and ALL.	ALL
DeadLetterQueue	object	Indicates whether dead-letter queues are enabled. By default, dead-letter queues are disabled. Events that fail to be pushed are discarded after the maximum number of retries that is specified by the retry policy is reached.
Arn	string	The ARN of the dead-letter queue.	acs:ram::1597871211794192:role/aliyunsaedefaultrole
BatchWindow	object	The batch window.
CountBasedWindow	integer	The maximum number of events that are allowed in the batch window. When this threshold is reached, data in the window is pushed to the downstream service. When multiple batch windows exist, data is pushed if triggering conditions are met in one of the windows.	100
TimeBasedWindow	integer	The maximum period of time during which events are allowed in the batch window. Unit: seconds. When this threshold is reached, data in the window is pushed to the downstream service. When multiple batch windows exist, data is pushed if triggering conditions are met in one of the windows.	10
Status	string	The status of the event stream that is returned.	RUNNING
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists. You must specify the pagination token in the next request.	177
Total	integer	The total number of records.	10
Code	string	The response code. Valid values: Success: The request is successful. Other codes: The request failed. For more information about error codes, see Error codes.	Success
Success	boolean	Indicates whether the request is successful. The value true indicates that the request is successful.	true

Examples

Sample success responses

JSONformat

{
  "Message": "The event streaming [xxxx] not existed!\n",
  "RequestId": "283FF852-C4B8-58C9-9777-F88A5A16A79F",
  "Data": {
    "EventStreamings": [
      {
        "EventStreamingName": "name",
        "Description": "demo",
        "Source": {
          "SourceMNSParameters": {
            "RegionId": "cn-zhangjiakou",
            "QueueName": "work4",
            "IsBase64Decode": true
          },
          "SourceRabbitMQParameters": {
            "RegionId": "cn-zhangjiakou",
            "InstanceId": "dbaudit-cn-7mz2hqolc06",
            "VirtualHostName": "eb-connect\n",
            "QueueName": "liuyang"
          },
          "SourceRocketMQParameters": {
            "RegionId": "cn-chengdu",
            "InstanceId": "i-f8zbher64dlm58plyfte\n",
            "Topic": "topic_add_anima",
            "Tag": "v1",
            "Offset": "CONSUMEFROMTIMESTAMP",
            "GroupID": "GID_group1",
            "Timestamp": 1670742074043,
            "InstanceType": "2",
            "InstanceEndpoint": "registry-vpc.cn-hangzhou.aliyuncs.com",
            "AuthType": "ACL",
            "InstanceUsername": "admin**",
            "InstancePassword": "123",
            "InstanceVpcId": "vpc-bp1a4gmlk31hy***l3ss",
            "InstanceVSwitchIds": "vsw-m5ev8asdc6h123456****\n",
            "InstanceSecurityGroupId": "sg-m5edtu24f12345****\n",
            "InstanceNetwork": "PublicNetwork",
            "BodyDataType": "",
            "Network": "",
            "FilterType": "",
            "FilterSql": "",
            "VpcId": "",
            "VSwitchIds": "",
            "SecurityGroupId": ""
          },
          "SourceKafkaParameters": {
            "RegionId": "cn-chengdu",
            "InstanceId": "bastionhost-cn-i7m2gwt7z1n",
            "Topic": "topic_empower_1642473600414\n",
            "ConsumerGroup": "GID_TEST",
            "OffsetReset": "latest",
            "Network": "Default",
            "VpcId": "vpc-wz9ki1qdlx3cx5cbbhowf",
            "VSwitchIds": "vsw-bp1rmi8rind7eo50cbied",
            "SecurityGroupId": "sg-5ud5f3p0rqqis69tpp8eho7cp",
            "ValueDataType": ""
          },
          "SourceMQTTParameters": {
            "RegionId": "cn-qingdao",
            "InstanceId": "bastionhost-cn-zvp27kcha1r",
            "Topic": "migration_instance",
            "BodyDataType": ""
          },
          "SourceDTSParameters": {
            "TaskId": "1611b337285f44e2936a2c4170bbbb7f",
            "BrokerUrl": "",
            "Topic": "TP_TEST_UNDERWRITE_ISSUE\n",
            "Sid": "HG9",
            "Username": "admin",
            "Password": "123456",
            "InitCheckPoint": "1620962769"
          },
          "SourceSLSParameters": {
            "Project": "dmmzk",
            "LogStore": "waf-logstore\n",
            "ConsumerGroup": "go-dts-shelf-group",
            "ConsumePosition": "begin",
            "RoleName": "testRole"
          },
          "SourcePrometheusParameters": {
            "RegionId": "",
            "ClusterId": "",
            "DataType": "",
            "Labels": ""
          },
          "SourceCustomizedKafkaParameters": {
            "InstanceId": ""
          },
          "SourceCustomizedKafkaConnectorParameters": {
            "ConnectorPackageUrl": "",
            "ConnectorParameters": {
              "Name": "",
              "Config": {
                "test": "test",
                "test2": 1
              }
            },
            "WorkerParameters": {
              "test": "test",
              "test2": 1
            }
          },
          "SourceApacheKafkaParameters": {
            "Bootstraps": "",
            "Topic": "",
            "ConsumerGroup": "",
            "OffsetReset": "",
            "ValueDataType": "",
            "VpcId": "",
            "VSwitchIds": "",
            "SecurityGroupId": "",
            "NetworkType": "",
            "SecurityProtocol": "",
            "SaslMechanism": "",
            "SaslUser": "",
            "SaslPassword": ""
          }
        },
        "FilterPattern": "",
        "Transforms": [
          {
            "Arn": "acs:fc:cn-hangzhou:*****:services/demo-service.LATEST/functions/demo-func\n"
          }
        ],
        "Sink": {
          "SinkMNSParameters": {
            "QueueName": {
              "Value": "MyQueue",
              "Form": "CONSTANT",
              "Template": ""
            },
            "Body": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "IsBase64Encode": {
              "Value": "true",
              "Form": "CONSTANT",
              "Template": ""
            }
          },
          "SinkFcParameters": {
            "ServiceName": {
              "Value": "myService",
              "Form": "CONSTANT",
              "Template": ""
            },
            "FunctionName": {
              "Value": "mFunction",
              "Form": "CONSTANT",
              "Template": ""
            },
            "Concurrency": {
              "Value": "1",
              "Form": "CONSTANT",
              "Template": ""
            },
            "Qualifier": {
              "Value": "LATEST",
              "Form": "CONSTANT",
              "Template": ""
            },
            "InvocationType": {
              "Value": "Async",
              "Form": "CONSTANT",
              "Template": ""
            },
            "Body": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            }
          },
          "SinkRabbitMQParameters": {
            "InstanceId": {
              "Value": "si-296cd57939a1421b94ec",
              "Form": "CONSTANT",
              "Template": ""
            },
            "VirtualHostName": {
              "Value": "rabbit-host\n",
              "Form": "CONSTANT",
              "Template": ""
            },
            "TargetType": {
              "Value": "Queue",
              "Form": "CONSTANT",
              "Template": ""
            },
            "Exchange": {
              "Value": "a_exchange",
              "Form": "CONSTANT",
              "Template": ""
            },
            "RoutingKey": {
              "Value": "housekeeping",
              "Form": "CONSTANT",
              "Template": ""
            },
            "QueueName": {
              "Value": "MyQueue",
              "Form": "CONSTANT",
              "Template": ""
            },
            "Body": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "MessageId": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "Properties": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            }
          },
          "SinkKafkaParameters": {
            "InstanceId": {
              "Value": "Defaut_1283278472_sadkj",
              "Form": "CONSTANT",
              "Template": ""
            },
            "Topic": {
              "Value": "topic",
              "Form": "CONSTANT",
              "Template": ""
            },
            "Acks": {
              "Value": "1",
              "Form": "CONSTANT",
              "Template": ""
            },
            "Key": {
              "Value": "key",
              "Form": "CONSTANT",
              "Template": ""
            },
            "Value": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            }
          },
          "SinkRocketMQParameters": {
            "InstanceId": {
              "Value": "MQ_INST_164901546557****_BAAN****\n",
              "Form": "CONSTANT",
              "Template": ""
            },
            "Topic": {
              "Value": "topic",
              "Form": "CONSTANT",
              "Template": ""
            },
            "Body": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "Properties": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "Keys": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "Tags": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "InstanceType": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "InstanceEndpoint": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "InstanceUsername": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "InstancePassword": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "VpcId": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "VSwitchIds": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "SecurityGroupId": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "Network": {
              "Value": "",
              "Form": "",
              "Template": ""
            }
          },
          "SinkSLSParameters": {
            "Project": {
              "Value": "test-project\n",
              "Form": "CONSTANT",
              "Template": ""
            },
            "LogStore": {
              "Value": "test-logstore\n",
              "Form": "CONSTANT",
              "Template": ""
            },
            "Topic": {
              "Value": "topic",
              "Form": "CONSTANT",
              "Template": ""
            },
            "Body": {
              "Value": "{\n      \"key\": \"value\"\n}",
              "Form": "TEMPLATE",
              "Template": "The value of ${key} is ${value}!\n"
            },
            "RoleName": {
              "Value": "test-role",
              "Form": "CONSTANT",
              "Template": ""
            },
            "ContentType": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "ContentSchema": {
              "Value": "",
              "Form": "",
              "Template": ""
            }
          },
          "SinkFnfParameters": {
            "FlowName": {
              "Value": "test-streaming-fnf\n",
              "Form": "CONSTANT",
              "Template": "None\n"
            },
            "ExecutionName": {
              "Value": "123",
              "Form": "CONSTANT",
              "Template": "None\n"
            },
            "Input": {
              "Value": "123",
              "Form": "CONSTANT",
              "Template": "None\n"
            },
            "RoleName": {
              "Value": "Al****FNF-x****\n",
              "Form": "CONSTANT",
              "Template": "None\n"
            }
          },
          "SinkDataHubParameters": {
            "Project": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "Topic": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "TopicType": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "TopicSchema": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "Body": {
              "Value": "",
              "Form": "",
              "Template": ""
            },
            "RoleName": {
              "Value": "",
              "Form": "",
              "Template": ""
            }
          },
          "SinkCustomizedKafkaParameters": {
            "InstanceId": ""
          },
          "SinkCustomizedKafkaConnectorParameters": {
            "ConnectorPackageUrl": "",
            "ConnectorParameters": {
              "Name": "",
              "Config": {
                "test": "test",
                "test2": 1
              }
            },
            "WorkerParameters": {
              "test": "test",
              "test2": 1
            }
          },
          "SinkDashVectorParameters": {
            "InstanceId": "",
            "Collection": "",
            "ApiKey": "",
            "Operation": "",
            "Network": "",
            "PrimaryKeyId": {
              "Form": "",
              "Value": "",
              "Template": ""
            },
            "Partition": {
              "Form": "",
              "Value": "",
              "Template": ""
            },
            "Vector": {
              "Form": "",
              "Value": "",
              "Template": ""
            },
            "DashVectorSchemaParameters": {
              "Form": "",
              "Value": "",
              "Template": ""
            }
          }
        },
        "RunOptions": {
          "MaximumTasks": 2,
          "RetryStrategy": {
            "PushRetryStrategy": "EXPONENTIALDECAY_RETRY",
            "MaximumEventAgeInSeconds": 512,
            "MaximumRetryAttempts": 2
          },
          "ErrorsTolerance": "ALL",
          "DeadLetterQueue": {
            "Arn": "acs:ram::1597871211794192:role/aliyunsaedefaultrole"
          },
          "BatchWindow": {
            "CountBasedWindow": 100,
            "TimeBasedWindow": 10
          },
          "LogDelivery": {
            "SLSLogParameters": [
              {
                "ProjectName": "",
                "LogstoreName": ""
              }
            ],
            "KafkaLogParameters": [
              {
                "Endpoint": "",
                "InstanceId": "",
                "Topic": ""
              }
            ]
          },
          "ScaledObject": {
            "MinReplicaCount": 0,
            "MaxReplicaCount": 0,
            "Triggers": [
              {
                "Type": "",
                "Metadata": {
                  "Type": "",
                  "Value": 0
                }
              }
            ]
          },
          "RoleName": "",
          "Network": {
            "VpcId": "",
            "VSwitchIds": [
              ""
            ],
            "SecurityGroupId": ""
          },
          "ResourceSpec": {
            "Resources": [
              {
                "Type": "",
                "Value": 0
              }
            ]
          }
        },
        "Status": "RUNNING"
      }
    ],
    "NextToken": "177",
    "Total": 10
  },
  "Code": "Success",
  "Success": true
}

Error codes

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

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-10	The Error code has changed. The response structure of the API has changed	View Change Details
2024-08-19	The Error code has changed. The response structure of the API has changed	View Change Details
2024-07-12	The Error code has changed. The response structure of the API has changed	View Change Details
2024-06-28	The Error code has changed. The response structure of the API has changed	View Change Details
2024-05-31	The Error code has changed. The response structure of the API has changed	View Change Details
2024-04-09	The Error code has changed. The response structure of the API has changed	View Change Details
2023-11-22	The Error code has changed. The response structure of the API has changed	View Change Details
2023-10-11	The Error code has changed. The response structure of the API has changed	View Change Details
2023-09-13	The Error code has changed. The response structure of the API has changed	View Change Details
2023-06-09	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-04-21	The Error code has changed. The response structure of the API has changed	View Change Details
2023-04-10	The Error code has changed	View Change Details