invoke_api_x 调用钟板API

POST /api/v1/clock_board/invoke_api_x

描述

通过主控板调用另一块儿主控板或业务板的API。

访问权限

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

clock_board:invoke_api_x

JSON参数

请求参数如下：

{
  "apiVersion": string,
  "moduleName": string,
  "action": string,
  "payload": string
}

• apiVersion: API版本号，必填
• moduleName: 模块名称，必填
• action: API名称，必填
• payload: API的参数，必填

请求示例：

{
  "apiVersion": "v1",
  "moduleName": "network",
  "action": "mgmt_port_list",
  "payload": "{\"id\":0}"
}

响应结果

请求返回的HTTP状态码为200

返回结果分为两种：

• 成功：如果调用成功，则将目标API的返回结果直接返回给调用方，格式参考目标API的返回结果。
• 失败：如果调用失败，则返回如下格式的JSON数据：

{
  "success": false,
  "errorCode": "option string",
  "errorMessage": "option string",
  "showType": 0|1|2|4|9,
  "traceId": number
}

提示

• 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	调用转发接口参数格式错误