All Products
Search
Document Center

Tair (Redis® OSS-Compatible):DescribeHistoryEventsStat

Last Updated:Jan 28, 2026

Queries the statistics of historical events.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
kvstore:DescribeHistoryEventsStatget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-beijing
ArchiveStatusstringYes

The status of the events that you want to query. Valid values:

  • Archived
  • UnArchived
  • All
Archived
FromStartTimestringNo

The beginning of the time range to query. Only tasks that have a start time later than or equal to the time specified by this parameter are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The start time can be up to 30 days earlier than the current time. If you set this parameter to a time more than 30 days earlier than the current time, this time is automatically converted to a time that is exactly 30 days earlier than the current time.

2022-01-02T11:31:03Z
ToStartTimestringYes

The end of the time range to query. Only tasks that have a start time earlier than or equal to the time specified by this parameter are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

2022-02-02T11:31:03Z

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

B32A350C-3A8E-5FF1-A56F-51C3769D****
Itemsarray<object>

The queried events.

Itemsobject

The details of events.

EventCategorystring

The system event category. Valid values:

  • Exception: abnormal events
  • Optimize: optimization events.
  • Notification: notification events.
  • Maintenance: scheduled maintenance events.
Exception
TotalCountinteger

The total number of returned events.

21

Examples

Sample success responses

JSONformat

{
  "RequestId": "B32A350C-3A8E-5FF1-A56F-51C3769D****",
  "Items": [
    {
      "EventCategory": "Exception",
      "TotalCount": 21
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2025-11-13Add OperationView Change Details