Help Center/ EventGrid/ API Reference/ APIs/ Event Management/ Obtaining the Event Trace List

Updated on 2025-05-06 GMT+08:00

Online Debugging

CLI Examples

View PDF

Obtaining the Event Trace List

Function

This API is used to obtain the event trace list.

URI

GET /v1/{project_id}/traced-events

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant resource space ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
start_time	Yes	Long	Start time for querying data.
end_time	Yes	Long	End time for querying data.
event_id	No	String	Event ID for query.
source_name	No	String	Event source name.
event_type	No	String	Event type for exact match.
subscription_name	No	String	Event subscription name.
limit	No	String	Number of items displayed on each page. The value cannot be less than 0.
offset	No	Integer	Offset, which is the position where the query starts. The value must be greater than or equal to 0.
channel_id	Yes	String	Channel ID.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-Request-Id	String	This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

**Table 5** Response body parameters
Parameter	Type	Description
total	Integer	Total number.
size	Integer	Number of records displayed on the current page.
result	Array of result objects	Event trace list.

**Table 6** result
Parameter	Type	Description
subscription_name	String	Event subscription name.
source_name	String	Event source name.
source_provider	String	Event source provider.
event_type	String	Event type.
event_id	String	Event ID.
event_received_time	Integer	Event receiving time.

Example Requests

Obtain the event trace list.

GET https://{endpoint}/v1/{project_id}/traced-events

Example Responses

Status code: 200

Information

{
  "total" : 1,
  "size" : 1,
  "result" : [ {
    "subscription_name" : "subscription-xxxx",
    "source_name" : "HC.SMN",
    "source_provider" : "OFFICIAL",
    "event_type" : "SMN:CloudTrace:ConsoleAction",
    "event_id" : "ace774cb-d3f1-49c1-9d8b-9efd086ac9e00533366",
    "event_received_time" : 1677651126823
  } ]
}