跳到主要内容

replace_license 替换License

POST /api/v1/license/replace_license

描述

更换License接口,用于上传新的License文件。只能上传一个License文件。上传的文件内容会被解析为License文件。 设备会自动校验License文件的有效性,如果校验失败,会返回错误信息。

访问权限

需要登录,具备以下权限:

license:replace_license

上传License文件

使用multipart/form-data格式上传License文件。

采用文件上传的方式:

POST /api/v1/license/replace_license HTTP/1.1
Host: <ip>:<port>
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-length: 12345

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="license.lic"
Content-Type: application/octet-stream
file content, binary data, not shown here
------WebKitFormBoundary7MA4YWxkTrZu0gW--
提示

可以使用上传控件上传文件,也可以使用curl命令上传文件。 文件上传标准参考rfc1867

注意

只能包含一个上传文件,文件名会被忽略,文件内容会被解析为License文件。 不能包含其他的参数。

响应结果

请求返回的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": "40004",
"errorMessage": "ptp.port.not.exist",
"showType": 4
}

错误码

错误码说明错误信息显示类型
40005不是文件上传请求not.file.upload.request4
40006License文件解析失败license.file.parse.failed4
40007不支持的License文件license.file.unsupported4

40006 错误码表示上传的文件不是有效的License文件,可能是文件格式错误,或者文件内容错误。 40007 错误码表示上传的文件不是支持的License文件,可能是当前设备不支持的License文件。

提示

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