Queries events from the event center.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| BusName |
string |
No |
The name of the event bus. |
default |
| NextToken |
string |
No |
The token that is used to retrieve the next page of results. |
100 |
| MaxResults |
integer |
No |
The maximum number of results to return. Valid values: 0 to 10,000. The default value is 100. |
100 |
| Body |
object |
Yes |
The request body. |
|
| SchemaId |
string |
Yes |
The schema ID. |
ecs:GeneralSchema |
| QueryType |
string |
Yes |
The query type. Valid values:
|
timeseries_and_table |
| Parameters |
object |
Yes |
The query parameters. |
|
| Breakdowns |
array |
No |
Splits the dataset by a specific dimension. The dimension is specified by a column name. |
|
|
string |
No |
The name of the column that can be used as the dimension for splitting. |
source |
|
| Calculations |
array<object> |
No |
Performs a calculation on a specified column using an operator. |
|
|
object |
No |
|||
| Op |
string |
No |
The operator. |
COUNT_DISTINCT |
| Column |
string |
No |
The column name. |
source |
| Filters |
array<object> |
No |
A list of filter conditions. |
|
|
array<object> |
No |
|||
| Column |
string |
No |
The column name. |
source |
| Op |
string |
No |
The operator. |
= |
| Values |
array |
No |
The values to use with the operator. |
|
|
string |
No |
If the value is a string, enclose it in single quotation marks ('). |
'acs.ecs' |
|
| NestedFilterCombination |
string |
No |
AND |
|
| NestedFilters |
array<object> |
No |
||
|
object |
No |
|||
| Column |
string |
No |
||
| Op |
string |
No |
||
| Values |
array |
No |
||
|
string |
No |
|||
| FilterCombination |
string |
No |
The logical operator for combining filter conditions. |
AND |
| Granularity |
integer |
No |
The time granularity, which is the minimum time unit for querying time series data. Unit: seconds. The minimum value is 1. This parameter specifies a suggested value. The actual granularity is subject to the returned value. |
30 |
| Orders |
array<object> |
No |
The sorting method for the query results. This parameter is valid only when QueryType is set to table. |
|
|
object |
No |
|||
| Op |
string |
No |
The operator. |
AVG |
| Column |
string |
No |
The column name. |
source |
| Desc |
boolean |
No |
Specifies whether to sort the results in descending order. |
true |
| Offset |
integer |
No |
The starting position of the query. The count starts from 0. |
0 |
| Limit |
integer |
No |
The maximum number of events to query. Valid values: 1 to 10,000. |
100 |
| TimeRange |
integer |
No |
The time range. Unit: milliseconds. The minimum value is 1,000. |
1000000 |
| StartTime |
integer |
No |
The start timestamp for the event query. Unit: milliseconds. |
1687860901814 |
| EndTime |
integer |
No |
The end timestamp for the event query. Unit: milliseconds. |
1687861201814 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response schema. |
||
| Message |
string |
The error message. |
Specified parameter Limit is not valid. |
| RequestId |
string |
The request ID. |
5DAF96FB-A4B6-548C-B999-XXXXXXXX |
| Data |
object |
The returned data. |
|
| NextToken |
string |
The token that is used to retrieve the next page of results. If this parameter is empty, all results have been returned. |
100 |
| MaxResults |
integer |
The maximum number of entries returned for the current request. |
100 |
| TotalCount |
integer |
The total number of entries that meet the filter conditions. This parameter is optional and is not returned by default. |
76 |
| TimeSeries |
array<object> |
The query results for the timeseries query type. |
|
|
array<object> |
|||
| RowData |
object |
An entry of the query result, which is represented as a key-value pair. |
{ "id":"xxx", "source":"acs.ecs" } |
| Time |
string |
The timestamp. |
1683561600000 |
| Table |
array<object> |
The query results for the table query type. |
|
|
array<object> |
|||
| RowData |
object |
An entry of the query result, which is represented as a key-value pair. |
{ "id":"xxx", "source":"acs.ecs" } |
| Code |
string |
The status of the call. A value of `Success` indicates that the call is successful. |
Success |
| Success |
boolean |
Indicates whether the call was successful. A value of true indicates that the call was successful. A value of false indicates that the call failed. |
true |
Examples
Success response
JSON format
{
"Message": "Specified parameter Limit is not valid.",
"RequestId": "5DAF96FB-A4B6-548C-B999-XXXXXXXX",
"Data": {
"NextToken": "100",
"MaxResults": 100,
"TotalCount": 76,
"TimeSeries": [
{
"RowData": {
"id": "xxx",
"source": "acs.ecs"
},
"Time": "1683561600000"
}
],
"Table": [
{
"RowData": {
"id": "xxx",
"source": "acs.ecs"
}
}
]
},
"Code": "Success",
"Success": true
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.