DescribeHistoryEvents - Tair (Redis® OSS-Compatible) - Alibaba Cloud Documentation Center

DescribeHistoryEvents

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:DescribeHistoryEvents	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.	cn-beijing
PageSize	integer	No	The number of records to return on each page. Default value: 10.	10
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
ArchiveStatus	string	No	The status of the event. Valid values: Archived UnArchived All	Archived
EventCategory	string	No	The system event category. Valid values: Exception: abnormal events. Optimize: optimization events. Notification: Notification events. Maintenance: scheduled maintenance events.	Exception
EventType	string	No	The system event type. This parameter takes effect only when InstanceEventType.N is not specified. Valid values: SystemMaintenance.Reboot: The instance is restarted due to system maintenance. SystemMaintenance.Redeploy: The instance is redeployed due to system maintenance. SystemFailure.Reboot: The instance is restarted due to a system error. SystemFailure.Redeploy: The instance is redeployed due to a system error. SystemFailure.Delete: The instance is released due to an instance creation failure. InstanceFailure.Reboot: The instance is restarted due to an instance error. InstanceExpiration.Stop: The subscription instance is stopped due to expiration. InstanceExpiration.Delete: The subscription instance is released due to expiration. AccountUnbalanced.Stop: The pay-as-you-go instance is stopped due to an overdue payment. AccountUnbalanced.Delete: The pay-as-you-go instance is released due to an overdue payment. Note For more information about event types, see Overview of system events. The values of this parameter are applicable only to instance system events, but not to disk system events.	SystemFailure.Reboot
EventLevel	string	No	The level of the event. Valid values: INFO WARN CRITICAL	INFO
EventStatus	string	No	The status of the event. Valid values: Inquiring Scheduled: Planned Running Succeed Failed Canceled Note Separate multiple states with commas (,).	Scheduled
ResourceType	string	No	The type of the resource. Valid values: Instance: instance resources. Host: host resources. User: user resources Note If you do not specify this parameter, events of all resource types are queried.	Instance
InstanceId	string	No	The instance ID.	r-bp1zxszhcgatnx****
EventId	string	No	The event ID.	5345398
TaskId	string	No	The task IDs.	578678678
FromStartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2022-01-02T11:31:03Z
ToStartTime	string	No	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Only events that have a start time earlier than or equal to the time specified by this parameter are queried.	2022-02-02T11:31:03Z
ResourceGroupId	string	No	The resource group ID.	rg-acfnuslkubs****

Response parameters

Parameter	Type	Description	Example
	object
PageNumber	integer	The page number.	1
RequestId	string	The request ID.	27B911BF-4E17-5F8A-A932-79DF2D3F****
PageSize	integer	The number of entries to return on each page.	20
TotalCount	integer	The total number of returned events.	430
Items	array<object>	A list of events.
Items	object	The queried event.
Id	string	The ID of the task.	4309
Region	string	The region ID.	cn-hanghzou
Source	string	The source of the event.	loanBill
Specversion	string	The database engine version.	8.0
Subject	string	The name of the pending event.	Qitian
Time	string	The amount of time that has elapsed from the start time of the query. Unit: seconds.	1734919325126
Type	string	The type of the event.	host
Data	object	The data returned.
EventType	string	The type of the system event. Valid values: SystemMaintenance.Reboot: The instance was restarted due to system maintenance. SystemMaintenance.Redeploy: The instance was redeployed due to system maintenance. SystemFailure.Reboot: The instance was restarted due to system failures. SystemFailure.Redeploy: The instance was redeployed due to system failures. SystemFailure.Delete: The instance was released due to an instance creation failure. InstanceFailure.Reboot: The instance was restarted due to an instance error. InstanceExpiration.Stop: The subscription instance was stopped due to expiration. InstanceExpiration.Delete: The subscription instance was released due to expiration. AccountUnbalanced.Stop: The pay-as-you-go instance is stopped due to an overdue payment. AccountUnbalanced.Delete: The pay-as-you-go instance was released due to an overdue payment.	StatusNotification
EventId	string	The ID of the event.	669036
CmsProduct	string	The cloud service type of the application group. Valid values: web: web application. native: local application.	web
DbType	string	The database type.	redis
DetailImpact	string	The pagination parameter.	1
DetailReason	string	The details of the instance operation.	xxxx
EndTime	string	The time when the alert was closed.	2023-03-06T11:46:01Z
EventCategory	string	The system event category. Valid values: Exception: abnormal events Optimize: optimization events. Notification: notification events. Maintenance: scheduled maintenance events.	Exception
EventCode	string	The event code.	ENT000014
EventDetail	string	The event details.	xxxxx
EventImpact	string	The event impact.	xxxxx
EventLevel	string	The level of the event. Valid values: INFO WARN CRITICAL	INFO
EventReason	string	The event source.	xxxxx
EventStatus	string	The status of the event. Valid values: Inquiring Scheduled Running Succeed Failed Canceled	Succeed
GmtCreated	string	The time when the event was created.	2024-12-13 05:34:23
GmtModified	string	The time when the event was updated.	2025-03-05 10:41:59
HandleStatus	string	The status of the event. Valid values:	done
HasLifeCycle	integer	Indicates whether the event has a lifecycle.	false
InstanceId	string	The ID of the instance.	r-bp15kjsoovqjam****
InstanceName	string	The instance name.	normandy
IsClosed	integer	Indicates whether the event is closed. Valid values: 0: closed. 1: not closed.	0
Product	string	The name of the product.	kvstore
RegionId	string	The region ID.	cn-hangzhou
ResourceType	string	The resource type of the instance. Valid values: Instance: instance resources. Host: host resources. User: user resources.	Instance
SourceType	string	The type of the source data.	MSE
StartTime	string	The start time of the event.	2025-09-30T21:13Z
Uid	string	The ID of the user to which the resources belong.	15532817595*****

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "27B911BF-4E17-5F8A-A932-79DF2D3F****",
  "PageSize": 20,
  "TotalCount": 430,
  "Items": [
    {
      "Id": 4309,
      "Region": "cn-hanghzou",
      "Source": "loanBill",
      "Specversion": 8,
      "Subject": "Qitian",
      "Time": 1734919325126,
      "Type": "host",
      "Data": {
        "EventType": "StatusNotification",
        "EventId": 669036,
        "CmsProduct": "web",
        "DbType": "redis",
        "DetailImpact": 1,
        "DetailReason": "xxxx",
        "EndTime": "2023-03-06T11:46:01Z\n",
        "EventCategory": "Exception",
        "EventCode": "ENT000014\n",
        "EventDetail": "xxxxx",
        "EventImpact": "xxxxx\n",
        "EventLevel": "INFO",
        "EventReason": "xxxxx",
        "EventStatus": "Succeed",
        "GmtCreated": "2024-12-13 05:34:23",
        "GmtModified": "2025-03-05 10:41:59",
        "HandleStatus": "done",
        "HasLifeCycle": 0,
        "InstanceId": "r-bp15kjsoovqjam****",
        "InstanceName": "normandy",
        "IsClosed": 0,
        "Product": "kvstore",
        "RegionId": "cn-hangzhou",
        "ResourceType": "Instance",
        "SourceType": "MSE",
        "StartTime": "2025-09-30T21:13Z",
        "Uid": "15532817595*****"
      }
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-11-13	Add Operation	View Change Details