调用ListEventStreamings查询事件流-阿里云帮助中心

object

返回信息。

Message

string

错误信息。

The event streaming [xxxx] not existed!

RequestId

string

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

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

Data

object

事件流列表。

EventStreamings

array<object>

事件流列表。

array<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

integer

时间戳。仅当参数 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****

SourceRocketMQCheckpointParameters

object

Source RocketMQ Checkpoint 源

RegionId

string

地域 ID。

cn-hangzhou

InstanceType

string

消息队列 RocketMQ 版实例的类型。

Cloud_5

InstanceId

string

消息队列 RocketMQ 版实例 ID。

rmq-cn-jte3w******

Topics

array

消息队列 RocketMQ 版实例 Topic。

string

消息队列 RocketMQ 版实例 Topic。

myTopic

SourceApacheRocketMQCheckpointParameters

object

Source RocketMQ Checkpoint 源

RegionId

string

地域 ID。

cn-hangzhou

Topics

array

Apache RocketMQ 实例 Topic。

string

Apache RocketMQ 实例 Topic。

myTopic

InstanceEndpoint

string

Apache RocketMQ 实例的接入点。

192.168.1.1:9876

InstanceUsername

string

Apache RocketMQ 实例的用户名。

admin

InstancePassword

string

Apache RocketMQ 实例的密码。

****

NetworkType

string

网络类型。

PrivateNetwork

VpcId

string

VPC ID。

vpc-adw1awdw*****

VSwitchId

string

交换机 ID。

vsw-dwaafds****

SecurityGroupId

string

安全组 ID。

sg-mw43*****

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__=.*

RoleName

string

访问 Prometheus 数据的角色。

testRole

ExternalLabels

string

事件中附加的自定义标签。

{"source":"prometheus-prod"}

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

SourceOpenSourceRabbitMQParameters

object

Source Open Source RabbitMQ 源。

Endpoint

string

实例接入点。

192.168.1.1:9876

VirtualHostName

string

开源 RabbitMQ 实例的虚拟主机名称。

Vhost1

QueueName

string

开源 RabbitMQ 实例的队列名称。

demo

BodyDataType

string

消息体数据类型。

Json

Username

string

连接开源 RabbitMQ 实例时使用的用户名。

admin

Password

string

连接开源 RabbitMQ 实例时使用的密码。

****

VpcId

string

VPC ID。

vpc-m5e3sv4b12345****

VSwitchIds

string

交换机 ID。

vsw-m5ev8asdc6h12345****

SecurityGroupId

string

安全组 ID。

sg-m5edtu24f12345****

NetworkType

string

网络类型。

PrivateNetwork

AuthType

string

鉴权类型。

ACL

SourceEventBusParameters

object

Source EventBus 源。

EventBusName

string

事件总线名称。

my-event-bus

EventRuleName

string

事件规则名称。

my-event-rule

SourceMySQLParameters

Source MySQL 源。

FilterPattern

string

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

无

Transforms

array<object>

Transform 相关配置。

object

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

Arn

string

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

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

DashScopeTransformParameters

BaiLianAgentTransformParameters

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

DataFormat

object

事件内容格式的转换规则。

Value

string

转换前的值。

{ "key": "value" }

Form

string

转换格式，默认为 CONSTANT。

CONSTANT

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

ListEventStreamings - 查询事件流

接口说明

调试

授权信息

请求参数

返回参数

错误码

变更历史

名称	类型	必填	描述	示例值
NamePrefix	string	否	事件流名称前缀。	name
Limit	integer	否	限定每次返回的最大条数，可以和 NextToken 搭配使用实现翻页能力。重要每次返回的最大条数不超过 100。	10
NextToken	string	否	当指定 Limit 时，如果还有多余的返回值则会返回 NextToken。	10
Tags	array<object>	否	标签筛选。
	object	否	标签。
Key	string	否	标签键。	mns
Value	string	否	标签值。	mnstest
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