创建OTA模块 - CreateOtaModule
功能介绍
用户可调用此接口创建产品的OTA模块,同一产品下最多自定义10个OTA模块。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
iotda:otamodules:create
Write
app *
g:EnterpriseProjectId
-
-
URI
POST /v5/iot/{project_id}/ota-upgrades/modules
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数说明：项目ID。获取方法请参见 获取项目ID。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
Instance-Id | 否 | String | 参数说明：实例ID。物理多租下各实例的唯一标识，建议携带该参数，在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面，选择左侧导航栏“总览”页签查看当前实例的ID，具体获取方式请参考 查看实例详情。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
app_id | 是 | String | 参数说明：资源空间ID。存在多资源空间的用户需要使用该接口时，建议携带该参数指定创建的升级包归属到哪个资源空间下。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
product_id | 是 | String | 参数说明：设备关联的产品ID，用于唯一标识一个产品模型，创建产品后获得。方法请参见 创建产品。 取值范围：长度不超过36，只允许字母、数字、下划线（_）、连接符（-）的组合。 |
module_name | 是 | String | 参数说明：OTA模块名称，产品下唯一且不可修改。 取值范围：长度不超过64，只允许英文字母、数字、下划线（_）、连接符（-）、英文点（.）的组合。 |
alias_name | 否 | String | 参数说明：OTA模块别名。 取值范围：长度不超过64，只允许中文、英文字母、数字、下划线（_）、连接符（-）、英文点（.）的组合。 |
description | 否 | String | 参数说明：用于描述模块的功能等信息。 取值范围：长度不超过1024。 |
响应参数
状态码：201
参数 | 参数类型 | 描述 |
|---|---|---|
module_id | String | OTA模块ID |
app_id | String | 资源空间ID |
product_id | String | OTA模块关联的产品ID |
product_name | String | OTA模块关联的产品名称 |
module_name | String | OTA模块名称。 |
alias_name | String | OTA模块别名 |
description | String | 用于描述模块的功能等信息 |
create_time | String | 创建OTA模块的时间，格式："yyyyMMdd'T'HHmmss'Z'"。 |
请求示例
创建OTA模块。
POST https://{endpoint}/v5/iot/{project_id}/ota-upgrades/modules
{
"app_id" : "61f7e74d036aca5be29e1ed4",
"product_id" : "5ba24f5ebbe8f56f5a14f605",
"module_name" : "MCU",
"alias_name" : "微控制单元",
"description" : "微控制单元固件模块"
} 响应示例
状态码：201
Created
{
"module_id" : "28f61af50fc9452aa0ed5ea25c3cc3d3",
"app_id" : "61f7e74d036aca5be29e1ed4",
"product_id" : "5ba24f5ebbe8f56f5a14f605",
"product_name" : "Thermometer",
"module_name" : "MCU",
"alias_name" : "微控制单元",
"description" : "微控制单元固件模块",
"create_time" : "20230211T121212Z"
} 状态码
状态码 | 描述 |
|---|---|
201 | Created |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
500 | Internal Server Error |
错误码
请参见错误码。
