All Products
Search
Document Center

EventBridge:QueryTracedEvents

Last Updated:Dec 04, 2024

Queries event traces by time range.

Operation description

You can call this API operation to query event traces by time range.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
eventbridge:QueryTracedEventsget
*EventBus
acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#EventBusName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EventBusNamestringYes

The name of the event bus.

MyEventBus
StartTimelongYes

The beginning of the time range to query event traces. Unit: milliseconds.

1661773509000
EndTimelongYes

The end of the time range when event traces are queried. Unit: milliseconds.

1661773509000
LimitintegerNo

The maximum number of entries to return in a request. You can use this parameter and NextToken to implement paging.

Note A maximum of 100 entries can be returned in a request.
50
NextTokenstringNo

If you configure Limit and excess return values exist, this parameter is returned.

1000
EventSourcestringNo

The name of the event source.

mse
EventTypestringNo

The event type.

eventbridge:Events:HTTPEvent
MatchedRulestringNo

The name of the event rule that is matched.

test-mnsrule

Response parameters

ParameterTypeDescriptionExample
object
Messagestring

The returned error message.

EventBusNotExist
RequestIdstring

The request ID.

d9e4628b-8b34-4f33-82be-5aac50aac0ba
Dataobject

The returned data.

NextTokenstring

If excess return values exist, this parameter is returned.

1000
Eventsarray<object>

The events.

Eventsobject
EventIdstring

The event ID.

07E-1OCckaVzNB92BIFFh4xgydOF1wd
EventBusNamestring

The name of the event bus.

test-custom-bus
EventReceivedTimelong

The time when the event was delivered to the event bus.

1661773573100
EventSourcestring

The name of the event source.

acs.resourcemanager
EventTypestring

The event type.

eventbridge:Events:HTTPEvent
Totalinteger

The total number of entries.

6
Codestring

The response code. Valid values:

  • Success: The request was successful.
  • Other codes: The request failed. For information about error codes, see Error codes.
200
Successboolean

Indicates whether the operation was successful. If the operation was successful, the value true is returned.

true

Examples

Sample success responses

JSONformat

{
  "Message": "EventBusNotExist",
  "RequestId": "d9e4628b-8b34-4f33-82be-5aac50aac0ba",
  "Data": {
    "NextToken": "1000",
    "Events": [
      {
        "EventId": "07E-1OCckaVzNB92BIFFh4xgydOF1wd",
        "EventBusName": "test-custom-bus",
        "EventReceivedTime": 1661773573100,
        "EventSource": "acs.resourcemanager",
        "EventType": "eventbridge:Events:HTTPEvent"
      }
    ],
    "Total": 6
  },
  "Code": "200",
  "Success": true
}

Error codes

HTTP status codeError codeError message
403ServiceNotEnableService not enable

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history