All Products
Search
Document Center

EventBridge:QueryEvent

Last Updated:Dec 04, 2024

Queries the content of an event.

Operation description

You can call this API operation to query the content of an event.

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:QueryEventget
*EventBus
acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#EventBusName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EventBusNamestringYes

The name of the event bus.

demo
EventIdstringYes

The event ID.

1935debf-ddac-49dc-a090-d4f2857a046d
EventSourcestringNo

The name of the event source.

  • This parameter is required if you query the system event bus.
testEventSourceName

Response parameters

ParameterTypeDescriptionExample
object
Messagestring

The error message that is returned if the request failed.

EventBusNotExist
RequestIdstring

The request ID.

580A938B-6107-586C-8EC7-F22EEBEDA9E6
Dataobject

The content of the event.

Codestring

The status code returned. The status code 200 indicates that the request was successful.

200
Successboolean

Indicates whether the request is successful. Valid values: true and false.

true

HTTP/1.1 200 OK Server: AliyunEventBridge Connection: keep-alive Content-Type: application/json;charset=utf-8 Content-Length: 279 x-eventbridge-request-id: 5E9A9081333245F1D800**** Date: Sat, 18 Apr 2020 08:30:42 GMT

{ "EventBusName": "simpleBus", "EventMap": { "a5074581-7e74-4e4c-868f-47e7afdf****": "{"id":"a5074581-7e74-4e4c-868f-47e7afdf****","source":"testSource","specversion":"1.0","type":"eventbridge:Events:HTTPEvent","datacontenttype":"application/json","subject":"acs:eventbridge:cn-zhangjiakou:123456789098****:eventbus/testBus/eventsource/testSource","time":"2020-04-18T08:30:41.006+08:00","aliyunaccountid":"123456789098****","aliyunpublishtime":"2020-04-18T08:30:13.061Z","aliyunoriginalaccountid":"123456789098****","aliyuneventbusname":"simpleBus","aliyunregionid":"cn-hangzhou","aliyunpublishaddr":"10.120..","data":{"content":"test"}" } }

Examples

Sample success responses

JSONformat

{
  "Message": "EventBusNotExist",
  "RequestId": "580A938B-6107-586C-8EC7-F22EEBEDA9E6",
  "Data": {
    "test": "test",
    "test2": 1
  },
  "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
2023-11-07The Error code has changed. The request parameters of the API has changedView Change Details