创建量产任务

最近更新时间:2024-04-03 11:20:57

我的收藏

1. 接口描述

接口请求域名: iotexplorer.tencentcloudapi.com 。

用于新建批量生产设备

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateBatchProduction。
Version String 公共参数,本接口取值:2019-04-23。
Region String 公共参数,详见产品支持的 地域列表
ProjectId String 项目ID
示例值:prj-pq00mstg
ProductId String 产品ID
示例值:R32ONVL0EU
BurnMethod Integer 烧录方式,0为直接烧录,1为动态注册。
示例值:0
GenerationMethod Integer 生成方式,0为系统生成,1为文件上传。
示例值:0
UploadUrl String 文件上传URL,用于文件上传时填写。
示例值:http://tencent.com
BatchCnt Integer 量产数量,用于系统生成时填写。
示例值:5
GenerationQRCode Integer 是否生成二维码,0为不生成,1为生成。
示例值:0

3. 输出参数

参数名称 类型 描述
ProjectId String 项目Id
示例值:prj-pq00mstg
ProductId String 产品Id
示例值:R32ONVL0EU
BatchProductionId String 量产id
示例值:LC-74ais6a3
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 新建量产 - 上传URL

使用上传文件 url 的方式进行量产

输入示例

POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBatchProduction
<公共请求参数>

{
    "ProjectId": "prj-pq00mstg",
    "BurnMethod": "0",
    "UploadUrl": "www.xxxxxxxx.com/xxxxxx.csv",
    "GenerationMethod": "1",
    "ProductId": "R32ONVL0EU"
}

输出示例

{
    "Response": {
        "BatchProductionId": "LC-74ais6a3",
        "ProductId": "R32ONVL0EU",
        "ProjectId": "prj-pq00mstg",
        "RequestId": "rest-client3331231026"
    }
}

示例2 新建量产 - 系统生成

使用系统生成的方式进行量产

输入示例

POST / HTTP/1.1
Host: iotexplorer.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBatchProduction
<公共请求参数>

{
    "ProjectId": "prj-pq00mstg",
    "BurnMethod": "0",
    "BatchCnt": "5",
    "GenerationMethod": "0",
    "ProductId": "R32ONVL0EU"
}

输出示例

{
    "Response": {
        "BatchProductionId": "LC-74ais6a3",
        "ProductId": "R32ONVL0EU",
        "ProjectId": "prj-pq00mstg",
        "RequestId": "rest-client2213121026"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.ProductNotReleased 产品尚未发布。
InternalError 内部错误。
InternalError.DBOpertaionError DB操作错误。
InternalError.InternalRPCError 内部RPC错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.ErrLLSyncBroadcastDeviceNameLengthExceed 使用标准蓝牙广播协议的产品,DeviceName最多不超过8个字符。
LimitExceeded.BatchProductionExceedLimit 量产超出限制。
LimitExceeded.BatchProductionNull 量产为空。
ResourceInsufficient.BatchProductionIsRunning 已有量产进行,请等待量产完成。
ResourceNotFound.CannotGetFromUrl 上传URL无法获取。
ResourceNotFound.DeviceDupKeyExist 存在重复设备。
ResourceNotFound.ProjectNotExist 项目不存在。
ResourceNotFound.StudioProductNotExist 产品不存在。
UnauthorizedOperation.NoPermissionToProject 项目ACL错误。
UnauthorizedOperation.NoPermissionToStudioProduct 产品ACL错误。
UnsupportedOperation.DeviceExceedLimit 设备数量超出实例限制。
UnsupportedOperation.InstanceIsolated 由于实例到期已被禁用,请续费后使用。