跳到主要内容

get_metadata_from_server 查看产品许可模板列表

POST /api/v1/license/get_metadata_from_server​

描述​

该接口为设备端在线申请许可服务。用户提供许可管理系统的IP地址，用户名和密码，从许可管理系统服务器获取产品及对应的许可模板列表。 该列表用于在页面中生成多级下拉框，帮助用户选择最终要使用的许可模板。

访问权限​

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

license:get_apply_license

JSON参数​

{
  "serverIp": string,
  "serverPort": number,
  "username": string,
  "password": string
}
提示
  • serverIp: 许可服务器的IP地址
  • serverPort: 许可服务器的端口号, 取值0-65535
  • username: 登录许可服务器的用户名
  • password: 登录许可服务器的密码

请求示例：

{
  "serverIp": "192.168.188.21",
  "serverPort": 8098,
  "username": "admin",
  "password": "realpassword"
}

响应结果​

请求返回的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,
  "data": [
    {
      "productId": 1,
      "productName": "CBM-BDESTY-23-2AC",
      "testMetadataList": [],
      "productMetadataList": []
    },
    {
      "productId": 2,
      "productName": "C300-S-10",
      "testMetadataList": [
        {
          "id": 12,
          "note": "C300产品元数据"
        },
        {
          "id": 13,
          "note": "C300产品元数据-V2"
        },
        ...
      ],
      "productMetadataList": []
    },
}
备注
  • productId: 产品ID
  • productName: 产品名称
  • testMetadataList: 测试许可模板列表
  • productMetadataList: 产品许可模板列表
  • id: 许可模板ID
  • note: 许可模板名称

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

{
  "success": false,
  "errorCode": "40007",
  "errorMessage": "error.request.format",
  "showType": 4
}

错误码​

错误码说明错误信息显示类型
40007请求参数格式错误error.request.format4
40007请求参数中缺少serverIp字段error.missing.param.server.ip4
40007请求参数中缺少serverPort字段error.missing.param.server.port4
40007serverPort必须在0-65535之间error.invalid.param.server.port4
40007请求参数中缺少username字段error.missing.param.username4
40007请求参数中缺少password字段error.request.password4
40007登录许可服务器请求失败login.license.server.request.error4
40007登录许可服务器响应异常login.license.server.response.error4
40007许可模板列表请求失败get.metadata.request.error4
40007许可模板列表响应异常get.metadata.response.error4
40007加载本地许可数据失败error.missing.local.license.data4
40007从服务器请求许可失败sign.license.request.error4
提示

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