文档

ListEventStreamings - 查询事件流

更新时间:

查询事件流。

接口说明

查询事件流。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
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

事件流列表。

EventStreamingsobject []

事件流列表。

EventStreamingNamestring

事件流名称。

name
Descriptionstring

事件流描述信息。

demo
Sourceobject

事件提供方。

SourceMNSParametersobject

Source MNS Parameters

RegionIdstring

地域 ID。

cn-zhangjiakou
QueueNamestring

消息服务 MNS 的 Queue 的名称。

work4
IsBase64Decodeboolean

是否开启 Base64 编码。

true
SourceRabbitMQParametersobject

Source RabbitMQ Parameters

RegionIdstring

地域 ID。

cn-zhangjiakou
InstanceIdstring

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

dbaudit-cn-7mz2hqo****
VirtualHostNamestring

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

eb-connect
QueueNamestring

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

liuyang
SourceRocketMQParametersobject

Source RocketMQ Parameters

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

实例类型。

2
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
SourceKafkaParametersobject

Source Kafka Parameters

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
SourceMQTTParametersobject

Source MQTT 源

RegionIdstring

地域 ID。

cn-qingdao
InstanceIdstring

实例 id。

bastionhost-cn-zvp27kc****
Topicstring

Topic 名称。

migration_instance
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
FilterPatternstring

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

Transformsobject []

Transform 相关配置

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 Parameters

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}!
SinkSLSParametersobject

Sink SLS Parameters

Projectobject

日志服务 SLS 的日志项目。

Valuestring

日志服务 SLS 的日志项目。

test-project
Formstring

转换的格式。默认为 CONSTANT。

CONSTANT
Templatestring

LogStoreobject

日志服务 SLS 的日志库。

Valuestring

日志服务 SLS 的日志库。