ModifyTaskInfo - Tair (Redis® OSS-Compatible) - Alibaba Cloud Documentation Center

Modifies the task information, such as the task execution time.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
kvstore:ModifyTaskInfo	update	All Resources ``	none	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.	exec_task
TaskAction	string	No	The action name. Set the value to modifySwitchTime. The value specifies that you want 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: specifies the restoration mode for the task. 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: specifies the point in time for restoration. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. This parameter is required if the recoverMode parameter is set to timePoint.	{\"recoverMode\":\"immediate\"}

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	2B98499B-E62B-56D4-8D7F-3D6D4DB260F2
ErrorTaskId	string	The ID of the failed task. This parameter is returned 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

Sample success responses

JSONformat

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

Error codes

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