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