API overview

更新时间:
复制 MD 格式

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (eventbridge/2020-04-01) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.

Custom signature

If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).

Before you begin

An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.

Event buses

API

Title

Description

CreateEventBus CreateEventBus Creates an event bus.
DeleteEventBus DeleteEventBus Deletes an event bus.
UpdateEventBus UpdateEventBus Updates an event bus.
GetEventBus GetEventBus Queries the detailed information about an event bus.
ListEventBuses ListEventBuses Queries all event buses.

Events

API

Title

Description

QueryEvent QueryEvent Queries the content of an event.
QueryEventTraces QueryEventTraces Queries event traces.
QueryTracedEventByEventId QueryTracedEventByEventId Queries event traces by event ID.
QueryTracedEvents QueryTracedEvents This operation queries `event trace` data within a `time range`.

Event sources

API

Title

Description

ListAliyunOfficialEventSources ListAliyunOfficialEventSources Queries all Alibaba Cloud service event sources.
ListUserDefinedEventSources ListUserDefinedEventSources This operation queries all custom event sources.
CreateEventSource CreateEventSource Creates an external event source.
DeleteEventSource DeleteEventSource Deletes an event source.
UpdateEventSource UpdateEventSource Updates an event source.

Event targets

API

Title

Description

DeleteTargets DeleteTargets Deletes one or more event targets of an event rule.
PutTargets PutTargets Create or update event targets for the specified rule.

Event rules

API

Title

Description

CreateRule CreateRule Creates an event rule.
DeleteRule DeleteRule Deletes an event rule.
DisableRule DisableRule Disables an event rule.
EnableRule EnableRule Enables an event rule.
UpdateRule UpdateRule Updates the configurations of an event rule.
GetRule GetRule Retrieves the details of an event rule.
ListRules ListRules Queries all rules of an event bus.

EventStreamings

API

Title

Description

ListEventStreamings ListEventStreamings You can use this operation to retrieve a list of event streams.
DeleteEventStreaming DeleteEventStreaming Deletes an event stream.
PauseEventStreaming Pauses a running event stream Pauses a running event stream.
StartEventStreaming Enables a created or disabled event stream Enables a created or disabled event stream.
GetEventStreaming GetEventStreaming Retrieves the details of an event stream.
UpdateEventStreaming UpdateEventStreaming Updates the basic information, event source, event filtering pattern, or event target for an event stream.
CreateEventStreaming CreateEventStreaming Creates an event stream.

API destinations

API

Title

Description

UpdateApiDestination UpdateApiDestination Updates an API destination.
CreateApiDestination CreateApiDestination Creates an API destination.
CreateConnection Create a connection configuration Creates a connection configuration.
DeleteApiDestination DeleteApiDestination Deletes an API destination.
DeleteConnection DeleteConnection Deletes a connection.
GetApiDestination GetApiDestination Queries the information about an API destination.
GetConnection Queries the configuration information of a single connection. Queries the configuration information of a single connection.
ListApiDestinations ListApiDestinations Queries a list of API destinations.
ListConnections Queries the list of connection configurations. Queries the list of connection configurations.
UpdateConnection Update Connection Configuration Updates the connection configuration.

Others

API

Title

Description

CreateServiceLinkedRoleForProduct CreateServiceLinkedRoleForProduct Creates the service-linked role (SLR) that is associated with a specified product.
ListTargets ListTargets Queries all event targets of an event rule.
TestEventPattern TestEventPattern Tests if an event pattern matches a given event.
EventCenterQueryEvents EventCenterQueryEvents Queries events from the event center.
CheckServiceLinkedRoleForProduct CheckServiceLinkedRoleForProduct Checks whether a service-linked role is authorized for an account.
TestEventSourceConfig TestEventSourceConfig Checks whether the event source configuration is active.
DiscoverEventSource DiscoverEventSource Discovers the schema and simple data of an event source, such as MySQL.
UpdateEventStreamingBusinessOption UpdateEventStreamingBusinessOption Querying an event stream
AskLuma Agent Semantic Query Natural Language Query
CreateAgent Create a custom agent Retrieves historical sessions.
CreateNamespace Create Namespace Create Namespace
CreateTable Create a table Create a data catalog
DeleteAgent Delete a custom agent DeleteAgent
GetAgent Query the metadata of an agent Query historical sessions
GetCatalog Query catalog Get data catalog
GetTable Query Table Get Table
ListAgents List custom agents Queries historical sessions.
ListCatalogs Query catalog list Query data catalog list
ListNamespaces Query namespace list Query namespace list
PollAskResult Poll AskLuma Execution Result Poll natural language query results
QueryAskLumaLog Query agent query invocation logs Query natural language query history logs
QueryEventHouse Query event store. Query event store data.
UpdateAgent Update Custom Agent Query historical sessions.
UpdateNamespace Edit namespace Modify namespace