Query event traces using QueryEventTraces - EventBridge - Alibaba Cloud - EventBridge

Queries the trace details of an event, including delivery, filtering, and push records.

Operation description

Queries the trace of a specific event to check its delivery, filtering, and push status.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eventbridge:QueryEventTraces

get

*EventBus

acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#EventBusName}

None

Request parameters

Parameter	Type	Required	Description	Example
EventBusName	string	Yes	The name of the event bus.	MyEventBus
EventId	string	Yes	The event ID.	1935debf-ddac-49dc-a090-d4f2857a046d

Response elements

Element	Type	Description	Example
	object
Message	string	The error message returned if the request failed.	EventBusNotExist
RequestId	string	The request ID.	BB934571-1F5A-5E17-91DD-E2BC3E1BFBFF
Data	array<object>	The name of the event source.
	object
Action	string	The event trace type. Valid values: PutEvent (the event was delivered to the bus), FilterEvent (the event was matched against a rule), and PushEvent (the event was pushed to a target).	PutEvent
ReceivedTime	integer	The time when the event was delivered to the event bus. Returned only when Action is PutEvent.	1659495343896
RuleMatchingTime	string	The time when the event matched the rule. Returned only when Action is FilterEvent.	1659495343896
ActionTime	integer	The execution time of the event trace.	1659495343896
NotifyStatus	string	The delivery status.	[200]Ok
RuleName	string	The name of the event rule.	ramrolechange-mns
EventId	string	The event ID.	a5747e4f-2af2-40b6-b262-d0140e995bf7
EventBusName	string	The name of the event bus.	demo
Endpoint	string	The endpoint of the event target. Returned only when Action is PushEvent.	acs:mns:cn-zhangjiakou:123456789098****:queues/testQueue
NotifyLatency	string	The delivery latency from the event bus to the target. Returned only when Action is PushEvent.	80
NotifyTime	integer	The time when the event was delivered to the target. Returned only when Action is PushEvent.	1659495343896
EventSource	string	The name of the event source.	cert-api
Code	string	The response code. Valid values: 200: The request was successful. Other codes: The request failed. For more information, see Error codes.	200
Success	boolean	Indicates whether the request was successful. Valid values: true and false.	true

Examples

Success response

JSON format

{
  "Message": "EventBusNotExist",
  "RequestId": "BB934571-1F5A-5E17-91DD-E2BC3E1BFBFF",
  "Data": [
    {
      "Action": "PutEvent",
      "ReceivedTime": 1659495343896,
      "RuleMatchingTime": "1659495343896",
      "ActionTime": 1659495343896,
      "NotifyStatus": "[200]Ok",
      "RuleName": "ramrolechange-mns",
      "EventId": "a5747e4f-2af2-40b6-b262-d0140e995bf7",
      "EventBusName": "demo",
      "Endpoint": "acs:mns:cn-zhangjiakou:123456789098****:queues/testQueue",
      "NotifyLatency": "80",
      "NotifyTime": 1659495343896,
      "EventSource": "cert-api"
    }
  ],
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
403	ServiceNotEnable	Service not enable

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.