调用DescribeHistoryEvents查询历史事件-云数据库 Tair（兼容 Redis®）-阿里云

查询事件中心中的历史事件

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
kvstore:DescribeHistoryEvents	create	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	实例所属的地域 ID，可调用 DescribeRegions 接口获取。	cn-beijing
PageSize	integer	否	每页返回的记录数，默认值为 10。	10
PageNumber	integer	否	页码，取值大于 0 且不超过 integer 的最大值，默认值为 1。	1
ArchiveStatus	string	否	事件状态。取值说明： Archived：已归档 UnArchived：未归档 All：所有	Archived
EventCategory	string	否	系统事件分类。取值说明： Exception：异常事件 Optimize：优化事件 Notification：通知事件 Maintenance：计划内运维事件	Exception
EventType	string	否	系统事件的类型。EventType 参数只在未指定 InstanceEventType.N 参数时有效。取值范围： SystemMaintenance.Reboot：因系统维护实例重启。 SystemMaintenance.Redeploy：因系统维护实例重新部署。 SystemFailure.Reboot：因系统错误实例重启。 SystemFailure.Redeploy：因系统错误实例重新部署。 SystemFailure.Delete：因实例创建失败实例释放。 InstanceFailure.Reboot：因实例错误实例重启。 InstanceExpiration.Stop：因包年包月期限到期，实例停止。 InstanceExpiration.Delete：因包年包月期限到期，实例释放。 AccountUnbalanced.Stop：因账号欠费，按量付费实例停止。 AccountUnbalanced.Delete：因账号欠费，按量付费实例释放。说明事件类型说明请参见系统事件概述。该参数的取值只能是实例系统事件，不能是磁盘系统事件。	SystemFailure.Reboot
EventLevel	string	否	事件级别，取值说明： INFO：通知 WARN：警告 CRITICAL：紧急	INFO
EventStatus	string	否	事件状态，取值说明： Inquiring：问询中 Scheduled：计划中 Running：执行中 Succeed：执行完成 Failed：执行失败 Canceled：已取消说明如需查询多个状态，使用英文逗号分隔。	Scheduled
ResourceType	string	否	资源类型，取值说明： Instance：实例资源 Host：主机资源 User：用户资源说明该参数不填写，表示查询所有类型。	Instance
InstanceId	string	否	实例 ID。	r-bp1zxszhcgatnx****
EventId	string	否	事件 ID。	5345398
TaskId	string	否	任务 ID。	578678678
FromStartTime	string	否	查询任务的最早开始时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。	2022-01-02T11:31:03Z
ToStartTime	string	否	查询任务的最晚开始时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间），需晚于任务的最早开始时间。	2022-02-02T11:31:03Z
ResourceGroupId	string	否	资源组 ID。	rg-acfnuslkubs****

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	页码。	1
RequestId	string	请求 ID。	27B911BF-4E17-5F8A-A932-79DF2D3F****
PageSize	integer	每页记录数。	20
TotalCount	integer	总记录数。	430
Items	array<object>	事件列表。
Items	object	事件列表。
Id	string	任务 ID。	4309
Region	string	地域。	cn-hanghzou
Source	string	事件来源。	loanBill
Specversion	string	数据库版本。	8.0
Subject	string	待处理事件的名称。	Qitian
Time	string	查询任务已运行时间。单位：秒。	1734919325126
Type	string	事件类型。	host
Data	object	数据概览。
EventType	string	系统事件类型，取值说明： SystemMaintenance.Reboot：因系统维护实例重启 SystemMaintenance.Redeploy：因系统维护实例重新部署 SystemFailure.Reboot：因系统错误实例重启 SystemFailure.Redeploy：因系统错误实例重新部署 SystemFailure.Delete：因实例创建失败实例释放 InstanceFailure.Reboot：因实例错误实例重启 InstanceExpiration.Stop：因包年包月期限到期，实例停止 InstanceExpiration.Delete：因包年包月期限到期，实例释放 AccountUnbalanced.Stop：因账号欠费，按量付费实例停止 AccountUnbalanced.Delete：因账号欠费，按量付费实例释放	StatusNotification
EventId	string	事件 ID。	669036
CmsProduct	string	应用分组的云服务类型，取值说明： web：web 应用。 native：本地应用。	web
DbType	string	数据库类型	redis
DetailImpact	string	翻页参数。	1
DetailReason	string	实例操作详情。	xxxx
EndTime	string	告警结束时间。	2023-03-06T11:46:01Z
EventCategory	string	系统事件分类。取值说明： Exception：异常事件 Optimize：优化事件 Notification：通知事件 Maintenance：计划内运维事件	Exception
EventCode	string	事件编码。	ENT000014
EventDetail	string	事件详情。	xxxxx
EventImpact	string	事件影响概况。	xxxxx
EventLevel	string	事件级别，取值说明： INFO：通知 WARN：警告 CRITICAL：紧急	INFO
EventReason	string	事件操作的来源。	xxxxx
EventStatus	string	事件状态，取值说明： Inquiring：问询中 Scheduled：计划中 Running：执行中 Succeed：执行完成 Failed：执行失败 Canceled：已取消	Succeed
GmtCreated	string	事件的创建时间。	2024-12-13 05:34:23
GmtModified	string	事件的更新时间。	2025-03-05 10:41:59
HandleStatus	string	处理状态。	done
HasLifeCycle	integer	是否有生命周期。	false
InstanceId	string	实例 ID。	r-bp15kjsoovqjam****
InstanceName	string	实例名称。	normandy
IsClosed	integer	是否关闭成功，取值说明： 0：关闭 1：开启	0
Product	string	产品名称。	kvstore
RegionId	string	地域 ID。	cn-hangzhou
ResourceType	string	资源类型，取值说明： Instance：实例资源 Host：主机资源 User：用户资源	Instance
SourceType	string	源数据的类型。	MSE
StartTime	string	开始时间。	2025-09-30T21:13Z
Uid	string	资源所属的用户 ID。	15532817595*****

示例

正常返回示例

JSON格式

{
  "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*****"
      }
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2025-11-13	新增 OpenAPI	查看变更详情