ListEventStreamings - 查询事件流 - 事件总线EventBridge

查询事件流。

接口说明

查询事件流。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
eventbridge:ListEventStreamings	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
NamePrefix	string	否	名称。	name
Limit	integer	否	限定每次返回的最大条数，可以和 NextToken 搭配使用实现翻页能力。注意每次返回的最大条数不超过 100。	10
NextToken	string	否	当指定 Limit 时，如果还有多余的返回值则会返回 NextToken。	10
SourceArn	string	否	事件源 Arn。	acs:alikafka:cn-hangzhou:118609547428**:instance/alikafka_pre-cn-zxu36kvi**/topic/test-topic
SinkArn	string	否	事件目标 Arn。	acs:fc:cn-hangzhou:118609547428****:services/fw1.LATEST/functions/log1

返回参数

名称	类型	描述	示例值
	object	返回信息。
Message	string	错误信息。	The event streaming [xxxx] not existed!
RequestId	string	阿里云为该请求生成的唯一标识符。	283FF852-C4B8-58C9-9777-F88A5A16****
Data	object	事件流列表。
EventStreamings	array<object>	事件流列表。
EventStreamings	object	事件流实体。
EventStreamingName	string	事件流名称。	name
Description	string	事件流描述信息。	demo
Source	object	事件提供方。
SourceMNSParameters	object	Source 轻量消息队列（原 MNS）源。
RegionId	string	地域 ID。	cn-zhangjiakou
QueueName	string	轻量消息队列（原 MNS）的 Queue 的名称。	work4
IsBase64Decode	boolean	是否开启 Base64 编码。	true
SourceRabbitMQParameters	object	Source RabbitMQ 源。
RegionId	string	地域 ID。	cn-zhangjiakou
InstanceId	string	消息队列 RabbitMQ 版的实例的 ID。	dbaudit-cn-7mz2hqo****
VirtualHostName	string	消息队列 RabbitMQ 版实例的 Vhost 的名称。	eb-connect
QueueName	string	消息队列 RabbitMQ 版实例的 Queue 的名称。	liuyang
SourceRocketMQParameters	object	Source RocketMQ 源。
RegionId	string	消息队列 RocketMQ 版的地域 ID。	cn-chengdu
InstanceId	string	消息队列 RocketMQ 版的实例 id。	i-f8zbher64dlm58pl****
Topic	string	消息的 Topic。	topic_add_anima
Tag	string	消息的过滤标签。	v1
Offset	string	消息的消费位点。取值说明如下： CONSUMEFROMLASTOFFSET：从最新位点开始消费。 CONSUMEFROMFIRSTOFFSET：从最早位点开始消费。 CONSUMEFROMTIMESTAMP：从指定时间点的位点开始消费。	CONSUMEFROMTIMESTAMP
GroupID	string	消息队列 RocketMQ 版的 Group ID。	GID_group1
Timestamp	long	时间戳。仅当参数 Offset 取值为 CONSUMEFROMTIMESTAMP 时，该参数有效。	1670742074043
InstanceType	string	实例类型。取值说明如下： Cloud_4：阿里云 RocketMQ 4.0 版本实例（默认选项） Cloud_5：阿里云 RocketMQ 5.0 版本实例 SelfBuilt：自建 Apache RocketMQ 集群	Cloud_4
InstanceEndpoint	string	实例接入点。	registry-vpc.cn-hangzhou.aliyuncs.com
AuthType	string	鉴权类型。	ACL
InstanceUsername	string	实例用户名。	admin**
InstancePassword	string	实例密码。	123
InstanceVpcId	string	专有网络 VPC 的 ID。	vpc-bp1a4gmlk31hy***l3ss
InstanceVSwitchIds	string	实例交换机信息。	vsw-m5ev8asdc6h123456****
InstanceSecurityGroupId	string	实例安全组信息。	sg-m5edtu24f12345****
InstanceNetwork	string	实例网络信息： PublicNetwork PrivateNetwork	PublicNetwork
BodyDataType	string	消息编码格式： JSON Text Binary	JSON
Network	string	网络类型。 PublicNetwork PrivateNetwork	PublicNetwork
FilterType	string	消息过滤类型。	Tag
FilterSql	string	sql 过滤语句。	index > 10
VpcId	string	VPC 的 ID。	vpc-m5e3sv4b12345****
VSwitchIds	string	虚拟交换机 ID。	vsw-m5ev8asdc6h12345****
SecurityGroupId	string	安全组 ID。	sg-m5edtu24f12345****
SourceKafkaParameters	object	Source Kafka 源。
RegionId	string	实例所在地域 id。	cn-chengdu
InstanceId	string	实例 id。	bastionhost-cn-i7m2gwt****
Topic	string	Topic 名称。	topic_empower_1642473600414
ConsumerGroup	string	订阅该 Topic 的消费者所对应的 Group ID。	GID_TEST
OffsetReset	string	偏移量。	latest
Network	string	网络配置：默认值 Default，vpc 网络是 PublicNetwork。	Default
VpcId	string	用户的 VPC ID。	vpc-wz9ki1qdlx3cx5cbf****
VSwitchIds	string	交换机 ID。	vsw-bp1rmi8rind7eo50c****
SecurityGroupId	string	安全组 ID。	sg-5ud5f3p0rqqis69****eho7cp
ValueDataType	string	消息体编解码格式： JSON Text Binary	JSON
SourceMQTTParameters	object	Source MQTT 源。
RegionId	string	地域 ID。	cn-qingdao
InstanceId	string	实例 id。	bastionhost-cn-zvp27kc****
Topic	string	Topic 名称。	migration_instance
BodyDataType	string	消息编码格式： JSON Text Binary	JSON
SourceDTSParameters	object	Source DTS 源。
TaskId	string	任务 ID。	1611b337285f44e2936a2c4170****
BrokerUrl	string	数据订阅通道的网络地址及端口号信息。	无
Topic	string	数据订阅通道的订阅 Topic。	TP_TEST_UNDERWRITE_ISSUE
Sid	string	消费组 ID。	HG9
Username	string	消费组的账号。	admin
Password	string	消费组的账号密码。	123456
InitCheckPoint	string	消费位点，即 SDK 客户端消费第一条数据的时间戳，格式为 Unix 时间戳。	1620962769
SourceSLSParameters	object	Source SLS 源。
Project	string	日志服务 SLS 的日志项目。	dmmzk
LogStore	string	日志服务 SLS 的日志库。	waf-logstore
ConsumerGroup	string	订阅该 Topic 的消费者所对应的 Group ID。	go-dts-shelf-group
ConsumePosition	string	起始消费位点，可以选择最早或最新位点，分别对应“begin”，“end”，也可以从指定时间开始消费，以秒为单位。	begin
RoleName	string	授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时，需满足条件：在 RAM 控制台创建服务所使用的角色时，需要选择“阿里云服务”，并且“受信服务”需要选择“事件总线”。	testRole
SourcePrometheusParameters	object	Source Prometheus 事件源。
RegionId	string	地域 ID。	cn-beijing
ClusterId	string	集群 id。	c83555068b6******ad213f565f209
DataType	string	数据类型。	JSON
Labels	string	标签。	__name__=.*
SourceCustomizedKafkaParameters	object	自定义 Kafka 事件源。
InstanceId	string	实例 ID。	gtm-cn-k2c2yfg****
SourceCustomizedKafkaConnectorParameters	object	自定义连接器 Apache Kafka 事件源。
ConnectorPackageUrl	string	OSS 资源 ZIP 包下载链接。	"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	连接器参数。
Name	string	连接器名称。	test-name
Config	object	连接器配置。	{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" }
WorkerParameters	object	kafka 实例配置。	{ "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	Source OSS 事件源。
RoleName	string	授权事件总线 EventBridge 读取 OSS 文件的角色名称，要求该角色至少具有 OSS 的只读权限。	eventbridge_oss_role
BucketName	string	对象存储 OSS 中的存储空间名称。	bucket_abc
Prefix	string	文件路径前缀。	fun/document/
LoadMode	string	数据加载模式，single 表示单文档加载，element 表示分块加载。取值：single/element 默认为 single。	single
LoadFormat	string	文档加载器。	TextLoader
Delimiter	string	分隔符，在分块加载模式下，以该分隔符作为文本的分块标识符，默认以换行符\n 作为分隔符。	\n
FilterPattern	string	事件过滤规则，如果不指定表示匹配全部事件。	无
Transforms	array<object>	Transform 相关配置。
Transforms	object	云产品的 ARN，比如函数计算中函数的 ARN。
Arn	string	云产品的 ARN，比如函数计算中函数的 ARN。	acs:fc:cn-hangzhou:*****:services/demo-service.LATEST/functions/demo-func
Sink	object	事件目标。
SinkMNSParameters	object	轻量消息队列（原 MNS）事件目标。
QueueName	object	目标服务类型为轻量消息队列（原 MNS）。
Value	string	轻量消息队列（原 MNS）的 Queue 的名称。	MyQueue
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
Body	object	消息内容。
Value	string	转换前的值。	{ "key": "value" }
Form	string	转换的格式。	TEMPLATE
Template	string	模板样式。	The value of ${key} is ${value}!
IsBase64Encode	object	是否开启 Base64 编码。
Value	string	开启 Base64 编码。	true
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
SinkFcParameters	object	函数目标。
ServiceName	object	服务的名称。
Value	string	服务的名称。	myService
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
FunctionName	object	函数名称。
Value	string	函数名称。	mFunction
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
Concurrency	object	投递并发度，最小为 1。
Value	string	投递并发度，最小为 1。	1
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
Qualifier	object	函数所属服务的别名。
Value	string	函数所属服务的别名。	LATEST
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
InvocationType	object	同步或则异步。 Sync：同步。 Async：异步。
Value	string	同步或则异步。 Sync：同步。 Async：异步。	Async
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
Body	object	发送给函数的内容体。
Value	string	转换前的值。	{ "key": "value" }
Form	string	转换的格式。	TEMPLATE
Template	string	模板样式。	The value of ${key} is ${value}!
SinkRabbitMQParameters	object	Sink Rabbitmq 的参数。
InstanceId	object	目标服务类型为消息队列 RabbitMQ 版。
Value	string	消息队列 RabbitMQ 版的实例 ID。	si-296cd57939a1421b****
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
VirtualHostName	object	消息队列 RabbitMQ 版实例的 Vhost 的名称。
Value	string	消息队列 RabbitMQ 版实例的 Vhost 的名称。	rabbit-host
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
TargetType	object	目标类型。
Value	string	目标类型。取值说明如下： Exchange：Exchange 模式。 Queue：Queue 模式。	Queue
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
Exchange	object	Exchange 模式。仅当参数 TargetType 配置为 Exchange 时，需配置此参数。
Value	string	消息队列 RabbitMQ 版实例的 Exchange 的名称。	a_exchange
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
RoutingKey	object	消息的路由规则。仅当参数 TargetType 配置为 Exchange 时，需配置此参数。
Value	string	消息的路由规则。	housekeeping
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
QueueName	object	Queue 模式。仅当参数 TargetType 配置为 Queue 时，需配置此参数。
Value	string	实例的 Queue 的名称。	MyQueue
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
Body	object	消息内容。
Value	string	转换前的值。	{ "key": "value" }
Form	string	转换的格式。	TEMPLATE
Template	string	模板样式。	The value of ${key} is ${value}!
MessageId	object	消息 ID。
Value	string	转换前的值。	{ "key": "value" }
Form	string	转换的格式。	TEMPLATE
Template	string	模板样式。	The value of ${key} is ${value}!
Properties	object	过滤属性。
Value	string	转换前的值。	{ "key": "value" }
Form	string	转换的格式。	TEMPLATE
Template	string	模板样式。	The value of ${key} is ${value}!
SinkKafkaParameters	object	Sink kafka 参数。
InstanceId	object	目标服务类型为消息队列 Kafka 版。
Value	string	实例 ID。	Defaut_1283278472_sad****
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
Topic	object	主题名称。
Value	string	主题名称。	topic
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
Acks	object	写入 Kafka 确认模式： acks=0：无需服务端的 Response、性能较高、丢数据风险较大。 acks=1：服务端主节点写成功即返回 Response、性能中等、丢数据风险中等、主节点宕机可能导致数据丢失； acks=all：服务端主节点写成功且备节点同步成功才返回 Response、性能较差、数据较为安全、主节点和备节点都宕机才会导致数据丢失。
Value	string	写入 Kafka 确认模式： acks=0：无需服务端的 Response、性能较高、丢数据风险较大。 acks=1：服务端主节点写成功即返回 Response、性能中等、丢数据风险中等、主节点宕机可能导致数据丢失； acks=all：服务端主节点写成功且备节点同步成功才返回 Response、性能较差、数据较为安全、主节点和备节点都宕机才会导致数据丢失。	1
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
Key	object	消息的标识。
Value	string	消息的标识。	key
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
Value	object	消息体内容。
Value	string	转换前的值。	{ "key": "value" }
Form	string	转换的格式。	TEMPLATE
Template	string	模板样式。	The value of ${key} is ${value}!
SinkRocketMQParameters	object	Sink RocketMQ 源。
InstanceId	object	目标服务类型为消息队列 RocketMQ 版。
Value	string	消息队列 RocketMQ 版的实例 ID。	MQ_INST_164901546557**_BAAN**
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
Topic	object	消息队列 RocketMQ 版实例的 Topic。
Value	string	消息队列 RocketMQ 版实例的 Topic。	topic
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
Body	object	消息内容。
Value	string	转换前的值。	{ "key": "value" }
Form	string	转换的格式。	TEMPLATE
Template	string	模板样式。	The value of ${key} is ${value}!
Properties	object	过滤属性。
Value	string	转换前的值。	{ "key": "value" }
Form	string	转换的格式。	TEMPLATE
Template	string	模板样式。	The value of ${key} is ${value}!
Keys	object	过滤属性。
Value	string	转换前的值。	{ "key": "value" }
Form	string	转换的格式。	TEMPLATE
Template	string	模板样式。	The value of ${key} is ${value}!
Tags	object	过滤属性。
Value	string	转换前的值。	{ "key": "value" }
Form	string	转换的格式。	TEMPLATE
Template	string	模板样式。	The value of ${key} is ${value}!
InstanceType	object	实例类型。
Value	string	实例类型。取值说明如下： Cloud_4：阿里云 RocketMQ 4.0 版本实例（默认选项） Cloud_5：阿里云 RocketMQ 5.0 版本实例 SelfBuilt：自建 Apache RocketMQ 集群	Cloud_4
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
InstanceEndpoint	object	实例接入点。
Value	string	实例接入点。	vbr-8vbsvkkbpf3vb0zef****
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
InstanceUsername	object	实例用户名。
Value	string	实例用户名。	admin
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
InstancePassword	object	实例密码。
Value	string	实例密码。	admin******
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
VpcId	object	VPC 的 ID。
Value	string	VPC 的 ID。	vbr-8vb835n3zf9shwlvb****
Form	string	事件转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
VSwitchIds	object	交换机 ID。
Value	string	交换机 ID。	vbr-8vb835n3zf9shwl****mp
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
SecurityGroupId	object	安全组 ID。
Value	string	安全组 ID。	b4bf375515f6440f942e3a20c33d****
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
Network	object	网络类型。 PublicNetwork PrivateNetwork
Value	string	网络类型。 PublicNetwork PrivateNetwork	PublicNetwork
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
SinkSLSParameters	object	Sink SLS Parameters
Project	object	日志服务 SLS 的日志项目。
Value	string	日志服务 SLS 的日志项目。	test-project
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
LogStore	object	日志服务 SLS 的日志库。
Value	string	日志服务 SLS 的日志库。	test-logstore
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
Topic	object	日志所在的 topic，对应 SLS 保留字段“topic”。
Value	string	日志所在的 topic，对应 SLS 保留字段“topic”。	topic
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
Body	object	发送给 SLS 的内容。
Value	string	转换前的值。	{ "key": "value" }
Form	string	转换的格式。	TEMPLATE
Template	string	模板样式。	The value of ${key} is ${value}!
RoleName	object	授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时，需满足条件：在 RAM 控制台创建服务所使用的角色时，需要选择“阿里云服务”，并且“受信服务”需要选择“事件总线”。
Value	string	授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时，需满足条件：在 RAM 控制台创建服务所使用的角色时，需要选择“阿里云服务”，并且“受信服务”需要选择“事件总线”。	test-role
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
ContentType	object	SLS 数据格式。可选择默认或者配置制定的键值： JSON KeyValue
Value	string	SLS 数据格式。可选择默认或者配置制定的键值： JSON KeyValue	JSON
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
ContentSchema	object	自定义日志的键值，仅在 ContentType 为 KeyValue 生效。每一对键值由 Key_n, Value_n 表示。
Value	string	转换前的值。	{"Key_1":{"form":"CONSTANT","value":"demoKey"},"Value_1":{"form":"JSONPATH","value":"$.data.value"}}
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
SinkFnfParameters	object	Sink Fnf 参数。
FlowName	object	流程名称。
Value	string	流程名称。	test-streaming-fnf
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	模板样式。	无
ExecutionName	object	执行名称。
Value	string	执行名称。	123
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	模板样式。	无
Input	object	执行输入信息。
Value	string	执行输入信息。	123
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	模板样式。	无
RoleName	object	角色配置。
Value	string	角色配置。	Al**FNF-x**
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	模板样式。	无
SinkDataHubParameters	object	Sink DataHub 参数。
Project	object	DataHub 项目名。
Value	string	DataHub 项目名。	demo-project
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
Topic	object	DataHub Topic 名称。
Value	string	DataHub Topic 名称。	demo-topic
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
TopicType	object	topic 类型： TUPLE BLOB
Value	string	topic 类型： TUPLE BLOB	TUPLE
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
TopicSchema	object	TUBLE 类型，topic 内容模式。
Value	string	TUBLE 类型，topic 内容模式。	{"k1":"value1","k2":"value2"}
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
Body	object	BLOB 类型，Record 内容模板。
Value	string	BLOB 类型，Record 内容模板。	无
Form	string	转换的格式。	ORIGINAL
Template	string	无	无
RoleName	object	授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时，需满足条件：在 RAM 控制台创建服务所使用的角色时，需要选择“阿里云服务”，并且“受信服务”需要选择“事件总线”。
Value	string	授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时，需满足条件：在 RAM 控制台创建服务所使用的角色时，需要选择“阿里云服务”，并且“受信服务”需要选择“事件总线”。	testRole
Form	string	转换的格式。默认为 CONSTANT。	CONSTANT
Template	string	无	无
SinkCustomizedKafkaParameters	object	Sink Kafka 参数。
InstanceId	string	消息队列 Kafka 版的实例 ID。	90be1f96-4229-4535-bb76-34b4f6fb2b71
SinkCustomizedKafkaConnectorParameters	object	Sink Kafka 连接器参数。
ConnectorPackageUrl	string	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	解析当前 ZIP 包下的 properties 文件。
Name	string	连接器名称。	mongo-sink
Config	object	连接器配置。	{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" }
WorkerParameters	object	实例配置。	{ "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	Sink DashVector 参数。
InstanceId	string	实例 ID。	vrs-cn-lbj3ru1***
Collection	string	Collection（集合）名称。	collection1
ApiKey	string	DashVecotor 控制台创建的 API Key。	Q34nExQH7sQ****
Operation	string	DashVector 数据库操作类型。	Upsert
Network	string	网络类型。	PublicNetwork
PrimaryKeyId	object	插入/删除记录时的主键 ID 不填写此字段时，使用随机主键 ID。
Form	string	转换的格式。	JSONPATH
Value	string	Form 为 JSONPATH：JSONPath 提取内容 Form 为 TEMPLATE：模板变量注：Value 字段不允许超过 10240 个字符。	$.data.requestId
Template	string	主键 ID 模板，仅当 Form 是 TEMPLATE 时需要填写。	${ID}
Partition	object	Partition（分区），默认值为 default 分区。
Form	string	转换的格式。	CONSTANT
Value	string	Form 为 CONSTANT：常量值 Form 为 JSONPATH：JSONPath 提取内容注：Value 字段不允许超过 10240 个字符。	default
Template	string	无	无
Vector	object	插入 DashVector 记录的向量。
Form	string	转换的格式。	JSONPATH
Value	string	JSONPath 提取内容。注：Value 字段不允许超过 10240 个字符。	$.data.messageBody
Template	string	无	无
DashVectorSchemaParameters	object	插入 DashVector 时表项的 Schema 字段定义，事件内容转换后结果必须是 JSON 格式。
Form	string	转换的格式。	TEMPLATE
Value	string	Form 为 CONSTANT：常量值 Form 为 JSONPATH：JSONPath 提取内容 Form 为 TEMPLATE：模板变量注：Value 字段不允许超过 10240 个字符。	{ "value1":"v1", "value2":"v2" }
Template	string	Schema 模板，仅当 Form 是 TEMPLATE 时需要填写，事件内容转换后必须是 Array（JSON）格式，每个 Schema 对应一个 JSON 对象，属性有且仅有 name, type（仅支持 INT、FLOAT、STRING、BOOL）, value 三个字段。	[ { "name": "schema1", "type": "INT", "value": "${value1}" }, { "name": "schema2", "type": "FLOAT", "value": "${value2}" } ]
RunOptions	object	运行环境参数。
MaximumTasks	integer	并发数。	2
RetryStrategy	object	事件推送失败时的重试策略。
PushRetryStrategy	string	重试策略：BACKOFF_RETRY（退避重试）和 EXPONENTIAL_DECAY_RETRY（指数衰减重试）。	EXPONENTIAL_DECAY_RETRY
MaximumEventAgeInSeconds	float	最大重试时间。	512
MaximumRetryAttempts	float	最大重试次数。	2
ErrorsTolerance	string	异常容忍策略：NONE（不容忍异常）、ALL（容忍所有异常）。	ALL
DeadLetterQueue	object	是否启用死信队列。默认不启用死信队列，超过重试策略后的消息将被丢弃。
Arn	string	死信队列 ARN。	acs:ram::159787121179****:role/aliyunsaedefaultrole
BatchWindow	object	攒批窗口。
CountBasedWindow	integer	窗口中最大可容纳的事件数量。当达到此阈值，会触发窗口内的数据往下游推送。当存在多个窗口时，有一个窗口满足即触发。	100
TimeBasedWindow	integer	窗口中最大可容纳的时间范围内的事件（单位秒）。当达到此阈值，会触发窗口内的数据往下游推送。当存在多个窗口时，有一个窗口满足即触发。	10
Status	string	获取到的事件流的状态。	RUNNING
NextToken	string	用来表示当前调用返回读取到的位置，空代表数据已经读取完毕。下次调用时，需要将此设置到入参 NextToken 中。	177
Total	integer	总共记录数。	10
Code	string	接口返回码： Success：表示成功。其它：表示错误码。错误码详情，请参见错误码。	Success
Success	boolean	操作成功返回 true。	true

示例

正常返回示例

JSON格式

{
  "Message": "The event streaming [xxxx] not existed!\n",
  "RequestId": "283FF852-C4B8-58C9-9777-F88A5A16****",
  "Data": {
    "EventStreamings": [
      {
        "EventStreamingName": "name",
        "Description": "demo",
        "Source": {
          "SourceMNSParameters": {
            "RegionId": "cn-zhangjiakou",
            "QueueName": "work4",
            "IsBase64Decode": true
          },
          "SourceRabbitMQParameters": {
            "RegionId": "cn-zhangjiakou",
            "InstanceId": "dbaudit-cn-7mz2hqo****",
            "VirtualHostName": "eb-connect\n",
            "QueueName": "liuyang"
          },
          "SourceRocketMQParameters": {
            "RegionId": "cn-chengdu",
            "InstanceId": "i-f8zbher64dlm58pl****\n",
            "Topic": "topic_add_anima",
            "Tag": "v1",
            "Offset": "CONSUMEFROMTIMESTAMP",
            "GroupID": "GID_group1",
            "Timestamp": 1670742074043,
            "InstanceType": "Cloud_4\n",
            "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": "JSON\n",
            "Network": "PublicNetwork",
            "FilterType": "Tag\n",
            "FilterSql": "index > 10\n",
            "VpcId": "vpc-m5e3sv4b12345****\n",
            "VSwitchIds": "vsw-m5ev8asdc6h12345****\n",
            "SecurityGroupId": "sg-m5edtu24f12345****\n"
          },
          "SourceKafkaParameters": {
            "RegionId": "cn-chengdu",
            "InstanceId": "bastionhost-cn-i7m2gwt****",
            "Topic": "topic_empower_1642473600414\n",
            "ConsumerGroup": "GID_TEST",
            "OffsetReset": "latest",
            "Network": "Default",
            "VpcId": "vpc-wz9ki1qdlx3cx5cbf****",
            "VSwitchIds": "vsw-bp1rmi8rind7eo50c****",
            "SecurityGroupId": "sg-5ud5f3p0rqqis69****eho7cp",
            "ValueDataType": "JSON\n"
          },
          "SourceMQTTParameters": {
            "RegionId": "cn-qingdao",
            "InstanceId": "bastionhost-cn-zvp27kc****",
            "Topic": "migration_instance",
            "BodyDataType": "JSON\n"
          },
          "SourceDTSParameters": {
            "TaskId": "1611b337285f44e2936a2c4170****",
            "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": "cn-beijing",
            "ClusterId": "c83555068b6******ad213f565f209\n",
            "DataType": "JSON\n",
            "Labels": "__name__=.*\n"
          },
          "SourceCustomizedKafkaParameters": {
            "InstanceId": "gtm-cn-k2c2yfg****\n"
          },
          "SourceCustomizedKafkaConnectorParameters": {
            "ConnectorPackageUrl": "\"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": {
              "Name": "test-name\n",
              "Config": {
                "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector",
                "tasks.max": "1",
                "topics": "sourceA,sourceB"
              }
            },
            "WorkerParameters": {
              "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": {
            "RoleName": "eventbridge_oss_role\n",
            "BucketName": "bucket_abc\n",
            "Prefix": "fun/document/\n",
            "LoadMode": "single\n",
            "LoadFormat": "TextLoader\n",
            "Delimiter": "\\n\n"
          }
        },
        "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-296cd57939a1421b****",
              "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_sad****",
              "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": "Cloud_4",
              "Form": "CONSTANT\n",
              "Template": "无"
            },
            "InstanceEndpoint": {
              "Value": "vbr-8vbsvkkbpf3vb0zef****\n",
              "Form": "CONSTANT\n",
              "Template": "无"
            },
            "InstanceUsername": {
              "Value": "admin\n",
              "Form": "CONSTANT\n",
              "Template": "无"
            },
            "InstancePassword": {
              "Value": "admin******\n",
              "Form": "CONSTANT\n",
              "Template": "无"
            },
            "VpcId": {
              "Value": "vbr-8vb835n3zf9shwlvb****\n",
              "Form": "CONSTANT\n",
              "Template": "无"
            },
            "VSwitchIds": {
              "Value": "vbr-8vb835n3zf9shwl****mp\n",
              "Form": "CONSTANT\n\n",
              "Template": "无"
            },
            "SecurityGroupId": {
              "Value": "b4bf375515f6440f942e3a20c33d****\n",
              "Form": "CONSTANT\n",
              "Template": "无\n"
            },
            "Network": {
              "Value": "PublicNetwork\n",
              "Form": "CONSTANT\n",
              "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": "JSON\n",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "ContentSchema": {
              "Value": "{\"Key_1\":{\"form\":\"CONSTANT\",\"value\":\"demoKey\"},\"Value_1\":{\"form\":\"JSONPATH\",\"value\":\"$.data.value\"}}",
              "Form": "CONSTANT\n",
              "Template": "无"
            }
          },
          "SinkFnfParameters": {
            "FlowName": {
              "Value": "test-streaming-fnf\n",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "ExecutionName": {
              "Value": "123",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Input": {
              "Value": "123",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "RoleName": {
              "Value": "Al****FNF-x****\n",
              "Form": "CONSTANT",
              "Template": "无"
            }
          },
          "SinkDataHubParameters": {
            "Project": {
              "Value": "demo-project\n",
              "Form": "CONSTANT\n",
              "Template": "无"
            },
            "Topic": {
              "Value": "demo-topic\n",
              "Form": "CONSTANT\n",
              "Template": "无"
            },
            "TopicType": {
              "Value": "TUPLE\n",
              "Form": "CONSTANT\n",
              "Template": "无"
            },
            "TopicSchema": {
              "Value": "{\"k1\":\"value1\",\"k2\":\"value2\"}\n",
              "Form": "CONSTANT",
              "Template": "无"
            },
            "Body": {
              "Value": "无",
              "Form": "ORIGINAL\n",
              "Template": "无"
            },
            "RoleName": {
              "Value": "testRole\n",
              "Form": "CONSTANT\n",
              "Template": "无"
            }
          },
          "SinkCustomizedKafkaParameters": {
            "InstanceId": "90be1f96-4229-4535-bb76-34b4f6fb2b71\n"
          },
          "SinkCustomizedKafkaConnectorParameters": {
            "ConnectorPackageUrl": "\"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": {
              "Name": "mongo-sink\n",
              "Config": {
                "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector",
                "tasks.max": "1",
                "topics": "sourceA,sourceB"
              }
            },
            "WorkerParameters": {
              "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": {
            "InstanceId": "vrs-cn-lbj3ru1***\n",
            "Collection": "collection1\n",
            "ApiKey": "Q34nExQH7sQ****\n",
            "Operation": "Upsert\n",
            "Network": "PublicNetwork\n",
            "PrimaryKeyId": {
              "Form": "JSONPATH\n",
              "Value": "$.data.requestId\n",
              "Template": "${ID}\n"
            },
            "Partition": {
              "Form": "CONSTANT\n",
              "Value": "default\n",
              "Template": "无"
            },
            "Vector": {
              "Form": "JSONPATH\n",
              "Value": "$.data.messageBody\n",
              "Template": "无"
            },
            "DashVectorSchemaParameters": {
              "Form": "TEMPLATE\n",
              "Value": "{\n  \"value1\":\"v1\",\n  \"value2\":\"v2\"\n}",
              "Template": "[\n  {\n    \"name\": \"schema1\",\n    \"type\": \"INT\",\n    \"value\": \"${value1}\"\n  },\n  {\n    \"name\": \"schema2\",\n    \"type\": \"FLOAT\",\n    \"value\": \"${value2}\"\n  }\n]"
            }
          }
        },
        "RunOptions": {
          "MaximumTasks": 2,
          "RetryStrategy": {
            "PushRetryStrategy": "EXPONENTIAL_DECAY_RETRY",
            "MaximumEventAgeInSeconds": 512,
            "MaximumRetryAttempts": 2
          },
          "ErrorsTolerance": "ALL",
          "DeadLetterQueue": {
            "Arn": "acs:ram::159787121179****:role/aliyunsaedefaultrole"
          },
          "BatchWindow": {
            "CountBasedWindow": 100,
            "TimeBasedWindow": 10
          }
        },
        "Status": "RUNNING"
      }
    ],
    "NextToken": "177",
    "Total": 10
  },
  "Code": "Success",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息
403	ServiceNotEnable	Service not enable

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-09-10	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-08-19	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-07-12	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-06-28	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-05-31	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-04-09	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-11-22	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-10-11	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-09-13	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-06-09	OpenAPI 错误码发生变更、OpenAPI 入参发生变更	查看变更详情
2023-04-21	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-04-10	OpenAPI 错误码发生变更	查看变更详情