V2.1 Start OTA Job¶
Start an 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 Format¶
POST https://{apigw-address}/connect-service/v2.1/ota-jobs?action=start
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. |
Error Codes¶
Code |
Message |
Description |
---|---|---|
24404 |
Job not found |
The job cannot be found. |
24615 |
Job has started |
The job has already started. |
Samples¶
Request Sample¶
url: https://{apigw-address}/connect-service/v2.1/ota-jobs?action=start&orgId=yourOrgId&jobId=yourJobId
method: POST
Return Sample¶
{
"code":0,
"msg":"OK",
"requestId":"3bdf31b4-e357-4d4c-8cf9-a40dc129a407",
"data":null
}
SDK Samples¶
You can access the SDK samples for Connection Service on GitHub: