设备接入 IOTDA-创建OTA升级包:请求参数
下载设备接入 IOTDA用户手册完整版
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
否 |
String |
参数说明：用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 |
Instance-Id |
否 |
String |
参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考查看实例详情 。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
app_id |
是 |
String |
参数说明：资源空间ID。存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的升级包归属到哪个资源空间下。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
package_type |
是 |
String |
参数说明：升级包类型。 取值范围：软件包必须设置为：softwarePackage，固件包必须设置为：firmwarePackage。 |
product_id |
是 |
String |
参数说明：设备关联的产品ID，用于唯一标识一个产品模型，创建产品后获得。方法请参见 创建产品。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
version |
是 |
String |
参数说明：升级包版本号。 取值范围：长度不超过256，只允许字母、数字、下划线（_）、连接符（-）、英文点（.）的组合。 |
support_source_versions |
否 |
Array of strings |
参数说明：支持用于升级此版本包的设备源版本号列表。最多支持20个源版本号。 取值范围：源版本号列表，源版本号只允许字母、数字、下划线（_）、连接符（-）、英文点（.）的组合。 |
description |
否 |
String |
参数说明：用于描述升级包的功能等信息。 取值范围：长度不超过1024。 最大长度：1024 |
custom_info |
否 |
String |
参数说明：推送给设备的自定义信息。添加该升级包完成，并创建升级任务后， 物联网平台 向设备下发升级通知时，会下发该自定义信息给设备。 取值范围：长度不超过4096。 最大长度：4096 |
file_location |
是 |
FileLocation object |
升级包的位置 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
region_name |
是 |
String |
参数说明：OBS所在区域。您可以从地区和终端节点中查询服务的终端节点。 取值范围：长度不超过256，只允许字母、数字、连接符（-）的组合。 |
bucket_name |
是 |
String |
参数说明：OBS桶名称。 取值范围：长度最小为3，最大为63，只允许小写字母、数字、连接符（-）、英文点（.）的组合。 |
object_key |
是 |
String |
参数说明：OBS对象名称(包含文件夹路径)，对象大小最大为1G，且只支持.bin、.dav、.tar、.gz、.zip、.gzip、.apk、.tar.gz、.tar.xz、.pack、.exe、.bat、.img格式的文件。 取值范围：长度不超过1024。 最小长度：1 最大长度：1024 |
sign |
否 |
String |
参数说明：SHA256算法计算出的升级包签名值。添加该升级包完成，并创建升级任务后，物联网平台向设备下发升级通知时，会下发该签名给设备。 取值范围：长度为64，只允许大小写字母a到f、数字的组合。 |
