Skip to main content

forward_file_params_x 上传转发文件参数

POST /api/v1/clock_board/forward_file_params_x

描述

基于当前的CGI文件上传接口设计,通过主控板向业务板转发文件上传请求时,需要分2步进行。

  1. 上传文件到主控板,主控板会缓存该文件
  2. 上传转发信息到主控板,主控板会根据转发信息,将缓存的文件转发给业务板

本接口是上传转发信息到主控板的接口,即上面描述的第二步。

访问权限

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

clock_board:forward_file_params_x

JSON参数

请求参数如下:

{
"apiVersion": string,
"moduleName": string,
"action": string,
"payload": string
}
  • apiVersion: API版本号,必填
  • moduleName: 模块名称,必填
  • action: API名称,必填,注意此处对应业务板的文件上传接口名称
  • payload: API的参数,必填

请求示例:

{
"apiVersion": "v1",
"moduleName": "license",
"action": "replace_license",
"payload": "{}"
}

响应结果

请求返回的HTTP状态码为200

返回结果分为两种:

  • 成功:如果调用成功,则将目标API的返回结果直接返回给调用方,格式参考目标API的返回结果。
  • 失败:如果调用失败,则返回如下格式的JSON数据:
{
"success": false,
"errorCode": "option string",
"errorMessage": "option string",
"showType": 0|1|2|4|9,
"traceId": number
}
tip
  • success: 是否调用成功,true表示成功,false表示失败
  • errorCode: 错误码
  • errorMessage: 错误描述
  • showType: 显示类型,数值型,用于前端展示错误信息,含义如下:
    • 0: 不展示
    • 1: 通知
    • 2: 警告
    • 4: 错误
    • 9: 在页面内部展示的错误,如表单验证错误
  • traceId: 代码追踪ID

错误结果示例:

{
"success": false,
"errorCode": "60003",
"errMessage": "device.response.error",
"showType": 1,
"traceId": 69
}

错误码

错误码说明
60001目标设备不存在
60002目标设备状态错误
60003目标设备接口响应错误
60004调用转发接口参数格式错误
60005当前主板不是主控板
60006临时文件不存在