网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
更新时间:2024-03-29 GMT+08:00
分享

查询事件流列表

功能介绍

查询事件流列表。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/eventstreamings

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

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

最小值:0

最大值:100

缺省值:0

limit

Integer

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

最小值:1

最大值:1000

缺省值:15

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:16384

响应参数

状态码: 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

对象列表

数组长度:0 - 100

表6 EventStreamingDetail

参数

参数类型

描述

name

String

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

最小长度:1

最大长度:128

description

String

事件流描述

最大长度:255

source

EventStreamingSource object

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

sink

EventStreamingSink object

事件目标,一个事件流中只有一个

rule_config

rule_config object

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

option

RunOption object

运行时配置信息

status

String

事件流状态

最小长度:1

最大长度:128

枚举值:

  • CREATED

  • RUNNING

  • ERROR

  • STOPPED

id

String

事件流ID

created_time

String

创建时间

updated_time

String

更新时间

表7 EventStreamingSource

参数

参数类型

描述

source_kafka

SourceKafkaMQParameters object

华为云DMS版kafka类型事件源

source_mobile_rocketmq

SourceMobileMQParameters object

移动云版rocketMQ类型事件源

source_community_rocketmq

SourceCommunityMQParameters object

社区版rocketMQ类型事件源

source_dms_rocketmq

SourceDMSMQParameters object

华为云DMS版rocketMQ事件源

name

String

事件源类型名称

枚举值:

  • HC.Kafka

  • HC.COMMUNITY_ROCKETMQ

  • HC.DMS_ROCKETMQ

  • HC.MOBILE_ROCKETMQ

表8 SourceKafkaMQParameters

参数

参数类型

描述

addr

String

kafka连接地址

group

String

kafka消费组

最小长度:1

最大长度:256

instance_name

String

kafka实例名称

最小长度:4

最大长度:64

security_protocol

String

安全协议

instance_id

String

kafka实例ID

最小长度:1

最大长度:256

topic

String

kafka topic名称

最小长度:3

最大长度:200

seek_to

String

消费点位

枚举值:

  • latest

  • earliest

enable_sasl_ssl

Boolean

SASL_SSL是否开启

sasl_mechanism

String

SASL认证机制

枚举值:

  • SCRAM-SHA-512

  • PLAIN

ssl_certificate_url

String

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

最小长度:1

最大长度:512

ssl_certificate_pwd

String

SASL证书密码

最小长度:1

最大长度:256

user_name

String

用户名

最小长度:1

最大长度:256

password

String

用户密码

最小长度:1

最大长度:256

表9 SourceMobileMQParameters

参数

参数类型

描述

group_id

String

消费组id

最小长度:3

最大长度:128

instance_id

String

实例id

最小长度:3

最大长度:128

topic

String

topic

最小长度:3

最大长度:128

tag

String

标签

最大长度:128

authentication_required

Boolean

鉴权认证

msg_trace_switch

Boolean

保存消息轨迹

access_key

String

AccessKey

最大长度:128

secret_key

String

SecretKey

最大长度:128

message_model

String

订阅方式

缺省值:CLUSTERING

枚举值:

  • CLUSTERING

  • BROADCASTING

addr_type

String

接入点类型

缺省值:PUBLIC

枚举值:

  • PUBLIC

  • PRIVATE

addr

String

地址

最大长度:256

sdk_url

String

依赖SDK

最大长度:256

consume_timeout

Integer

消费超时时间

最小值:1000

最大值:900000

缺省值:30000

message_type

String

消息类型

枚举值:

  • NORMAL

suspend_time

Integer

失败重试的等待时间

最小值:10

最大值:1800

缺省值:1800

max_reconsumer_times

Integer

最大重试次数

最小值:1

最大值:16

缺省值:3

consumer_thread_nums

Integer

消费线程数

最小值:20

最大值:64

缺省值:20

consumer_batch_max_size

Integer

批量消费最大消息数

最小值:1

最大值:1024

缺省值:20

consumer_max_wait

Integer

批量消费最大等待时长,单位:秒

最小值:0

最大值:450

缺省值:5

vpc_id

String

虚拟私有云

subnet_id

String

子网

表10 SourceCommunityMQParameters

参数

参数类型

描述

instance_name

String

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

最大长度:128

instance_id

String

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

最大长度:128

addr

String

rockectMq连接地址

group

String

消费组

最小长度:3

最大长度:64

topic

String

topic名称

最小长度:3

最大长度:64

tag

String

标签

最大长度:128

vpc_id

String

虚拟云id

最大长度:256

subnet_id

String

子网id

最大长度:256

ssl_enable

Boolean

开启SSL

enable_acl

Boolean

ACL访问控制

access_key

String

用户名

最大长度:128

secret_key

String

密码

message_type

String

消息类型

枚举值:

  • normal

consume_timeout

Integer

消费超时时间

最小值:1000

最大值:900000

缺省值:30000

consumer_thread_nums

Integer

线程消费数

最小值:20

最大值:64

缺省值:20

consumer_batch_max_size

Integer

批量消费最大消息数

最小值:1

最大值:32

缺省值:1

表11 SourceDMSMQParameters

参数

参数类型

描述

instance_name

String

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

最大长度:128

instance_id

String

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

最大长度:128

group

String

消费组

最小长度:3

最大长度:64

topic

String

topic名称

最小长度:3

最大长度:64

tag

String

标签

最大长度:128

ssl_enable

Boolean

开启SSL

enable_acl

Boolean

ACL访问控制

access_key

String

用户名

最大长度:128

secret_key

String

密码

message_type

String

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

枚举值:

  • NORMAL

  • ORDER

engine_version

String

mq实例版本

枚举值:

  • 4.x

  • 5.x

consume_timeout

Integer

消费超时时间

最小值:1000

最大值:900000

缺省值:30000

consumer_thread_nums

Integer

线程消费数

最小值:20

最大值:64

缺省值:20

consumer_batch_max_size

Integer

批量消费最大消息数

最小值:1

最大值:32

缺省值:1

表12 EventStreamingSink

参数

参数类型

描述

sink_fg

SinkFGParameters object

函数目标参数

sink_kafka

SinkKafkaParameters object

kafka目标参数

name

String

事件目标类型名称

枚举值:

  • HC.FunctionGraph

  • HC.Kafka

表13 SinkFGParameters

参数

参数类型

描述

invoke_type

String

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

枚举值:

  • SYNC,ASYNC

urn

String

函数链接

最小长度:1

最大长度:512

agency

String

租户委托

表14 SinkKafkaParameters

参数

参数类型

描述

topic

String

topic名称

keyTransform

Array of TransForm objects

key的转换规则

connectionId

String

目标连接id

表15 TransForm

参数

参数类型

描述

type

String

转换规则类型

枚举值:

  • ORIGINAL

  • CONSTANT

  • VARIABLE

value

String

常量类型规则时,字段为常量内容定义; 变量类型规则时,为变量定义,内容必须为JsonObject字符串。 变量最多支持100个,且不支持嵌套结构定义; 变量名由字母、数字、点、下划线和中划线组成,必须字母或数字开头不能以HC.开头,长度不超过64个字符; 变量值表达式支持常量或JsonPath表达式,字符串长度不超过1024个字符。

最大长度:1024

template

String

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

最大长度:2048

表16 rule_config

参数

参数类型

描述

transform

TransForm object

转换规则

filter

Object

过滤规则

表17 RunOption

参数

参数类型

描述

thread_num

Integer

并发数

最小值:1

最大值:1000

batch_window

BatchWindow object

批量推送

表18 BatchWindow

参数

参数类型

描述

count

Integer

批量推送条数

最小值:1

最大值:10000

缺省值:1

time

Integer

重试次数

最小值:0

最大值:15

缺省值:3

interval

Integer

批量推送间隔,单位秒

最小值:0

最大值:15

缺省值:0

状态码: 400

表19 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 401

表20 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 403

表21 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 404

表22 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

状态码: 500

表23 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:1

最大长度:128

error_msg

String

错误消息

最小长度:1

最大长度:512

error_details

String

具体错误消息

最小长度:1

最大长度:1024

request_id

String

请求处理ID

最小长度:1

最大长度:128

请求示例

响应示例

状态码: 400

{
  "error_code" : "EG.00014000",
  "error_msg" : "Bad request"
}

状态码: 401

{
  "error_code" : "EG.00014010",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码: 403

{
  "error_code" : "EG.00014030",
  "error_msg" : "No permissions to request this method"
}

状态码: 404

{
  "error_code" : "EG.00014040",
  "error_msg" : "Not request resource found"
}

状态码: 500

{
  "error_code" : "EG.00015000",
  "error_msg" : "Internal Server Error"
}

状态码

状态码

描述

200

事件流列表

400

非法请求

401

未授权

403

禁止访问

404

未找到资源

500

内部服务错误

错误码

请参见错误码

相关文档