V2.5 Download Firmware File


下载固件文件。

操作权限


使用此 API 前,确保服务账号已被授予包含下列服务和操作权限的策略。有关授权服务账号的更多信息,参见 管理服务账号


需授权的服务

所需操作权限

固件服务

Read OTA

请求格式

GET https://{apigw-address}/connect-service/v2.5/files?action=downloadFirmwareFile

请求参数(URI)

名称

位置(Path/Query)

必需/可选

数据类型

描述

orgId

Query

必需

String

资产所属的组织 ID。如何获取 orgId 信息>>

firmwareId

Query

必需

String

需要获取固件文件的目标固件 ID。前往 OTA 升级 > 固件管理固件ID 列查看固件ID。

响应参数

名称

数据类型

描述

code

Int

请求返回状态值。0表示请求成功,非0表示请求失败。

msg

String

对状态码的解释和说明。请求成功为 OK

requestId

String

每次请求获取的ID,用于唯一标识一次API请求。

data

null

无。

错误码

代码

错误信息

描述

400

Bad Request

请求失败。

401

Unauthorized

未授权。

403

Forbidden

禁止访问。

404

Not Found

资源未找到。

500

Internal Server Error

服务器内部错误。

示例

请求示例

url: https://{apigw-address}/connect-service/v2.5/devices?action=downloadFirmware&orgId=yourOrgId
method: POST
requestBody:
{
    "firmwareId": "firmwareId"
}

返回示例

{
    "code": 0,
    "msg": "OK",
    "requestId": "requestId",
    "data": {
        "firmwareFile": "firmwareFile"
    }
}