API standards and multilingual preset SDKs
The OpenAPI of this product (eventbridge/2020-04-01) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Event bus
|
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. |
Event
|
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 source
|
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 target
|
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 rule
|
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. |
Event stream
|
API |
Title |
Description |
| ListEventStreamings | Query event streams | Queries 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 | Retrieve event stream details | Retrieves the details of an event stream. |
| UpdateEventStreaming | Modify an event stream | Modifies the basic information, event source information, event filtering pattern, or event target information of an event stream. |
| CreateEventStreaming | Create an event stream | Creates an event stream. |
API destination
|
API |
Title |
Description |
| UpdateApiDestination | UpdateApiDestination | Updates an API destination. |
| CreateApiDestination | CreateApiDestination | Creates an API destination. |
| CreateConnection | Create 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. |
Other
|
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 |
| DeleteNamespace | Delete Namespace | Delete Namespace |
| UpdateNamespace | Edit namespace | Modify namespace |
| DeleteTable | Delete table | Delete table |
| ListNamespaces | Query namespace list | Query namespace list |
| ListTables | List tables | Query table list |
| CreateAgent | Create a custom agent | Creates a custom agent. |
| UpdateAgent | Update a custom agent | Updates a custom agent. |
| GetTable | Query Table | Get Table |
| ListCatalogs | Query catalog list | Query data catalog list |
| CreateNamespace | Create Namespace | Create Namespace |
| GetNamespace | Query namespace | Get namespace |
| ListAgents | Retrieve custom agent list | Retrieves a list of custom agents. |
| GetAgent | Retrieve agent metadata | Retrieves agent metadata. |
| DeleteAgent | Delete a custom agent | Deletes a custom agent. |
| GetCatalog | Query catalog | Get data catalog |
| UpdateTable | Update table | Update table |
| CreateTable | Create a table | Create a data catalog |
| PollAskResult | Poll askLuma execution results | Polls for natural language query results. |
| QueryAskLumaLog | Query agent invocation logs | Queries the history logs of natural language queries. |
| AskLuma | Agent semantic query | Queries data using natural language. |
| QueryEventHouse | Query event store | Query event store data |