Reschedule Tair Task Execution Time via ModifyTaskInfo - Tair - Alibaba Cloud - Tair (Redis® OSS-Compatible)

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:ModifyTaskInfo

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the instance is deployed.	cn-hangzhou
TaskId	string	Yes	The task ID. Separate multiple task IDs with commas (,). You can specify up to 30 task IDs.	t-0mq3kfhn8i1nlt****
StepName	string	No	The name of the current step.	do_pause
TaskAction	string	No	The action name. Set the value to modifySwitchTime to change the switching time or restoration time.	modifySwitchTime
ActionParams	string	No	The JSON-formatted parameters related to the action. Set this parameter to `{"recoverMode": "xxx", "recoverTime": "xxx"}` if the TaskAction parameter is set to modifySwitchTime. recoverMode: the restoration mode. Valid values: timePoint: performs the task at the specified point in time. immediate: performs the task immediately. maintainTime: performs the task within the maintenance window. recoverTime: the point in time for restoration, in ISO 8601 format (yyyy-MM-ddTHH:mm:ssZ, UTC). Required if recoverMode is set to timePoint.	{"recoverMode":"immediate"}

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	2B98499B-E62B-56D4-8D7F-3D6D4DB260F2
ErrorTaskId	string	The ID of the failed task. Returned only if a task fails.	t-0mqaj5hnyofczv****
SuccessCount	string	The number of completed tasks.	2
ErrorCode	string	The error code returned if a task fails.	mst.errorcode.success.errormessage

Examples

Success response

JSON format

{
  "RequestId": "2B98499B-E62B-56D4-8D7F-3D6D4DB260F2",
  "ErrorTaskId": "t-0mqaj5hnyofczv****",
  "SuccessCount": "2",
  "ErrorCode": "mst.errorcode.success.errormessage"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.