Updated on 2026-09-30 GMT+08:00

Confirm the Execution of a Batch Task

Function

This API is used by an application to confirm the execution of a batch task. This parameter is supported when task_type is set to firmwareUpgrade, softwareUpgrade, or moduleUpgrade. This API cannot be called if the task identified by task_id has been completed (successful, failed, partially successful, or stopped) or is being stopped. If the request body is {}, all subtasks in the waiting state will be confirmed for execution after this API is called.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
iotda:batchtasks:confirm	Write	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

URI

POST /v5/iot/{project_id}/batchtasks/{task_id}/confirm

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
task_id	Yes	String	Parameter description: batch task ID. It is allocated by the platform during batch task creation. Value: The value can contain up to 24 characters. Only lowercase letters a to f and digits are allowed.
project_id	Yes	String	Parameter description : project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Instance-Id	No	String	Parameter description : instance ID. Unique identifier of each instance in the physical multi-tenant scenario. Mandatory for professional editions and recommended in other cases. Log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID. For details, see Viewing Instance Details.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
targets	No	Array of strings	Indicates the target set of the batch operation. Max: 100 targets. When task_type is set to firmwareUpgrade or softwareUpgrade, set this parameter to device_id.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
targets	Array of BatchTargetResult objects	Indicates the batch operation result set.

**Table 5** BatchTargetResult
Parameter	Type	Description
target	String	Indicates the batch operation targets.
status	String	Parameter description: execution result of the target. Range: success: The task is successful. failure: The task fails.
error_code	String	Indicates the error code.
error_msg	String	Indicates the error description.

Example Requests

Confirms the execution of all subtasks in the waiting state.

POST https://{endpoint}/v5/iot/{project_id}/batchtasks/{task_id}/confirm

{ }

Confirms the execution of subtasks for a specified target set.

POST https://{endpoint}/v5/iot/{project_id}/batchtasks/{task_id}/confirm

{
  "targets" : [ "e495cf17-ff79-4294-8f64-4d367919d665" ]
}

Example Responses

Status code: 200

{
  "targets" : [ {
    "target" : "e495cf17-ff79-4294-8f64-4d367919d665",
    "status" : "failure",
    "error_code" : "IOTDA.014219",
    "error_msg" : "Invalid input. The target is not in the task"
  }, {
    "target" : "e495cf17-ff79-4294-8f64-4d367919d677",
    "status" : "success"
  } ]
}

Status Codes

Status Code	Description
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: Batch Task