ModifyTaskInfo API to modify task information - ApsaraDB for MongoDB - Alibaba Cloud - ApsaraDB for MongoDB

Operation description

The available actions for a task depend on its current state. You can obtain the supported actions from the actionInfo parameter returned by the DescribeHistoryTasks operation.

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

dds:ModifyTaskInfo

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
TaskId	string	Yes	The task ID. Separate multiple IDs with commas (,). You can specify up to 10 task IDs.	t-83br18hlpdrw3uxxxx
StepName	string	Yes	The name of the step visible to the user.	exec_task
TaskAction	string	Yes	The action name corresponding to the task state, as described in the actionInfo parameter of the DescribeHistoryTasks operation.	modifySwitchTime
ActionParams	string	No	An action-related parameter that you can extend based on your business requirements. The value varies depending on the TaskAction parameter.	{\"recoverMode\":\"immediate\"}

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	6163731A-XXXX-XXXX-B934-3388DE70C217
ErrorTaskId	string	The ID of the task that failed. This parameter is returned only when a task fails.	""
SuccessCount	string	The number of successful tasks.	1
ErrorCode	string	The error code returned for a failed task, which matches the error codes of the ModifyTaskInfo operation.	""

Examples

Success response

JSON format

{
  "RequestId": "6163731A-XXXX-XXXX-B934-3388DE70C217",
  "ErrorTaskId": "\"\"",
  "SuccessCount": "1",
  "ErrorCode": "\"\""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.