ListEventStreamings - 查询事件流

查询事件流。

接口说明

查询事件流。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
NamePrefixstring

名称。

name
Limitinteger

限定每次返回的最大条数,可以和 NextToken 搭配使用实现翻页能力。

注意 每次返回的最大条数不超过 100。

10
NextTokenstring

当指定 Limit 时,如果还有多余的返回值则会返回 NextToken。

10
SourceArnstring

事件源 Arn。

acs:alikafka:cn-hangzhou:118609547428****:instance/alikafka_pre-cn-zxu36kvi****/topic/test-topic
SinkArnstring

事件目标 Arn。

acs:fc:cn-hangzhou:118609547428****:services/fw1.LATEST/functions/log1

返回参数

名称类型描述示例值
object

返回信息。

Messagestring

错误信息。

The event streaming [xxxx] not existed!
RequestIdstring

阿里云为该请求生成的唯一标识符。

283FF852-C4B8-58C9-9777-F88A5A16****
Dataobject

事件流列表。

EventStreamingsarray<object>

事件流列表。

EventStreamingsobject

事件流实体。

EventStreamingNamestring

事件流名称。

name
Descriptionstring

事件流描述信息。

demo
Sourceobject

事件提供方。

SourceMNSParametersobject

Source 轻量消息队列(原 MNS) 源。

RegionIdstring

地域 ID。

cn-zhangjiakou
QueueNamestring

轻量消息队列(原 MNS)的 Queue 的名称。

work4
IsBase64Decodeboolean

是否开启 Base64 编码。

true
SourceRabbitMQParametersobject

Source RabbitMQ 源。

RegionIdstring

地域 ID。

cn-zhangjiakou
InstanceIdstring

消息队列 RabbitMQ 版的实例的 ID。

dbaudit-cn-7mz2hqo****
VirtualHostNamestring

消息队列 RabbitMQ 版实例的 Vhost 的名称。

eb-connect
QueueNamestring

消息队列 RabbitMQ 版实例的 Queue 的名称。

liuyang
SourceRocketMQParametersobject

Source RocketMQ 源。

RegionIdstring

消息队列 RocketMQ 版的地域 ID。

cn-chengdu
InstanceIdstring

消息队列 RocketMQ 版的实例 id。

i-f8zbher64dlm58pl****
Topicstring

消息的 Topic。

topic_add_anima
Tagstring

消息的过滤标签。

v1
Offsetstring

消息的消费位点。取值说明如下: CONSUMEFROMLASTOFFSET:从最新位点开始消费。 CONSUMEFROMFIRSTOFFSET:从最早位点开始消费。 CONSUMEFROMTIMESTAMP:从指定时间点的位点开始消费。

CONSUMEFROMTIMESTAMP
GroupIDstring

消息队列 RocketMQ 版的 Group ID。

GID_group1
Timestamplong

时间戳。仅当参数 Offset 取值为 CONSUMEFROMTIMESTAMP 时,该参数有效。

1670742074043
InstanceTypestring

实例类型。取值说明如下:

  • Cloud_4:阿里云 RocketMQ 4.0 版本实例(默认选项)
  • Cloud_5:阿里云 RocketMQ 5.0 版本实例
  • SelfBuilt:自建 Apache RocketMQ 集群
Cloud_4
InstanceEndpointstring

实例接入点。

registry-vpc.cn-hangzhou.aliyuncs.com
AuthTypestring

鉴权类型。

ACL
InstanceUsernamestring

实例用户名。

admin**
InstancePasswordstring

实例密码。

123
InstanceVpcIdstring

专有网络 VPC 的 ID。

vpc-bp1a4gmlk31hy***l3ss
InstanceVSwitchIdsstring

实例交换机信息。

vsw-m5ev8asdc6h123456****
InstanceSecurityGroupIdstring

实例安全组信息。

sg-m5edtu24f12345****
InstanceNetworkstring

实例网络信息:

  • PublicNetwork
  • PrivateNetwork
PublicNetwork
BodyDataTypestring

消息编码格式:

  • JSON
  • Text
  • Binary
JSON
Networkstring

网络类型。

  • PublicNetwork
  • PrivateNetwork
PublicNetwork
FilterTypestring

消息过滤类型。

Tag
FilterSqlstring

sql 过滤语句。

index > 10
VpcIdstring

VPC 的 ID。

vpc-m5e3sv4b12345****
VSwitchIdsstring

虚拟交换机 ID。

vsw-m5ev8asdc6h12345****
SecurityGroupIdstring

安全组 ID。

sg-m5edtu24f12345****
SourceKafkaParametersobject

Source Kafka 源。

RegionIdstring

实例所在地域 id。

cn-chengdu
InstanceIdstring

实例 id。

bastionhost-cn-i7m2gwt****
Topicstring

Topic 名称。

topic_empower_1642473600414
ConsumerGroupstring

订阅该 Topic 的消费者所对应的 Group ID。

GID_TEST
OffsetResetstring

偏移量。

latest
Networkstring

网络配置 :默认值 Default,vpc 网络是 PublicNetwork。

Default
VpcIdstring

用户的 VPC ID。

vpc-wz9ki1qdlx3cx5cbf****
VSwitchIdsstring

交换机 ID。

vsw-bp1rmi8rind7eo50c****
SecurityGroupIdstring

安全组 ID。

sg-5ud5f3p0rqqis69****eho7cp
ValueDataTypestring

消息体编解码格式:

  • JSON
  • Text
  • Binary
JSON
SourceMQTTParametersobject

Source MQTT 源。

RegionIdstring

地域 ID。

cn-qingdao
InstanceIdstring

实例 id。

bastionhost-cn-zvp27kc****
Topicstring

Topic 名称。

migration_instance
BodyDataTypestring

消息编码格式:

  • JSON
  • Text
  • Binary
JSON
SourceDTSParametersobject

Source DTS 源。

TaskIdstring

任务 ID。

1611b337285f44e2936a2c4170****
BrokerUrlstring

数据订阅通道的网络地址及端口号信息。

Topicstring

数据订阅通道的订阅 Topic。

TP_TEST_UNDERWRITE_ISSUE
Sidstring

消费组 ID。

HG9
Usernamestring

消费组的账号。

admin
Passwordstring

消费组的账号密码。

123456
InitCheckPointstring

消费位点,即 SDK 客户端消费第一条数据的时间戳,格式为 Unix 时间戳。

1620962769
SourceSLSParametersobject

Source SLS 源。

Projectstring

日志服务 SLS 的日志项目。

dmmzk
LogStorestring

日志服务 SLS 的日志库。

waf-logstore
ConsumerGroupstring

订阅该 Topic 的消费者所对应的 Group ID。

go-dts-shelf-group
ConsumePositionstring

起始消费位点,可以选择最早或最新位点,分别对应“begin”,“end”,也可以从指定时间开始消费,以秒为单位。

begin
RoleNamestring

授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时,需满足条件:在 RAM 控制台创建服务所使用的角色时,需要选择“阿里云服务”,并且“受信服务”需要选择“事件总线”。

testRole
SourcePrometheusParametersobject

Source Prometheus 事件源。

RegionIdstring

地域 ID。

cn-beijing
ClusterIdstring

集群 id。

c83555068b6******ad213f565f209
DataTypestring

数据类型。

JSON
Labelsstring

标签。

__name__=.*
SourceCustomizedKafkaParametersobject

自定义 Kafka 事件源。

InstanceIdstring

实例 ID。

gtm-cn-k2c2yfg****
SourceCustomizedKafkaConnectorParametersobject

自定义连接器 Apache Kafka 事件源。

ConnectorPackageUrlstring

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"
ConnectorParametersobject

连接器参数。

Namestring

连接器名称。

test-name
Configobject

连接器配置。

{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" }
WorkerParametersobject

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" }
SourceOSSParametersobject

Source OSS 事件源。

RoleNamestring

授权事件总线 EventBridge 读取 OSS 文件的角色名称,要求该角色至少具有 OSS 的只读权限。

eventbridge_oss_role
BucketNamestring

对象存储 OSS 中的存储空间名称。

bucket_abc
Prefixstring

文件路径前缀。

fun/document/
LoadModestring

数据加载模式,single 表示单文档加载,element 表示分块加载。 取值:single/element 默认为 single。

single
LoadFormatstring

文档加载器。

TextLoader
Delimiterstring

分隔符,在分块加载模式下,以该分隔符作为文本的分块标识符,默认以换行符\n 作为分隔符。

\n
FilterPatternstring

事件过滤规则,如果不指定表示匹配全部事件。

Transformsarray<object>

Transform 相关配置。

Transformsobject

云产品的 ARN,比如函数计算中函数的 ARN。

Arnstring

云产品的 ARN,比如函数计算中函数的 ARN。

acs:fc:cn-hangzhou:*****:services/demo-service.LATEST/functions/demo-func
Sinkobject

事件目标。

SinkMNSParametersobject

轻量消息队列(原 MNS)事件目标。

QueueNameobject

目标服务类型为轻量消息队列(原 MNS)。

Valuestring

轻量消息队列(原 MNS)的 Queue 的名称。

MyQueue
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Bodyobject

消息内容。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
IsBase64Encodeobject

是否开启 Base64 编码。

Valuestring

开启 Base64 编码。

true
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

SinkFcParametersobject

函数目标。

ServiceNameobject

服务的名称。

Valuestring

服务的名称。

myService
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

FunctionNameobject

函数名称。

Valuestring

函数名称。

mFunction
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Concurrencyobject

投递并发度,最小为 1。

Valuestring

投递并发度,最小为 1。

1
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Qualifierobject

函数所属服务的别名。

Valuestring

函数所属服务的别名。

LATEST
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

InvocationTypeobject

同步或则异步。

  • Sync:同步。
  • Async:异步。
Valuestring

同步或则异步。

  • Sync:同步。
  • Async:异步。
Async
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Bodyobject

发送给函数的内容体。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
SinkRabbitMQParametersobject

Sink Rabbitmq 的参数。

InstanceIdobject

目标服务类型为消息队列 RabbitMQ 版。

Valuestring

消息队列 RabbitMQ 版的实例 ID。

si-296cd57939a1421b****
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

VirtualHostNameobject

消息队列 RabbitMQ 版实例的 Vhost 的名称。

Valuestring

消息队列 RabbitMQ 版实例的 Vhost 的名称。

rabbit-host
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

TargetTypeobject

目标类型。

Valuestring

目标类型。取值说明如下: Exchange:Exchange 模式。 Queue:Queue 模式。

Queue
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Exchangeobject

Exchange 模式。 仅当参数 TargetType 配置为 Exchange 时,需配置此参数。

Valuestring

消息队列 RabbitMQ 版实例的 Exchange 的名称。

a_exchange
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

RoutingKeyobject

消息的路由规则。 仅当参数 TargetType 配置为 Exchange 时,需配置此参数。

Valuestring

消息的路由规则。

housekeeping
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

QueueNameobject

Queue 模式。 仅当参数 TargetType 配置为 Queue 时,需配置此参数。

Valuestring

实例的 Queue 的名称。

MyQueue
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Bodyobject

消息内容。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
MessageIdobject

消息 ID。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
Propertiesobject

过滤属性。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
SinkKafkaParametersobject

Sink kafka 参数。

InstanceIdobject

目标服务类型为消息队列 Kafka 版。

Valuestring

实例 ID。

Defaut_1283278472_sad****
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Topicobject

主题名称。

Valuestring

主题名称。

topic
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Acksobject

写入 Kafka 确认模式:

  • acks=0:无需服务端的 Response、性能较高、丢数据风险较大。
  • acks=1:服务端主节点写成功即返回 Response、性能中等、丢数据风险中等、主节点宕机可能导致数据丢失;
  • acks=all:服务端主节点写成功且备节点同步成功才返回 Response、性能较差、数据较为安全、主节点和备节点都宕机才会导致数据丢失。
Valuestring

写入 Kafka 确认模式:

  • acks=0:无需服务端的 Response、性能较高、丢数据风险较大。
  • acks=1:服务端主节点写成功即返回 Response、性能中等、丢数据风险中等、主节点宕机可能导致数据丢失;
  • acks=all:服务端主节点写成功且备节点同步成功才返回 Response、性能较差、数据较为安全、主节点和备节点都宕机才会导致数据丢失。
1
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Keyobject

消息的标识。

Valuestring

消息的标识。

key
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Valueobject

消息体内容。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
SinkRocketMQParametersobject

Sink RocketMQ 源。

InstanceIdobject

目标服务类型为消息队列 RocketMQ 版。

Valuestring

消息队列 RocketMQ 版的实例 ID。

MQ_INST_164901546557****_BAAN****
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Topicobject

消息队列 RocketMQ 版实例的 Topic。

Valuestring

消息队列 RocketMQ 版实例的 Topic。

topic
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Bodyobject

消息内容。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
Propertiesobject

过滤属性。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
Keysobject

过滤属性。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
Tagsobject

过滤属性。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
InstanceTypeobject

实例类型。

Valuestring

实例类型。取值说明如下:

  • Cloud_4:阿里云 RocketMQ 4.0 版本实例(默认选项)
  • Cloud_5:阿里云 RocketMQ 5.0 版本实例
  • SelfBuilt:自建 Apache RocketMQ 集群
Cloud_4
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

InstanceEndpointobject

实例接入点。

Valuestring

实例接入点。

vbr-8vbsvkkbpf3vb0zef****
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

InstanceUsernameobject

实例用户名。

Valuestring

实例用户名。

admin
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

InstancePasswordobject

实例密码。

Valuestring

实例密码。

admin******
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

VpcIdobject

VPC 的 ID。

Valuestring

VPC 的 ID。

vbr-8vb835n3zf9shwlvb****
Formstring

事件转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

VSwitchIdsobject

交换机 ID。

Valuestring

交换机 ID。

vbr-8vb835n3zf9shwl****mp
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

SecurityGroupIdobject

安全组 ID。

Valuestring

安全组 ID。

b4bf375515f6440f942e3a20c33d****
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Networkobject

网络类型。

  • PublicNetwork
  • PrivateNetwork
Valuestring

网络类型。

  • PublicNetwork
  • PrivateNetwork
PublicNetwork
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

SinkSLSParametersobject

Sink SLS Parameters

Projectobject

日志服务 SLS 的日志项目。

Valuestring

日志服务 SLS 的日志项目。

test-project
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

LogStoreobject

日志服务 SLS 的日志库。

Valuestring

日志服务 SLS 的日志库。

test-logstore
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Topicobject

日志所在的 topic,对应 SLS 保留字段“topic”。

Valuestring

日志所在的 topic,对应 SLS 保留字段“topic”。

topic
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Bodyobject

发送给 SLS 的内容。

Valuestring

转换前的值。

{ "key": "value" }
Formstring

转换的格式。

TEMPLATE
Templatestring

模板样式。

The value of ${key} is ${value}!
RoleNameobject

授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时,需满足条件:在 RAM 控制台创建服务所使用的角色时,需要选择“阿里云服务”,并且“受信服务”需要选择“事件总线”。

Valuestring

授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时,需满足条件:在 RAM 控制台创建服务所使用的角色时,需要选择“阿里云服务”,并且“受信服务”需要选择“事件总线”。

test-role
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

ContentTypeobject

SLS 数据格式。可选择默认或者配置制定的键值:

  • JSON
  • KeyValue
Valuestring

SLS 数据格式。可选择默认或者配置制定的键值:

  • JSON
  • KeyValue
JSON
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

ContentSchemaobject

自定义日志的键值,仅在 ContentType 为 KeyValue 生效。每一对键值由 Key_n, Value_n 表示。

Valuestring

转换前的值。

{"Key_1":{"form":"CONSTANT","value":"demoKey"},"Value_1":{"form":"JSONPATH","value":"$.data.value"}}
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

SinkFnfParametersobject

Sink Fnf 参数。

FlowNameobject

流程名称。

Valuestring

流程名称。

test-streaming-fnf
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

ExecutionNameobject

执行名称。

Valuestring

执行名称。

123
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

Inputobject

执行输入信息。

Valuestring

执行输入信息。

123
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

RoleNameobject

角色配置。

Valuestring

角色配置。

Al****FNF-x****
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

模板样式。

SinkDataHubParametersobject

Sink DataHub 参数。

Projectobject

DataHub 项目名。

Valuestring

DataHub 项目名。

demo-project
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Topicobject

DataHub Topic 名称。

Valuestring

DataHub Topic 名称。

demo-topic
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

TopicTypeobject

topic 类型:

  • TUPLE
  • BLOB
Valuestring

topic 类型:

  • TUPLE
  • BLOB
TUPLE
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

TopicSchemaobject

TUBLE 类型,topic 内容模式。

Valuestring

TUBLE 类型,topic 内容模式。

{"k1":"value1","k2":"value2"}
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

Bodyobject

BLOB 类型,Record 内容模板。

Valuestring

BLOB 类型,Record 内容模板。

Formstring

转换的格式。

ORIGINAL
Templatestring

RoleNameobject

授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时,需满足条件:在 RAM 控制台创建服务所使用的角色时,需要选择“阿里云服务”,并且“受信服务”需要选择“事件总线”。

Valuestring

授权事件总线 EventBridge 使用此角色读取 SLS 日志内容时,需满足条件:在 RAM 控制台创建服务所使用的角色时,需要选择“阿里云服务”,并且“受信服务”需要选择“事件总线”。

testRole
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

SinkCustomizedKafkaParametersobject

Sink Kafka 参数。

InstanceIdstring

消息队列 Kafka 版的实例 ID。

90be1f96-4229-4535-bb76-34b4f6fb2b71
SinkCustomizedKafkaConnectorParametersobject

Sink Kafka 连接器参数。

ConnectorPackageUrlstring

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"
ConnectorParametersobject

解析当前 ZIP 包下的 properties 文件。

Namestring

连接器名称。

mongo-sink
Configobject

连接器配置。

{ "connector.class": "com.mongodb.kafka.connect.MongoSinkConnector", "tasks.max": "1", "topics": "sourceA,sourceB" }
WorkerParametersobject

实例配置。

{ "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" }
SinkDashVectorParametersobject

Sink DashVector 参数。

InstanceIdstring

实例 ID。

vrs-cn-lbj3ru1***
Collectionstring

Collection(集合)名称。

collection1
ApiKeystring

DashVecotor 控制台创建的 API Key。

Q34nExQH7sQ****
Operationstring

DashVector 数据库操作类型。

Upsert
Networkstring

网络类型。

PublicNetwork
PrimaryKeyIdobject

插入/删除记录时的主键 ID 不填写此字段时,使用随机主键 ID。

Formstring

转换的格式。

JSONPATH
Valuestring
  • Form 为 JSONPATH:JSONPath 提取内容
  • Form 为 TEMPLATE:模板变量

注:Value 字段不允许超过 10240 个字符。

$.data.requestId
Templatestring

主键 ID 模板,仅当 Form 是 TEMPLATE 时需要填写。

${ID}
Partitionobject

Partition(分区),默认值为 default 分区。

Formstring

转换的格式。

CONSTANT
Valuestring
  • Form 为 CONSTANT:常量值
  • Form 为 JSONPATH:JSONPath 提取内容

注:Value 字段不允许超过 10240 个字符。

default
Templatestring

Vectorobject

插入 DashVector 记录的向量。

Formstring

转换的格式。

JSONPATH
Valuestring

JSONPath 提取内容。

注:Value 字段不允许超过 10240 个字符。

$.data.messageBody
Templatestring

DashVectorSchemaParametersobject

插入 DashVector 时表项的 Schema 字段定义,事件内容转换后结果必须是 JSON 格式。

Formstring

转换的格式。

TEMPLATE
Valuestring
  • Form 为 CONSTANT:常量值
  • Form 为 JSONPATH:JSONPath 提取内容
  • Form 为 TEMPLATE:模板变量

注:Value 字段不允许超过 10240 个字符。

{ "value1":"v1", "value2":"v2" }
Templatestring

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}" } ]
RunOptionsobject

运行环境参数。

MaximumTasksinteger

并发数。

2
RetryStrategyobject

事件推送失败时的重试策略。

PushRetryStrategystring

重试策略:BACKOFF_RETRY(退避重试)和 EXPONENTIAL_DECAY_RETRY(指数衰减重试)。

EXPONENTIAL_DECAY_RETRY
MaximumEventAgeInSecondsfloat

最大重试时间。

512
MaximumRetryAttemptsfloat

最大重试次数。

2
ErrorsTolerancestring

异常容忍策略:NONE(不容忍异常)、ALL(容忍所有异常)。

ALL
DeadLetterQueueobject

是否启用死信队列。默认不启用死信队列,超过重试策略后的消息将被丢弃。

Arnstring

死信队列 ARN。

acs:ram::159787121179****:role/aliyunsaedefaultrole
BatchWindowobject

攒批窗口。

CountBasedWindowinteger

窗口中最大可容纳的事件数量。当达到此阈值,会触发窗口内的数据往下游推送。当存在多个窗口时,有一个窗口满足即触发。

100
TimeBasedWindowinteger

窗口中最大可容纳的时间范围内的事件(单位秒)。当达到此阈值,会触发窗口内的数据往下游推送。当存在多个窗口时,有一个窗口满足即触发。

10
Statusstring

获取到的事件流的状态。

RUNNING
NextTokenstring

用来表示当前调用返回读取到的位置,空代表数据已经读取完毕。下次调用时,需要将此设置到入参 NextToken 中。

177
Totalinteger

总共记录数。

10
Codestring

接口返回码:

Success:表示成功。

其它:表示错误码。错误码详情,请参见错误码。

Success
Successboolean

操作成功返回 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错误码错误信息
403ServiceNotEnableService not enable

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

变更历史

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