All Products
Search
Document Center

Tair (Redis® OSS-Compatible):DescribeHistoryTasksStat

Last Updated:Mar 18, 2026

Queries the task statistics in the task center.

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:DescribeHistoryTasksStatget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the pending event. You can call the DescribeRegions operation to query the most recent region list.

cn-beijing
StatusstringNo

The task status. Valid values:

  • Scheduled
  • Running
  • Succeed
  • Failed
  • Cancelling
  • Canceled
  • Waiting
Note This parameter is empty by default, which indicates that tasks in all states are queried. Separate multiple states with commas (,).
Scheduled
InstanceIdstringNo

The instance ID.

r-bp1zxszhcgatnx****
TaskIdstringNo

The task IDs. You can specify this parameter to query specific tasks. This parameter is empty by default, which indicates that all tasks are queried. Separate multiple task IDs with commas (,). You can specify up to 30 task IDs.

t-0mq1yyhm3ffl2bxxxx
TaskTypestringNo

The type of the task.

all
FromStartTimestringYes

The beginning of the time range to query. The time must be in UTC and formatted as yyyy-MM-ddthh:mmZ.

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

The end of the time range to query. The time must be in UTC and formatted as yyyy-MM-ddthh:mmZ.

2022-02-02T11:31:03Z
FromExecTimeintegerNo

The minimum execution duration of a task. This parameter is used to filter tasks whose execution duration is longer than the minimum execution duration. Unit: seconds. Default value: 0. This value indicates that the minimum execution duration is unlimited.

0
ToExecTimeintegerNo

Maximum task execution time. This parameter is used to filter tasks whose execution duration is shorter than or equal to the maximum execution duration. Unit: seconds. Default value: 0. This value indicates that the minimum execution duration is unlimited.

0

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

ABAF95F6-35C1-4177-AF3A-70969EBD****
Itemsarray<object>

The task list.

Itemsobject

The tasks.

Statusstring

The task state.

  • Scheduled
  • Running
  • Succeed
  • Failed
  • Cancelling
  • Canceled
  • Waiting
Scheduled
TotalCountinteger

The total number of tasks.

10

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400Param.InvalidParam invalid
400Param.Invalid.TimeEndBeforeStartParam invalid. End time before start time

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

Change history

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