调用DescribeHistoryTasksStat查询历史任务统计-云数据库 Tair（兼容 Redis®）-阿里云

查询任务中心的任务统计。

调试

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

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

名称	类型	必填	描述	示例值
RegionId	string	是	待处理事件所属的地域 ID，您可以通过调用 DescribeRegions 接口进行查询。	cn-beijing
Status	string	否	任务状态，用于选择对应状态的任务： Scheduled：等待执行 Running：执行中 Succeed：执行成功 Failed：执行失败 Cancelling：正在终止 Canceled：已终止 Waiting：等待预设时间说明默认为空，表示全选，如需选择多个状态请用英文逗号（,）分隔。	Scheduled
InstanceId	string	否	实例 ID。	r-bp1zxszhcgatnx****
TaskId	string	否	任务 ID，用于查询已知 ID 的任务。默认为空，表示不限制。如需查询多个请用英文逗号（,）分隔，最多支持 30 个。	t-0mq1yyhm3ffl2bxxxx
TaskType	string	否	任务类型。	all
FromStartTime	string	是	查询开始时间，格式为yyyy-mm-ddthh:mmz（utc 时间）。	2022-01-02T11:31:03Z
ToStartTime	string	是	查询结束时间，格式为yyyy-mm-ddthh:mmz（utc 时间）。	2022-02-02T11:31:03Z
FromExecTime	integer	否	任务执行耗时的最小值。用于筛选任务执行耗时大于此时间的任务，单位秒。默认 0，表示不限制。	0
ToExecTime	integer	否	任务执行耗时的最大值。用于筛选任务执行耗时不小于此时间的任务，单位秒。默认 0，表示不限制。	0

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	ABAF95F6-35C1-4177-AF3A-70969EBD****
Items	array<object>	任务列表。
Items	object	任务信息列表。
Status	string	任务状态。 Scheduled：等待执行 Running：执行中 Succeed：执行成功 Failed：执行失败 Cancelling：正在终止 Canceled：已终止 Waiting：等待预设时间	Scheduled
TotalCount	integer	任务总数量。	10

正常返回示例

JSON格式

{
  "RequestId": "ABAF95F6-35C1-4177-AF3A-70969EBD****",
  "Items": [
    {
      "Status": "Scheduled",
      "TotalCount": 10
    }
  ]
}

HTTP status code	错误码	错误信息
400	Param.Invalid	Param invalid
400	Param.Invalid.TimeEndBeforeStart	Param invalid. End time before start time

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

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