QueryTracedEvents

更新时间:
复制 MD 格式

This operation queries event trace data within a time range.

Operation description

Queries for event traces within a specified time range.

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:QueryTracedEvents

get

*EventBus

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

None None

Request parameters

Parameter

Type

Required

Description

Example

EventBusName

string

Yes

The name of the event bus.

MyEventBus

StartTime

integer

Yes

The beginning of the time range for the query, specified as a UNIX timestamp in milliseconds.

1661773509000

EndTime

integer

Yes

The end of the time range for the query, specified as a UNIX timestamp in milliseconds.

1661773509000

Limit

integer

No

The maximum number of entries to return per page. Use this parameter with NextToken to paginate the results.

Important The maximum value is 100.

50

NextToken

string

No

The token for retrieving the next page of results. It is returned in the response to a previous request if more results are available.

1000

EventSource

string

No

The name of the event source.

mse

Subject

string

No

The event subject.

EventType

string

No

The event type.

eventbridge:Events:HTTPEvent

MatchedRule

string

No

The name of the matched rule.

test-mnsrule

Response elements

Element

Type

Description

Example

object

Message

string

The error message.

EventBusNotExist

RequestId

string

The request ID generated by Alibaba Cloud.

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

Data

object

The response data.

NextToken

string

The token to retrieve the next page of results. This parameter is returned only if more results are available.

1000

Events

array<object>

An array of event objects.

object

Details for a single event.

EventId

string

The event ID.

07E-1OCckaVzNB92BIFFh4xgydOF1wd

EventBusName

string

The name of the event bus.

test-custom-bus

EventReceivedTime

integer

The UNIX timestamp (in milliseconds) when the event was delivered to the event bus.

1661773573100

EventSource

string

The name of the event source.

acs.resourcemanager

EventType

string

The event type.

eventbridge:Events:HTTPEvent

Total

integer

The total number of entries.

6

Code

string

The response code.

  • Success: The request succeeded.

  • Other values indicate an error. For more information, see error codes.

200

Success

boolean

true indicates that the request succeeded.

true

Examples

Success response

JSON format

{
  "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 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.