Help Center/ EventGrid/ API Reference/ APIs/ Event Management/ Viewing Event Trace Details

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

Online Debugging

CLI Examples

View PDF

Viewing Event Trace Details

Function

This API is used to view details about delivering an event from the source to the target.

URI

GET /v1/{project_id}/events/trace/detail/{trace_id}

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
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 body parameters
Parameter	Type	Description
eventId	String	Event ID.
eventSource	String	Event source.
eventType	String	Event type.
receiveTime	String	Receiving time.
channelId	String	Channel ID.
channelName	String	Channel name.
deliverList	Array of DeliverItem objects	List of delivered events.

**Table 5** DeliverItem
Parameter	Type	Description
subscriptionId	String	Subscription ID, which is globally unique.
subscriptionName	String	Subscription name.
successCounts	Integer	The number of successful deliveries.
failCounts	Integer	The number of failed deliveries.
allDeliverTimes	Integer	Total number of deliveries.
deliverTargetList	Array of DeliverTarget objects	Delivery details.

**Table 6** DeliverTarget
Parameter	Type	Description
deliverTargetId	String	Delivery target ID, that is, the event target ID.
deliverTargetName	String	Delivery target name, that is, the event target name.
deliverStatus	String	Delivery status. Options: SUCCESS or FAILED.
deliverDetailList	Array of DeliverDetail objects	Number of records to be displayed. For example, only the latest three records are displayed.

**Table 7** DeliverDetail
Parameter	Type	Description
deliverTime	String	Delivery time. Format: yyyy/mm/dd xx:yy:zz
deliverStatus	String	Delivery status. Options: SUCCESS or FAILED.
deliverConsuming	String	Time spent in the delivery. Unit: ms.
deliverRspCode	String	Delivery response code.

Example Requests

View event trace details.

GET https://{endpoint}/v1/{project_id}/events/trace/detail/{trace_id}

Example Responses

Status code: 200

Event trace response body.

{
  "eventId" : "21637dd2-c4af-46e9-a4ba-f21b71deaa82",
  "eventSource" : null,
  "eventType" : null,
  "receiveTime" : 0,
  "channelId" : "65688f41-81d4-479f-bd8f-9727e7595128",
  "channelName" : "default",
  "deliverList" : [ {
    "subscriptionId" : "83799a5c-4e3e-49e5-b2cf-a5aa38758ee0",
    "subscriptionName" : "subscription-03us",
    "successCounts" : 0,
    "failCounts" : 1,
    "allDeliverTimes" : 7,
    "deliverTargetList" : [ {
      "deliverTargetId" : "2ae78b38-46c5-4f64-a1d3-0fc6b0b9324e",
      "deliverTargetName" : "HC.FunctionGraph",
      "deliverStatus" : "fail",
      "deliverDetailList" : [ {
        "deliverTime" : "2023-03-17 18:37:38",
        "deliverStatus" : "FAILED",
        "deliverConsuming" : 1679049458706,
        "deliverRspCode" : ""
      }, {
        "deliverTime" : "2023-03-17 18:37:38",
        "deliverStatus" : "FAILED",
        "deliverConsuming" : 0,
        "deliverRspCode" : ""
      }, {
        "deliverTime" : "2023-03-17 18:37:38",
        "deliverStatus" : "FAILED",
        "deliverConsuming" : 0,
        "deliverRspCode" : ""
      }, {
        "deliverTime" : "2023-03-17 18:37:38",
        "deliverStatus" : "FAILED",
        "deliverConsuming" : 0,
        "deliverRspCode" : ""
      }, {
        "deliverTime" : "2023-03-17 18:37:38",
        "deliverStatus" : "FAILED",
        "deliverConsuming" : 0,
        "deliverRspCode" : ""
      }, {
        "deliverTime" : "2023-03-17 18:37:38",
        "deliverStatus" : "FAILED",
        "deliverConsuming" : 0,
        "deliverRspCode" : ""
      }, {
        "deliverTime" : "2023-03-17 18:37:38",
        "deliverStatus" : "FAILED",
        "deliverConsuming" : 0,
        "deliverRspCode" : ""
      } ]
    } ]
  } ]
}