StopTasks

Updated at:

Description: Stops one or more tasks.

Endpoint:rpa/openapi/raas/task/StopTasks

Method:POST

Usage notes:

  • This operation terminates running or waiting tasks with a "Failed" status. It skips tasks that have already succeeded or failed.

  • This is an asynchronous API. Check the console or the results of ListTasks or ListTaskDetails queries for the final task status.

Limitations:

Important

For details about API call limits, see Call Limits.

Request parameters:

Parameter

Type

Required

Example value

Description

TaskIds

Array of String. Serialization method: simple.

Yes

["3226a05a -****-****-****- b8fb7e4561c6", "092fb04a -****-****-****- 6c0301a3b066"]

The IDs of the tasks to stop. You can specify a maximum of 10 task IDs in a single request. To stop more than 10 tasks, make multiple requests.

Response parameters:

For information about common response parameters, see Response Structure. The data field in the response is null.

Request example:

https://console-rpa.aliyun.com/rpa/openapi/raas/task/StopTasks?
&TaskIds=%5B014b9ab1-51c2-*******-b685429a8764%5D
&CommonRequestParameters

Response example:

{
	"requestId": "709e6050-****-****-****-b47bbf5796df",
	"success": true,
	"code": 0,
	"msg": "The request was successful.",
	"msgCode": "result.success",
	"data": null,
	"pager": null,
	"instanceId": null
}