文档首页/ 事件网格 EG/ API参考/ API/ 事件流管理/ 查询事件流列表 - ListEventStreaming
更新时间：2025-10-22 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询事件流列表 - ListEventStreaming

功能介绍

查询事件流列表。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/eventstreamings

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户资源空间ID
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

偏移量，表示从此偏移量开始查询，偏移量不能小于0

limit

否

Integer

每页显示的条目数量，不能小于1或大于1000

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.
表5 响应Body参数

参数

参数类型

描述

total

Integer

总数

size

Integer

本页数量

items

Array of EventStreamingDetail objects

对象列表
表6 EventStreamingDetail

参数

参数类型

描述

name

String

事件流名称，租户下唯一，由字母、数字、点、下划线和中划线组成，必须字母或数字开头

description

String

事件流描述

source

EventStreamingSource object

事件源，一个事件流中事件源只有一个

sink

EventStreamingSink object

事件目标，一个事件流中只有一个事件目标，sink_fg、sink_kafka只能选择其中一个参数

rule_config

rule_config object

事件规则，包括过滤规则和转换规则

option

RunOption object

运行配置

status

String

事件流状态

id

String

事件流ID

created_time

String

创建时间

updated_time

String

更新时间
表7 EventStreamingSource

参数

参数类型

描述

source_kafka

SourceKafkaMQParameters object

事件源参数

source_mobile_rocketmq

SourceMobileMQParameters object

事件流移动云rockectMq事件源参数

source_community_rocketmq

SourceCommunityMQParameters object

事件流社区rockectMq事件源参数

source_dms_rocketmq

SourceDMSMQParameters object

DMS事件源参数

name

String

事件源类型名称
表8 SourceKafkaMQParameters

参数

参数类型

描述

addr

String

kafka连接地址

group

String

kafka消费组

instance_name

String

kafka实例名称

security_protocol

String

安全协议

instance_id

String

kafka实例ID

topic

String

kafka topic名称

seek_to

String

消费点位

enable_sasl_ssl

Boolean

SASL_SSL是否开启

sasl_mechanism

String

SASL认证机制

ssl_certificate_url

String

SASL证书地址，配置的obs地址

ssl_certificate_pwd

String

SASL证书密码

user_name

String

用户名

password

String

用户密码
表9 SourceMobileMQParameters

参数

参数类型

描述

group_id

String

消费组id

instance_id

String

实例id

topic

String

topic

tag

String

标签

authentication_required

Boolean

鉴权认证

msg_trace_switch

Boolean

保存消息轨迹

access_key

String

AccessKey

secret_key

String

SecretKey

message_model

String

订阅方式

addr_type

String

接入点类型

addr

String

地址

sdk_url

String

依赖SDK

consume_timeout

Integer

消费超时时间

message_type

String

消息类型

suspend_time

Integer

失败重试的等待时间

max_reconsumer_times

Integer

最大重试次数

consumer_thread_nums

Integer

消费线程数

consumer_batch_max_size

Integer

批量消费最大消息数

consumer_max_wait

Integer

批量消费最大等待时长，单位：秒

vpc_id

String

虚拟私有云

subnet_id

String

子网
表10 SourceCommunityMQParameters

参数

参数类型

描述

instance_name

String

实例名称，仅dms的rockectMq需要该字段

instance_id

String

实例ID，仅dms的rockectMq需要该字段

addr

String

rockectMq连接地址

group

String

消费组

topic

String

topic名称

tag

String

标签

vpc_id

String

虚拟云id

subnet_id

String

子网id

ssl_enable

Boolean

开启SSL

enable_acl

Boolean

ACL访问控制

access_key

String

用户名

secret_key

String

密码

message_type

String

消息类型

consume_timeout

Integer

消费超时时间

consumer_thread_nums

Integer

线程消费数

consumer_batch_max_size

Integer

批量消费最大消息数

max_reconsume_times

Integer

最大重试次数，-1表示一直重试

suspend_current_queue_time_millis

Integer

重试间隔，单位ms
表11 SourceDMSMQParameters

参数

参数类型

描述

instance_name

String

实例名称，仅dms的rockectMq需要该字段

instance_id

String

实例ID，仅dms的rockectMq需要该字段

group

String

消费组

topic

String

topic名称

tag

String

标签

ssl_enable

Boolean

开启SSL

enable_acl

Boolean

ACL访问控制

access_key

String

用户名

secret_key

String

密码

message_type

String

消费方式，针对不同生产顺序消息类型，选择消费方式会导致不同结果，请严格按照需求选择消费方式。1、生产顺序为：设置消息组，保证消息顺序发送。消费方式为：顺序消费，实际消息处理结果：按照消息组粒度，严格保证消息顺序。 同一消息组内的消息的消费顺序和发送顺序完全一致。2、生产顺序为：设置消息组，保证消息顺序发送。消费方式为：并发消费，实际消息处理结果：并发消费，尽可能按时间顺序处理。3、生产顺序为：未设置消息组，消息乱序发送。消费方式为：顺序消费，实际消息处理结果：按队列存储粒度，严格顺序。 基于 Apache RocketMQ 本身队列的属性，消费顺序和队列存储的顺序一致，但不保证和发送顺序一致。4、生产顺序为：未设置消息组，消息乱序发送。消费方式为：并发消费，实际消息处理结果：并发消费，尽可能按照时间顺序处理。

engine_version

String

mq实例版本

consume_timeout

Integer

消费超时时间

consumer_thread_nums

Integer

线程消费数

consumer_batch_max_size

Integer

批量消费最大消息数

max_reconsume_times

Integer

最大重试次数，-1表示一直重试

suspend_current_queue_time_millis

Integer

重试间隔，单位ms
表12 EventStreamingSink

参数

参数类型

描述

sink_fg

SinkFGParameters object

函数事件目标的参数

sink_kafka

SinkKafkaParameters object

kafka事件目标的参数

sink_obs

SinkObsParameters object

OBS事件目标的参数

name

String

事件目标类型名称
表13 SinkFGParameters

参数

参数类型

描述

invoke_type

String

函数执行方式,同步/异步

urn

String

函数链接

agency

String

租户委托
表14 SinkKafkaParameters

参数

参数类型

描述

topic

String

topic名称

keyTransform

Array of TransForm objects

key的转换规则

connectionId

String

目标连接id
表15 TransForm

参数

参数类型

描述

type

String

转换规则类型

value

String

常量类型规则时，字段为常量内容定义；

变量类型规则时，为变量定义，内容必须为JsonObject字符串。

变量最多支持100个，且不支持嵌套结构定义；

变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符；

变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。

template

String

变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。
表16 SinkObsParameters

参数

参数类型

描述

access_key

String

AK

secret_key

String

SK

obs_bucket

String

桶

obs_path

String

转储目录

time_format

String

时间目录格式
表17 rule_config

参数

参数类型

描述

transform

TransForm object

订阅的事件目标转换规则

filter

Object

过滤规则
表18 RunOption

参数

参数类型

描述

thread_num

Integer

并发数

batch_window

BatchWindow object

批量推送
表19 BatchWindow

参数

参数类型

描述

count

Integer

批量推送条数[1,10000]

time

Integer

重试次数

interval

Integer

批量推送间隔[0,15]，单位秒

请求示例

查询事件流列表

GET https://{eg_endpoint}/v1/{project_id}/eventstreamings

响应示例

状态码：200

事件流列表

{
  "total" : 1,
  "size" : 1,
  "items" : [ { } ]
}

状态码

状态码

描述

200

事件流列表

错误码

请参见错误码。

父主题： 事件流管理