跳到主要内容

apply_license_in_lab 设备在线申请许可

POST /api/v1/license/apply_license_in_lab​

描述​

该接口用于用户在设备页面上在线申请许可。访问该接口后，设备会调用服务器接口，为当前设备申请许可。 申请许可后，会进行许可文件的校验，校验通过后会替换本地许可文件，并自动重启设备。

访问权限​

需要登录，具备以下权限：

license:save_apply_license

JSON参数​

{
  "metadataId": number,
  "createNewSN": true|false,
  "batchNum": number
}
提示
  • metadataId: 许可模板ID
  • createNewSN: 是否为设备创建新的序列号，传入true时，会为设备创建新的序列号，否则使用当前设备序列号。
  • batchNum: 设备批次，仅当创建新的序列号时才需要传入。

请求示例：

{
  "metadataId": 453,
  "createNewSN": true,
  "batchNum": 10
}

响应结果​

请求返回的HTTP状态码为200

返回结果为JSON格式的数据，您可以通过解析JSON数据来获取API调用的结果信息。结构如下：

{
  "success": true|false,
  "errorCode"?: "option string",
  "errorMessage": "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}
备注

正确结果示例：

{
  "success": true
}

错误结果示例, 返回false时候需要带上错误码和错误信息：

{
  "success": false,
  "errorCode": "40007",
  "errorMessage": "upload.file.not.exist",
  "showType": 4
}

错误码​

错误码说明错误信息显示类型
40007需要先查询一次许可模板列表server.ip.or.token.is.empty4
40007请求参数格式错误error.request.format4
40007请求参数中缺少metadataId字段error.missing.param.metadata.id4
40007metadataId字段的值必须大于0metadata.id.must.gt.04
40007请求参数中缺少createNewSN字段error.missing.param.create.new.sn4
40007请求参数中缺少batchNum字段error.missing.param.batch.num4
40007batchNum字段的值必须大于0batch.num.must.gt.04
40007生成请求参数失败query.json.is.null4
40007加载本地许可数据失败error.missing.local.license.data4
40007从服务器请求许可失败sign.license.request.error4
40007下载许可文件到本地失败sign.license.file.not.found4
40007许可文件校验失败license.file.verify.failed4
40007许可文件2次校验失败license.file.verify.failed.24
提示

4 表示弹框提示错误信息。