V2.1 Stop OTA Job¶
停止一个 OTA job。
该 API 支持在 EnOS 2.2.0 及以上环境中使用。
操作权限¶
使用此 API 前，确保服务账号已被授予包含下列服务和操作权限的策略。有关授权服务账号的更多信息，参见 管理服务账号。
需授权的服务 |
所需操作权限 |
|---|---|
固件 |
Control OTA |
请求格式¶
POST https://{apigw-address}/connect-service/v2.1/ota-jobs?action=stop
请求参数（URI）¶
名称 |
位置（Path/Query） |
必需/可选 |
数据类型 |
描述 |
|---|---|---|---|---|
orgId |
Query |
必需 |
String |
资产所属的组织ID。如何获取orgId信息>> |
jobId |
Query |
必需 |
String |
需要停止的OTA job ID。前往 OTA 升级 > OTA 任务 中查看 OTA 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
}
SDK 示例¶
你可以在 Github 上获取接入服务的 SDK 示例：