V2.1 Retry OTA Task
Retry OTA tasks under the specified OTA job.
This API is available in EnOS 2.2.0 and above.
Operation Permissions
Before invoking this API, ensure that the service account has been authorized the policy that includes the following service(s) and action permission(s). For how to authorize the service account, see Managing Service Accounts.
Required Service |
Required Operation Permission |
Firmware |
Control OTA |
Request Parameters (URI)
Name |
Location (Path/Query) |
Mandatory/Optional |
Data Type |
Description |
orgId |
Query |
Mandatory |
String |
The organization ID which the asset belongs to. How to get orgId>> |
jobId |
Query |
Mandatory |
String |
The job ID. |
Request Parameters (Body)
Name |
Mandatory/Optional |
Data Type |
Description |
deviceKeys |
Mandatory |
String Array |
The list of device keys for retrying the OTA task. |
Error Codes
Code |
Message |
Description |
24404 |
Job not found |
The job cannot be found. |
24617 |
Job not running |
Not able to retry as it is not running. |
24621 |
Only failed tasks can be retried |
Only failed tasks can be retried. |
Samples
Request Sample
url: https://{apigw-address}/connect-service/v2.1/ota-jobs?action=retryTask&orgId=yourOrgId&jobId=yourJobId
method: POST
requestBody: {"deviceKeys":["deviceKey1","deviceKey2"]}
Return Sample
{
"code":0,
"msg":"OK",
"requestId":"8e5d4643-1d13-4dd1-8896-e407f16381df",
"data":null
}
SDK Samples
You can access the SDK samples for Connection Service on GitHub: