API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(eventbridge/2020-04-01)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

事件总线

API

标题

API概述

CreateEventBus 创建一个事件总线 创建一个事件总线。
DeleteEventBus 删除一个事件总线 删除一个事件总线。
UpdateEventBus 修改事件总线 修改事件总线。
GetEventBus 获取一个事件总线的详细信息 获取一个事件总线的详细信息。
ListEventBuses 查询所有事件总线 查询所有事件总线。

事件

API

标题

API概述

QueryEvent 查询事件内容 查询事件内容。
QueryEventTraces 查询事件轨迹推送详情 查询事件轨迹。
QueryTracedEventByEventId 获取事件轨迹基本信息 通过EventId查询事件轨迹。
QueryTracedEvents 通过时间范围查询事件轨迹 通过时间范围查询事件轨迹。

事件源

API

标题

API概述

ListAliyunOfficialEventSources 查询所有阿里云官方事件源 查询所有阿里云官方事件源。
ListUserDefinedEventSources 查询所有外部事件源 查询所有外部事件源。
CreateEventSource 创建一个事件源 创建一个外部事件源。
DeleteEventSource 删除一个事件源 删除一个事件源。
UpdateEventSource 更新一个事件源 更新一个事件源的配置。

事件目标

API

标题

API概述

DeleteTargets 删除一个事件规则下的目标 删除一个事件规则下的一个或多个投递目标。
PutTargets 在指定的规则下创建或更新事件目标 在指定的规则下创建或更新事件目标。

事件规则

API

标题

API概述

CreateRule 创建一个事件规则 创建一个事件规则。
DeleteRule 删除一个事件规则 删除一个事件规则。
DisableRule 禁用一个事件规则 禁用一个事件规则。
EnableRule 启用一个事件规则 启用一个事件规则。
UpdateRule 更新一个事件规则的配置 更新一个事件规则的配置。
GetRule 获取一个事件规则的详细信息 获取一个事件规则的详细信息。
ListRules 查询一个事件总线的所有规则 查询一个事件总线的所有规则。

事件流

API

标题

API概述

ListEventStreamings 查询事件流 查询事件流。
DeleteEventStreaming 删除一个事件流 删除一个事件流。
PauseEventStreaming 停用一个运行中的事件流 停用一个运行中的事件流。
StartEventStreaming 启用一个已创建或已停用的事件流 启用一个已创建或已停用的事件流。
GetEventStreaming 获取一个事件流的详细信息 获取一个事件流的详细信息。
UpdateEventStreaming 修改一个事件流 修改一个事件流的基础信息、事件源信息、事件过滤模式或事件目标信息。
CreateEventStreaming 创建一个事件流 创建一个事件流。

API端点

API

标题

API概述

UpdateApiDestination 更新API 端点 更新API 端点。
CreateApiDestination 创建API端点信息 创建API端点信息。
CreateConnection 创建连接配置信息 创建连接配置信息。
DeleteApiDestination 删除API 端点 删除API 端点。
DeleteConnection 删除指定的连接配置信息 删除指定的连接配置信息。
GetApiDestination 查询单个API 端点信息 查询单个API 端点信息。
GetConnection 查询单个连接配置信息 查询单个连接配置信息。
ListApiDestinations 获取API 端点列表 获取API 端点列表信息。
ListConnections 获取连接配置列表 获取连接配置列表。
UpdateConnection 更新连接配置信息 更新连接配置信息。

其他

API

标题

API概述

CreateServiceLinkedRoleForProduct 根据产品关联的 SLR名称创建SLR 根据产品关联的 SLR名称创建SLR。
ListTargets 查询一个事件规则的所有投递目标 查询一个事件规则的所有投递目标。
TestEventPattern 测试事件模式是否与提供的 JSON 格式事件匹配 测试事件模式是否与提供的 JSON 格式事件匹配。
EventCenterQueryEvents 在事件分析功能中查询事件 EventCenterQueryEvents
CheckServiceLinkedRoleForProduct 检查账号是否存在ServiceLinkedRole授权。 检查账号是否存在ServiceLinkedRole授权。
TestEventSourceConfig 测试数据源配置 检查EventSource配置是否可用
DiscoverEventSource 探测事件源 发现EventSource(例如:Mysql)的SchemaSimpleData
UpdateEventStreamingBusinessOption 编辑事件流计费模式 查询事件流
DeleteNamespace 删除命名空间 删除命名空间
UpdateNamespace 编辑命名空间 修改命名空间
DeleteTable 删除表 删除表
ListNamespaces 查询命名空间列表 查询命名空间列表
ListTables 列举表 查询表列表
CreateAgent 创建自定义Agent 创建自定义Agent
UpdateAgent 更新自定义Agent 更新自定义Agent
GetTable 查询表 获取表
ListCatalogs 查询catalog列表 查询数据目录列表
CreateNamespace 创建命名空间 创建命名空间
GetNamespace 查询命名空间 获取命名空间
ListAgents 获取自定义Agent列表 获取自定义Agent列表
GetAgent 获取Agent元数据 获取Agent元数据
DeleteAgent 删除自定义Agent DeleteAgent
GetCatalog 查询catalog 获取数据目录
UpdateTable 更新表 修改表
CreateTable 创建表 创建数据目录
PollAskResult 轮训AskLuma执行结果 轮询自然语言查询结果
QueryAskLumaLog 查询智能体查询调用日志 查询自然语言查询历史日志
AskLuma 智能体语义查询 自然语言查询
QueryEventHouse 查询事件仓 查询事件仓数据