Query Historical Task Statistics with DescribeHistoryTasksStat - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Queries task statistics from the task center.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:DescribeHistoryTasksStat

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the pending event. You can call the DescribeRegions operation to query the most recent region list.	cn-beijing
Status	string	No	The task status. Valid values: Scheduled Running Succeed Failed Cancelling Canceled Waiting Note Empty by default, which queries tasks in all states. Separate multiple states with commas (,).	Scheduled
InstanceId	string	No	The instance ID.	r-bp1zxszhcgatnx****
TaskId	string	No	The task IDs. Empty by default, which queries all tasks. Separate multiple IDs with commas (,). Maximum: 30.	t-0mq1yyhm3ffl2bxxxx
TaskType	string	No	The type of the task.	all
FromStartTime	string	Yes	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
ToStartTime	string	Yes	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
FromExecTime	integer	No	The minimum execution duration. Tasks whose execution duration exceeds this value are returned. Unit: seconds. Default value: 0, which indicates no minimum limit.	0
ToExecTime	integer	No	The maximum execution duration. Tasks whose execution duration is shorter than or equal to this value are returned. Unit: seconds. Default value: 0, which indicates no maximum limit.	0

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	ABAF95F6-35C1-4177-AF3A-70969EBD****
Items	array<object>	The task list.
	object	The tasks.
Status	string	The task state. Scheduled Running Succeed Failed Cancelling Canceled Waiting	Scheduled
TotalCount	integer	The total number of tasks.	10

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	Param.Invalid	Param invalid
400	Param.Invalid.TimeEndBeforeStart	Param invalid. End time before start time

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.