V2.1 Stop OTA Job¶
停止批量的固件 OTA 升级任务。
该 API 支持在 EnOS 2.2.0 及以上环境中使用。
操作权限¶
确保已获取调用该 API 的权限。更多信息，参见 获取 API 调用权限。
请求格式¶
POST https://{apigw-address}/connect-service/v2.1/ota-jobs?action=stop
请求参数（URI）¶
名称 |
位置（Path/Query） |
必需/可选 |
数据类型 |
描述 |
|---|---|---|---|---|
orgId |
Query |
必需 |
String |
OTA job 所属的 OU ID。如何获取orgId信息>> |
jobId |
Query |
必需 |
String |
需要停止的 OTA job ID。前往 EnOS 应用门户 > 开发者控制台，在 运行监控 > OTA 升级 中的 任务 ID 列查看 Job ID。 |
错误码¶
代码 |
错误信息 |
描述 |
|---|---|---|
24404 |
Job not found |
找不到 OTA job。 |
24616 |
Job has stopped |
OTA job 已停止。 |
示例¶
请求示例¶
url: https://{apigw-address}/connect-service/v2.1/ota-jobs?action=stop&orgId=yourOrgId&jobId=yourJobId
method: POST
返回示例¶
{
"code":0,
"msg":"OK",
"requestId":"a37e8666-212c-4b18-91d1-c7254724aec8",
"data":null
}