接口说明

    1.1.1 传输协议规范

    • 网络传输协议:使用HTTP协议
    • 请求地址: /front/add
    • 请求方式:POST
    • 请求头:Content-type: application/json
    • 返回格式:JSON

    1.1.2 请求参数

    2)入参示例

    1. "frontId": 1001,
    2. "frontIp": "127.0.0.1",
    3. "frontPort": 5002,
    4. "description": "test"
    5. }

    2.1.3 返回参数

    1)出参表

    序号输出参数类型备注
    1codeInt返回码,0:成功 其它:失败
    2messageString描述
    3Object节点信息对象
    3.1frontIdInt前置编号
    3.2frontIpString前置ip
    3.3frontPortInt前置端口
    3.4memoryTotalSizeString内存总量(单位:KB)
    3.5memoryUsedSizeString内存使用量(单位:KB)
    3.6cpuSizeStringCPU的大小(单位:MHz)
    3.7cpuAmountStringCPU的核数(单位:个)
    3.8diskTotalSizeString文件系统总量(单位:KB)
    3.9diskUsedSizeString文件系统已使用量(单位:KB)
    3.10descriptionString备注
    3.11createTimeLocalDateTime落库时间
    3.12modifyTimeLocalDateTime修改时间

    2)出参示例

    • 成功:
    1. {
    2. "code": 0,
    3. "message": "success",
    4. "data": {
    5. "frontId": 1001,
    6. "frontIp": "127.0.0.1",
    7. "frontPort": 5302,
    8. "memoryTotalSize": "8008840",
    9. "memoryUsedSize": "7652872",
    10. "cpuSize": "2599",
    11. "cpuAmount": "4",
    12. "diskTotalSize": "51474044",
    13. "diskUsedSize": "44137936",
    14. "createTime": "2020-04-29T12:15:40",
    15. "modifyTime": "2020-05-03T12:04:08"
    16. }
    17. }
    • 失败:
    1. {
    2. "code": 102000,
    3. "message": "system exception",
    4. "data": {}
    5. }

    1.2 获取所有前置列表

    1.2.1 传输协议规范

    • 网络传输协议:使用HTTP协议
    • 请求地址:/front/list?frontId={frontId}
    • 请求方式:GET
    • 返回格式:JSON

    1.2.2 请求参数

    1)入参表

    序号输入参数类型可为空备注
    1frontIdInt前置编号

    2)入参示例

    1. http://127.0.0.1:5008/WeBASE-Stat/front/list?frontId=1001

    1.2.3 返回参数

    1)出参表

    序号输出参数类型备注
    1codeInt返回码,0:成功 其它:失败
    2messageString描述
    3totalCountInt总记录数
    4dataList列表
    4.1Object信息对象
    4.1.1frontIdInt前置编号
    4.1.2frontIpString前置ip
    4.1.3frontPortInt前置端口
    4.1.4memoryTotalSizeString内存总量(单位:KB)
    4.1.5memoryUsedSizeString内存使用量(单位:KB)
    4.1.6cpuSizeStringCPU的大小(单位:MHz)
    4.1.7cpuAmountStringCPU的核数(单位:个)
    4.1.8diskTotalSizeString文件系统总量(单位:KB)
    4.1.9diskUsedSizeString文件系统已使用量(单位:KB)
    4.1.10descriptionString备注
    4.1.11createTimeLocalDateTime落库时间
    4.1.12modifyTimeLocalDateTime修改时间

    2)出参示例

    • 成功:
    1. {
    2. "code": 0,
    3. "message": "success",
    4. "data": [
    5. {
    6. "frontId": 1001,
    7. "frontIp": "127.0.0.1",
    8. "frontPort": 5302,
    9. "memoryTotalSize": "8008840",
    10. "memoryUsedSize": "7652872",
    11. "cpuSize": "2599",
    12. "cpuAmount": "4",
    13. "diskTotalSize": "51474044",
    14. "diskUsedSize": "44137936",
    15. "description": "dd",
    16. "createTime": "2020-04-29T12:15:40",
    17. "modifyTime": "2020-05-03T12:04:08"
    18. }
    19. ],
    20. "totalCount": 1
    21. }
    • 失败:
    1. {
    2. "code": 102000,
    3. "message": "system exception",
    4. "data": {}
    5. }

    1.3 删除前置信息

    1.3.1 传输协议规范

    • 网络传输协议:使用HTTP协议
    • 请求地址:/front/{frontId}
    • 请求方式:DELETE
    • 请求头:Content-type: application/json
    • 返回格式:JSON

    1.3.2 请求参数

    1)入参表

    序号输入参数类型可为空备注
    1frontIdInt前置编号

    2)入参示例

    1. http://127.0.0.1:5008/WeBASE-Stat/front/1001

    1.3.3 返回参数

    1)出参表

    序号输出参数类型备注
    1codeInt返回码,0:成功 其它:失败
    2messageString描述
    3dataobject返回信息实体(空)

    2)出参示例

    • 成功:
    1. {
    2. "code": 0,
    3. "data": {},
    4. "message": "success"
    5. }
    • 失败:
    1. "code": 102000,
    2. "message": "system exception",
    3. "data": {}
    4. }

    2.1.1 传输协议规范

    • 网络传输协议:使用HTTP协议
    • 请求地址:/group/list/{frontId}
    • 请求方式:GET
    • 返回格式:JSON

    2.1.2 请求参数

    2)入参示例

    1. http://127.0.0.1:5008/WeBASE-Stat/group/list/1001

    2.1.3 返回参数

    1)出参表

    序号输出参数类型备注
    1codeInt返回码,0:成功 其它:失败
    2messageString描述
    3totalCountInt总记录数
    4dataList列表
    4.1Object信息对象
    4.1.1frontIdInt前置编号
    4.1.2groupIdInt群组编号
    4.1.3descriptionString描述
    4.1.4createTimeLocalDateTime落库时间
    4.1.5modifyTimeLocalDateTime修改时间

    2)出参示例

    • 成功:
    • 失败:
    1. {
    2. "code": 102000,
    3. "message": "system exception",
    4. "data": {}
    5. }

    3.1 查询群组基本数据

    3.1.1 传输协议规范

    • 网络传输协议:使用HTTP协议
    • 请求地址:
    1. /data/groupBasicData?frontId={frontId}&groupId={groupId}&pageSize={pageSize}&pageNumber={pageNumber}&beginDate={beginDate}&endDate={endDate}
    • 请求方式:GET
    • 返回格式:JSON

    3.1.2 请求参数

    1)入参表

    序号输入参数类型可为空备注
    1frontIdInt前置编号
    2groupIdInt群组编号
    3pageSizeInt每页记录数
    4pageNumberInt当前页码
    5beginDateLocalDateTime开始时间(yyyy-MM-dd’T’HH:mm:ss.SSS 2019-03-13T00:00:00)
    6endDateLocalDateTime结束时间

    2)入参示例

    1. http://127.0.0.1:5008/WeBASE-Stat/data/groupBasicData?frontId=1001&groupId=1&pageSize=1&pageNumber=1&beginDate=2020-04-30T16%3A57%3A35&endDate=2020-04-30T22%3A57%3A35

    3.1.3 返回参数

    1)出参表

    序号输出参数类型备注
    1codeInt返回码,0:成功 其它:失败
    2messageString描述
    3totalCountInt总记录数
    4dataList列表
    4.1Object信息对象
    4.1.1idLong编号
    4.1.2frontIdInt前置编号
    4.1.3groupIdInt群组编号
    4.1.4sizeLong群组大小
    4.1.5transCountLong群组交易数量
    4.1.6commentString备注
    4.1.7createTimeLocalDateTime落库时间
    4.1.8modifyTimeLocalDateTime修改时间

    2)出参示例

    • 成功:
    1. {
    2. "code": 0,
    3. "message": "success",
    4. "data": [
    5. {
    6. "id": 13475,
    7. "frontId": 1001,
    8. "groupId": 1,
    9. "size": 17157,
    10. "transCount": 121,
    11. "comment": null,
    12. "createTime": "2020-04-30T20:21:23",
    13. "modifyTime": "2020-04-30T20:21:23"
    14. }
    15. ],
    16. "totalCount": 14
    17. }
    • 失败:
    1. {
    2. "code": 102000,
    3. "message": "system exception",
    4. "data": {}
    5. }

    3.2 查询群组网络基本数据

    3.2.1 传输协议规范

    • 网络传输协议:使用HTTP协议
    • 请求地址:
    1. /data/netWorkData?frontId={frontId}&groupId={groupId}&pageSize={pageSize}&pageNumber={pageNumber}&beginDate={beginDate}&endDate={endDate}
    • 请求方式:GET
    • 返回格式:JSON

    3.2.2 请求参数

    1)入参表

    序号输入参数类型可为空备注
    1frontIdInt前置编号
    2groupIdInt群组编号
    3pageSizeInt每页记录数
    4pageNumberInt当前页码
    5beginDateLocalDateTime开始时间(yyyy-MM-dd’T’HH:mm:ss.SSS 2019-03-13T00:00:00)
    6endDateLocalDateTime结束时间

    2)入参示例

      3.2.3 返回参数

      1)出参表

      序号输出参数类型备注
      1codeInt返回码,0:成功 其它:失败
      2messageString描述
      3totalCountInt总记录数
      4dataList列表
      4.1Object信息对象
      4.1.1idLong编号
      4.1.2frontIdInt前置编号
      4.1.3groupIdInt群组编号
      4.1.4totalInLong总入流量(P2P_InBytes + SDK_InBytes)
      4.1.5totalOutLong总出流量(P2P_OutBytes + SDK_OutBytes)
      4.1.6timestampLong统计时间

      2)出参示例

      • 成功:
      1. {
      2. "code": 0,
      3. "message": "success",
      4. "data": [
      5. {
      6. "id": 202055,
      7. "frontId": 1001,
      8. "groupId": 1,
      9. "totalIn": 91952,
      10. "totalOut": 92934,
      11. "timestamp": 1588240648000
      12. }
      13. ],
      14. "totalCount": 60
      15. }
      • 失败:
      1. {
      2. "code": 102000,
      3. "message": "system exception",
      4. "data": {}
      5. }

      3.3.1 传输协议规范

      • 网络传输协议:使用HTTP协议
      • 请求地址:
      1. /data/gasData?frontId={frontId}&groupId={groupId}&pageSize={pageSize}&pageNumber={pageNumber}&beginDate={beginDate}&endDate={endDate}
      • 请求方式:GET
      • 返回格式:JSON

      3.3.2 请求参数

      2)入参示例

      3.3.3 返回参数

      1)出参表

      序号输出参数类型备注
      1codeInt返回码,0:成功 其它:失败
      2messageString描述
      3totalCountInt总记录数
      4dataList列表
      4.1Object信息对象
      4.1.1idLong编号
      4.1.2frontIdInt前置编号
      4.1.3groupIdInt群组编号
      4.1.4transHashString交易hash
      4.1.5gasUsedLong交易消耗的gas
      4.1.6timestampLong统计时间

      2)出参示例

      • 成功:
      1. {
      2. "code": 0,
      3. "message": "success",
      4. "data": [
      5. "id": 123,
      6. "frontId": 1001,
      7. "groupId": 1,
      8. "transHash": "0x1c232b58a6bf7a718d1434f160b6aa4dbbc9b65e831a2a10f9e36ffaa8b88ac6",
      9. "gasUsed": 41758,
      10. "timestamp": 1588230163000
      11. }
      12. ],
      13. "totalCount": 54
      14. }
      • 失败:
      1. {
      2. "code": 102000,
      3. "message": "system exception",
      4. "data": {}
      5. }

      3.4 查询群组节点监控基本数据

      3.4.1 传输协议规范

      • 网络传输协议:使用HTTP协议
      • 请求地址:
      1. /data/nodeMonitor?frontId={frontId}&groupId={groupId}&pageSize={pageSize}&pageNumber={pageNumber}&beginDate={beginDate}&endDate={endDate}
      • 请求方式:GET
      • 返回格式:JSON

      3.4.2 请求参数

      1)入参表

      序号输入参数类型可为空备注
      1frontIdInt前置编号
      2groupIdInt群组编号
      3pageSizeInt每页记录数
      4pageNumberInt当前页码
      5beginDateLocalDateTime开始时间(yyyy-MM-dd’T’HH:mm:ss.SSS 2019-03-13T00:00:00)
      6endDateLocalDateTime结束时间

      2)入参示例

      1. http://127.0.0.1:5008/WeBASE-Stat/data/nodeMonitor?frontId=1001&groupId=1&pageSize=1&pageNumber=1&beginDate=2020-04-30T16%3A57%3A35&endDate=2020-04-30T18%3A57%3A35

      3.4.3 返回参数

      1)出参表

      序号输出参数类型备注
      1codeInt返回码,0:成功 其它:失败
      2messageString描述
      3totalCountInt总记录数
      4dataList列表
      4.1Object信息对象
      4.1.1idLong编号
      4.1.2frontIdInt前置编号
      4.1.3groupIdInt群组编号
      4.1.4blockHeightLong块高
      4.1.5pbftViewLongview
      4.1.6pendingTransactionCountInt待交易数
      4.1.7timestampLong统计时间

      2)出参示例

      • 成功:
      1. {
      2. "code": 0,
      3. "message": "success",
      4. "data": [
      5. {
      6. "id": 44144,
      7. "frontId": 1001,
      8. "groupId": 1,
      9. "blockHeight": 121,
      10. "pbftView": 11754,
      11. "pendingTransactionCount": 0,
      12. "timestamp": 1588242055000
      13. }
      14. ],
      15. "totalCount": 1001
      16. }
      • 失败:
      1. {
      2. "code": 102000,
      3. "message": "system exception",
      4. "data": {}
      5. }

      3.5 查询群组主机性能基本数据

      3.5.1 传输协议规范

      • 网络传输协议:使用HTTP协议
      • 请求地址:
      1. /data/serverPerformance?frontId={frontId}&pageSize={pageSize}&pageNumber={pageNumber}&beginDate={beginDate}&endDate={endDate}
      • 请求方式:GET
      • 返回格式:JSON

      3.5.2 请求参数

      1)入参表

      序号输入参数类型可为空备注
      1frontIdInt前置编号
      2pageSizeInt每页记录数
      3pageNumberInt当前页码
      4beginDateLocalDateTime开始时间(yyyy-MM-dd’T’HH:mm:ss.SSS 2019-03-13T00:00:00)
      5endDateLocalDateTime结束时间

      2)入参示例

      1. http://127.0.0.1:5008/WeBASE-Stat/data/serverPerformance?frontId=1001&pageSize=1&pageNumber=1&beginDate=2020-04-20T16%3A57%3A35&endDate=2020-04-30T16%3A57%3A35

      3.5.3 返回参数

      1)出参表

      序号输出参数类型备注
      1codeInt返回码,0:成功 其它:失败
      2messageString描述
      3totalCountInt总记录数
      4dataList列表
      4.1Object信息对象
      4.1.1idLong编号
      4.1.2frontIdInt前置编号
      4.1.3groupIdInt群组编号
      4.1.4cpuUseRatioBigDecimalcpu利用率
      4.1.5diskUseRatioBigDecimal硬盘利用率
      4.1.6memoryUseRatioBigDecimal内存利用率
      4.1.7rxbpsBigDecimal上行bandwith
      4.1.8txbpsBigDecimal下行bandwith
      4.1.9timestampLong统计时间

      2)出参示例

      • 成功:
      1. {
      2. "code": 0,
      3. "message": "success",
      4. "data": [
      5. {
      6. "id": 22078,
      7. "frontId": 1001,
      8. "cpuUseRatio": 10,
      9. "diskUseRatio": 89,
      10. "memoryUseRatio": 72,
      11. "rxbps": 21,
      12. "txbps": 21,
      13. "timestamp": 1588240650003
      14. }
      15. ],
      16. "totalCount": 502
      17. }
      • 失败:
      1. {
      2. "code": 102000,
      3. "message": "system exception",
      4. "data": {}