WeBASE-Data-Collect接口说明

    传输协议

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

    请求参数

    2）入参示例

    2.     "chainId": 1,
    3.     "chainName": "链一",
    4.     "encryptType": 0,
    5.     "description": "test"
    6. }

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3Object节点信息对象
    3.1chainIdInt否链编号
    3.2chainNameString否链名称
    3.3chainTypeInt否链类型（ 0-fisco 1-fabric）
    3.4encryptTypeInt否链加密类型（0-非国密，1-国密）
    3.5descriptionString是备注
    3.6createTimeLocalDateTime否落库时间
    3.7modifyTimeLocalDateTime否修改时间

    2）出参示例

    • 成功：
    1. {
    2.     "code": 0,
    3.     "message": "success",
    4.     "data": {
    5.         "chainId": 1,
    6.         "chainName": "链一",
    7.         "chainType": 0,
    8.         "encryptType": 0,
    9.         "description": "test"
    10.         "createTime": "2019-02-14 17:47:00",
    11.         "modifyTime": "2019-03-15 11:14:29"
    12.     }
    13. }
    • 失败：
    1. {
    2.     "code": 209001,
    3.     "message": "chain id already exists",
    4.     "data": {}
    5. }

    1.2 修改链信息

    传输协议

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

    请求参数

    1）入参表

    序号输入参数类型可为空备注
    1chainIdInt否链编号
    2chainNameString否链名称
    3descriptionString是备注

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/chain/update
    1. {
    2.     "chainId": 1,
    3.     "chainName": "链一",
    4.     "description": "test"
    5. }

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3Object节点信息对象
    3.1chainIdInt否链编号
    3.2chainNameString否链名称
    3.3chainTypeInt否链类型（ 0-fisco 1-fabric）
    3.4encryptTypeInt否链加密类型（0-非国密，1-国密）
    3.5descriptionString是备注
    3.6createTimeLocalDateTime否落库时间
    3.7modifyTimeLocalDateTime否修改时间

    2）出参示例

    • 成功：
    1. {
    2.     "code": 0,
    3.     "message": "success",
    4.     "data": {
    5.         "chainId": 1,
    6.         "chainName": "链一",
    7.         "chainType": 0,
    8.         "encryptType": 0,
    9.         "description": "test"
    10.         "createTime": "2019-02-14 17:47:00",
    11.         "modifyTime": "2019-03-15 11:14:29"
    12.     }
    13. }
    • 失败：
    1. {
    2.     "code": 209006,
    3.     "message": "chain id not exists",
    4.     "data": {}
    5. }

    1.3 获取链列表

    传输协议

    • 网络传输协议：使用HTTP协议
    • 请求地址：/chain/all
    • 请求方式：GET
    • 返回格式：JSON

    请求参数

    1）入参表

    无

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/chain/all

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3totalCountInt否总记录数
    4dataList否组织列表
    4.1Object节点信息对象
    4.1.1chainIdInt否链编号
    4.1.2chainNameString否链名称
    4.1.3chainTypeInt否链类型（ 0-fisco 1-fabric）
    4.1.4encryptTypeInt否链加密类型（0-非国密，1-国密）
    4.1.5descriptionString是备注
    4.1.6createTimeLocalDateTime否落库时间
    4.1.7modifyTimeLocalDateTime否修改时间

    2）出参示例

    • 成功：
    1. {
    2.     "code": 0,
    3.     "message": "success",
    4.     "data": [
    5.         {
    6.         "chainId": 1,
    7.         "chainName": "链一",
    8.         "chainType": 0,
    9.         "encryptType": 0,
    10.         "description": "test"
    11.         "createTime": "2019-02-14 17:47:00",
    12.         "modifyTime": "2019-03-15 11:14:29"
    13.         }
    14.     ],
    15.     "totalCount": 1
    16. }
    • 失败：
    1. {
    2.    "code": 109000,
    3.    "message": "system exception",
    4.    "data": {}
    5. }

    1.4 删除链信息

    传输协议

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

    请求参数

    1）入参表

    序号输入参数类型可为空备注
    1chainIdInt否链编号

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/chain/1

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3dataobject是返回信息实体（空）

    2）出参示例

    • 成功：
    1. {
    2.     "code": 0,
    3.     "data": {},
    4.     "message": "success"
    5. }
    • 失败：
    1. {
    2.     "code": 209004,
    3.     "message": "invalid chain id",
    4.     "data": {}
    5. }

    1.5 查询数据拉取开关

    传输协议

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

    请求参数

    1）入参表

    无

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/chain/togglePullData

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3dataobject是信息对象

    2）出参示例

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

    1.6 修改数据拉取开关

    传输协议

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

    请求参数

    1）入参表

    序号输入参数类型可为空备注
    1enableboolean否是否启用开关（true-开启；false-关闭）

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/chain/togglePullData
    1. {
    2.   "enable": false
    3. }

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3dataobject是信息对象

    2）出参示例

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

    2 前置管理模块

    2.1 新增节点前置

    传输协议

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

    请求参数

    1）入参表

    序号输入参数类型可为空备注
    1chainIdInt否链编号
    2frontIpString否前置ip
    3frontPortInt否前置服务端口
    4agencyInt否所属机构

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/front/new
    1. {
    2.     "chainId": 1,
    3.     "frontIp": "localhost",
    4.     "frontPort": "5002",
    5.     "agency": "test"
    6. }

    返回参数

    1）出参表

    序号输出参数类型可为空备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3Object节点信息对象
    3.1frontIdInt否前置编号
    3.2chainIdInt否链编号
    3.3frontIpString否前置ip
    3.4frontPortInt否前置端口
    3.5nodeIdString否节点编号
    3.6agencyString否所属机构
    3.7createTimeLocalDateTime是落库时间
    3.8modifyTimeLocalDateTime是修改时间

    2）出参示例

    • 成功：
    1. {
    2.   "code": 0,
    3.   "message": "success",
    4.   "data": {
    5.     "chainId": 1,
    6.     "frontId": 1,
    7.     "nodeId": "944607f7e83efe2ba72476dc39a269a910811db8caac34f440dd9c9dd8ec2490b8854b903bd6c9b95c2c79909649977b8e92097c2f3ec32232c4f655b5a01850",
    8.     "frontIp": "localhost",
    9.     "frontPort": 5002,
    10.     "agency": "test",
    11.     "createTime": null,
    12.     "modifyTime": null
    13.   }
    14. }
    • 失败：
    1. {
    2.     "code": 109000,
    3.     "message": "system exception",
    4.     "data": {}
    5. }

    传输协议

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

    请求参数

    序号输入参数类型可为空备注
    1chainIdInt是链编号
    2frontIdInt是前置编号
    3groupIdInt是群组编号

    2）入参示例

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3totalCountInt否总记录数
    4dataList否组织列表
    4.1Object节点信息对象
    4.1.1frontIdInt否前置编号
    4.1.2chainIdInt否链编号
    4.1.3frontIpString否前置ip
    4.1.4frontPortInt否前置端口
    4.1.5nodeIdString否节点编号
    4.1.6agencyString否所属机构
    4.1.7createTimeLocalDateTime否落库时间
    4.1.8modifyTimeLocalDateTime否修改时间

    2）出参示例

    • 成功：
    1. {
    2.   "code": 0,
    3.   "message": "success",
    4.   "data": [
    5.     {
    6.       "chainId": 1,
    7.       "frontId": 1,
    8.       "nodeId": "944607f7e83efe2ba72476dc39a269a910811db8caac34f440dd9c9dd8ec2490b8854b903bd6c9b95c2c79909649977b8e92097c2f3ec32232c4f655b5a01850",
    9.       "frontIp": "localhost",
    10.       "frontPort": 5002,
    11.       "agency": "test",
    12.       "createTime": "2020-05-20 20:22:35",
    13.       "modifyTime": "2020-05-20 20:22:35"
    14.     }
    15.   ],
    16.   "totalCount": 1
    17. }
    • 失败：
    1. {
    2.    "code": 109000,
    3.    "message": "system exception",
    4.    "data": {}
    5. }

    2.3 删除前置信息

    传输协议

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

    请求参数

    1）入参表

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/front/1

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3dataobject是返回信息实体（空）

    2）出参示例

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

    3.1 获取群组列表

    传输协议

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

    请求参数

    1）入参表

    序号输入参数类型可为空备注
    1chainIdInt否链编号

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/group/list/1

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3totalCountInt否总记录数
    4dataList否列表
    4.1Object信息对象
    4.1.1chainIdInt否链编号
    4.1.2groupIdInt否群组编号
    4.1.3appNameString否应用名称
    4.1.4appVersionString是应用版本号
    4.1.5appSummaryString是应用概要介绍
    4.1.6genesisBlockHashString否创世块hash
    4.1.7groupStatusInt否群组状态
    4.1.8nodeCountInt否节点个数
    4.1.9descriptionString否应用描述
    4.1.10createTimeLocalDateTime否落库时间
    4.1.11modifyTimeLocalDateTime否修改时间

    2）出参示例

    • 成功：
    1. {
    2.   "code": 0,
    3.   "message": "success",
    4.   "data": [
    5.     {
    6.       "chainId": 1,
    7.       "groupId": 1,
    8.       "appName": "APP1",
    9.       "appVersion": "v1.0.0",
    10.       "appSummary": "存证",
    11.       "genesisBlockHash": "0x7bc361d7d8e078ea9e8f352f2b856d6ea76ab1b9522f4b09853c861d0ed0779f",
    12.       "groupStatus": 1,
    13.       "nodeCount": 2,
    14.       "description": "test",
    15.       "createTime": "2020-05-20 20:22:35",
    16.       "modifyTime": "2020-05-20 20:31:38"
    17.     },
    18.     {
    19.       "chainId": 1,
    20.       "groupId": 2,
    21.       "appName": "APP2",
    22.       "appVersion": "v1.0.0",
    23.       "appSummary": "供应链",
    24.       "genesisBlockHash": "0x1208de0d47dcba9447d304039d1e4512dd4ce740ec408ef83c5f7ee2aefc7468",
    25.       "groupStatus": 1,
    26.       "nodeCount": 2,
    27.       "description": "test",
    28.       "createTime": "2020-05-20 20:22:36",
    29.       "modifyTime": "2020-05-20 20:31:38"
    30.     }
    31.   ],
    32.   "totalCount": 2
    33. }
    • 失败：
    1. {
    2.     "code": 109000,
    3.     "message": "system exception",
    4.     "data": {}
    5. }

    3.2 修改群组对应的应用信息

    传输协议

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

    请求参数

    1）入参表

    序号输入参数类型可为空备注
    1chainIdInt否链编号
    2groupIdInt否群组编号
    3appNameString是应用名称
    4appVersionString是应用版本号
    5appSummaryString是应用概要介绍
    6descriptionString是应用描述

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/group/update
    1. {
    2.     "chainId": 1,
    3.     "groupId": 1,
    4.     "appName": "存证",
    5.     "appVersion": "v1.0.0",
    6.     "appSummary": "存证测试",
    7.     "description": "这是一个存证应用"
    8. }

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3dataObject

    2）出参示例

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

    4 节点管理模块

    4.1 查询群组节点列表

    传输协议

    • 网络传输协议：使用HTTP协议
    • 请求地址：/node/list/{chainId}/{groupId}/{pageNumber}/{pageSize}
    • 请求方式：GET
    • 返回格式：JSON

    请求参数

    1）入参表

    序号输入参数类型可为空备注
    1chainIdInt否链编号
    2groupIdInt否群组编号
    3pageSizeInt否每页记录数
    4pageNumberInt否当前页码
    5nodeIdString是节点编号

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/node/nodeList/100001/300001/1/10

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3totalCountInt否总记录数
    4dataList是节点列表
    4.1Object节点信息对象
    4.1.1chainIdint否链编号
    4.1.2nodeIdString否节点编号
    4.1.3nodeNamestring否节点名称
    4.1.4groupIdint否所属群组编号
    4.1.5orgNamestring是机构名称
    4.1.6nodeActiveint否共识状态（1正常，2不正常）
    4.1.7nodeIpstring是节点ip
    4.1.8P2pPortint是节点p2p端口
    4.1.9descriptionString是备注
    4.1.10blockNumberBigInteger否节点块高
    4.1.11pbftViewBigInteger否Pbft view
    4.1.12createTimeLocalDateTime否落库时间
    4.1.13modifyTimeLocalDateTime否修改时间

    2）出参示例

    • 成功：
    1. {
    2.     "code": 0,
    3.     "message": "success",
    4.     "totalCount": 1,
    5.     "data": [
    6.         {
    7.             "chainId": 100001,
    8.             "nodeId": "78e467957af3d0f77e19b952a740ba8c53ac76913df7dbd48d7a0fe27f4c902b55e8543e1c4f65b4a61695c3b490a5e8584149809f66e9ffc8c05b427e9d3ca2,
    9.             "nodeName": "1_78e467957af3d0f77e19b952a740ba8c53ac76913df7dbd48d7a0fe27f4c902b55e8543e1c4f65b4a61695c3b490a5e8584149809f66e9ffc8c05b",
    10.             "groupId": 1,
    11.             "orgName": "org",
    12.             "nodeIp": "127.0.0.1",
    13.             "p2pPort": 10303,
    14.             "description": null,
    15.             "blockNumber": 133,
    16.             "pbftView": 5852,
    17.             "nodeActive": 1,
    18.             "createTime": "2019-02-14 17:47:00",
    19.             "modifyTime": "2019-03-15 11:14:29"
    20.         }
    21.     ]
    22. }
    • 失败：
    1. {
    2.     "code": 109000,
    3.     "message": "system exception",
    4.     "data": {}
    5. }

    4.2 查询机构节点列表

    传输协议

    • 网络传输协议：使用HTTP协议
    • 请求地址：/node/orgList/{chainId}/{pageNumber}/{pageSize}
    • 请求方式：GET
    • 返回格式：JSON

    请求参数

    1）入参表

    序号输入参数类型可为空备注
    1chainIdint否链编号
    2pageSizeInt否每页记录数
    3pageNumberInt否当前页码

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/node/orgList/100001/1/10

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3totalCountInt否总记录数
    4dataList是节点列表
    4.1Object节点信息对象
    4.1.1chainIdInt否链编号
    4.1.2nodeIdString否节点编号
    4.1.3orgNameString是机构名称
    4.1.4descriptionString是备注

    2）出参示例

    • 成功：
    1. {
    2.     "code": 0,
    3.     "message": "success",
    4.     "totalCount": 1,
    5.     "data": [
    6.         {
    7.             "chainId": 100001,
    8.             "nodeId": "78e467957af3d0f77e19b952a740ba8c53ac76913df7dbd48d7a0fe27f4c902b55e8543e1c4f65b4a61695c3b490a5e8584149809f66e9ffc8c05b427e9d3ca2,
    9.             "orgName": "org",
    10.             "description": "test"
    11.         }
    12.     ]
    13. }
    • 失败：
    1. {
    2.     "code": 109000,
    3.     "message": "system exception",
    4.     "data": {}
    5. }

    4.3 修改节点的机构信息

    传输协议

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

    请求参数

    1）入参表

    序号输入参数类型可为空备注
    1chainIdInt否链编号
    2nodeIdString否节点编号
    3orgNameString否机构名称
    4descriptionString是描述

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/node/update
    1. {
    2.     "chainId": 1,
    3.     "nodeId": "78e467957af3d0f77e19b952a740ba8c53ac76913df7dbd48d7a0fe27f4c902b55e8543e1c4f65b4a61695c3b490a5e8584149809f66e9ffc8c05b427e9d3ca2",
    4.     "orgName": "org",
    5.     "description": "test"
    6. }

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3dataObject

    2）出参示例

    • 成功：
    1. {
    2.     "code": 0,
    3.     "message": "success",
    4.     "data": null
    5. }
    1. {
    2.     "code": 109000,
    3.     "message": "system exception",
    4.     "data": {}
    5. }

    传输协议

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

    请求参数

    1）入参表

    序号输入参数类型可为空备注
    1chainIdInt否链编号
    2groupIdInt否群组编号
    3userNameString否用户名
    4addressString否用户地址
    5descriptionString是描述

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/user/add
    1. {
    2.   "address": "0x056a6b8bd27e861773ec2419a871ff245291a2d6",
    3.   "chainId": 1,
    4.   "description": "string",
    5.   "groupId": 1,
    6.   "userName": "alice"
    7. }

    返回参数

    序号输出参数类型可为空备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3Object节点信息对象
    3.1userIdInt否用户编号
    3.2chainIdInt否链编号
    3.3groupIdInt否群组编号
    3.2userNameString否用户名
    3.3addressString否用户地址
    3.4descriptionString是描述
    3.5createTimeLocalDateTime是落库时间
    3.6modifyTimeLocalDateTime是修改时间

    2）出参示例

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

    5.2 获取用户列表

    传输协议

    • 网络传输协议：使用HTTP协议
    • 请求地址：/user/list/{pageNumber}/{pageSize}?chainId={chainId}&groupId={groupId}&userParam={userParam}
    • 请求方式：GET
    • 返回格式：JSON

    请求参数

    1）入参表

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/user/list/1/2

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3totalCountInt否总记录数
    4dataList否列表
    4.1Object对象
    4.1.1userIdInt否用户编号
    4.1.2chainIdInt否链编号
    4.1.3groupIdInt否群组编号
    4.1.4userNameString否用户名
    4.1.5addressString否用户地址
    4.1.6descriptionString是描述
    4.1.7createTimeLocalDateTime否落库时间
    4.1.8modifyTimeLocalDateTime否修改时间

    2）出参示例

    • 成功：
    1. {
    2.   "code": 0,
    3.   "message": "success",
    4.   "data": [
    5.     {
    6.       "userId": 1,
    7.       "chainId": 1,
    8.       "groupId": 1,
    9.       "userName": "alice",
    11.       "description": "test",
    12.       "createTime": "2020-06-02 20:35:20",
    13.       "modifyTime": "2020-06-02 20:35:20"
    14.     }
    15.   ],
    16.   "totalCount": 1
    17. }
    • 失败：
    1. {
    2.    "code": 109000,
    3.    "message": "system exception",
    4.    "data": {}
    5. }

    5.3 删除用户

    传输协议

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

    请求参数

    1）入参表

    序号输入参数类型可为空备注
    1userIdInt否用户编号

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/user/1

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3dataobject是返回信息实体（空）

    2）出参示例

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

    6 合约管理模块

    6.1 保存合约和更新

    传输协议

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

    请求参数

    1）入参表

    序号输入参数类型可为空备注
    1chainIdInt否链编号
    2groupIdInt否群组编号
    3contractNameString否合约名称
    4contractSourceString是合约源码，Base64编码
    5contractAbiString是编译合约生成的abi文件内容
    6runtimeBinString是合约运行时binary，用于合约解析
    7bytecodeBinString是合约bytecode binary，用于部署合约
    8contractIdString是合约编号（为空时表示新增，不为空表示更新）
    9contractPathString否合约所在目录

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/contract/save
    1. {
    2.   "bytecodeBin": "608060405234801561001057600080fd5b50610373806100206000396000f30060806040526004361061004c576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff168063299f7f9d146100515780633590b49f146100e1575b600080fd5b34801561005d57600080fd5b5061006661014a565b6040518080602001828103825283818151815260200191508051906020019080838360005b838110156100a657808201518184015260208101905061008b565b50505050905090810190601f1680156100d35780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b3480156100ed57600080fd5b50610148600480360381019080803590602001908201803590602001908080601f01602080910402602001604051908101604052809392919081815260200183838082843782019150505050505091929192905050506101ec565b005b606060008054600181600116156101000203166002900480601f0160208091040260200160405190810160405280929190818152602001828054600181600116156101000203166002900480156101e25780601f106101b7576101008083540402835291602001916101e2565b820191906000526020600020905b8154815290600101906020018083116101c557829003601f168201915b5050505050905090565b7f05432a43e07f36a8b98100b9cb3631e02f8e796b0a06813610ce8942e972fb81816040518080602001828103825283818151815260200191508051906020019080838360005b8381101561024e578082015181840152602081019050610233565b50505050905090810190601f16801561027b5780820380516001836020036101000a031916815260200191505b509250505060405180910390a1806000908051906020019061029e9291906102a2565b5050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106102e357805160ff1916838001178555610311565b82800160010185558215610311579182015b828111156103105782518255916020019190600101906102f5565b5b50905061031e9190610322565b5090565b61034491905b80821115610340576000816000905550600101610328565b5090565b905600a165627a7a72305820cff924cb0783dc84e2e107aae1fd09e1e04154b80834c9267a4eaa630997b2b90029",
    3.   "chainId": 1,
    4.   "contractAbi": "[{\"constant\":true,\"inputs\":[],\"name\":\"get\",\"outputs\":[{\"name\":\"\",\"type\":\"string\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"n\",\"type\":\"string\"}],\"name\":\"set\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"name\",\"type\":\"string\"}],\"name\":\"SetName\",\"type\":\"event\"}]",
    5.   "runtimeBin": "xxx",
    6.   "contractName": "HelloWorld",
    7.   "contractPath": "/",
    8.   "contractSource": "cHJhZ21hIHNvbGlkaXR5IF4wLjQuMjsNCmNvbnRyYWN0IEhlbGxvV29ybGR7DQogICAgc3RyaW5nIG5hbWU7DQogICAgZXZlbnQgU2V0TmFtZShzdHJpbmcgbmFtZSk7DQogICAgZnVuY3Rpb24gZ2V0KCljb25zdGFudCByZXR1cm5zKHN0cmluZyl7DQogICAgICAgIHJldHVybiBuYW1lOw0KICAgIH0NCiAgICBmdW5jdGlvbiBzZXQoc3RyaW5nIG4pew0KICAgICAgICBlbWl0IFNldE5hbWUobik7DQogICAgICAgIG5hbWU9bjsNCiAgICB9DQp9",
    9.   "groupId": 1
    10. }

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3Object返回信息实体
    3.1contractIdInt否合约编号
    3.2contractPathString否合约所在目录
    3.3contractNameString否合约名称
    3.4chainIdInt否链编号
    3.5groupIdInt否群组编号
    3.6contractTypeInt否合约类型(0-普通合约，1-系统合约，默认0)
    3.7contractSourceString否合约源码
    3.8contractAbiString是编译合约生成的abi文件内容
    3.9runtimeBinString是合约运行时binary，用于合约解析
    3.10bytecodeBinString是合约bytecode binary，用于部署合约
    3.11descriptionString是备注
    3.12createTimeLocalDateTime否创建时间
    3.13modifyTimeLocalDateTime是修改时间

    2）出参示例

    • 成功：
    1. {
    2.   "code": 0,
    3.   "message": "success",
    4.   "data": {
    5.     "contractId": 1,
    6.     "chainId": 1,
    7.     "groupId": 1,
    8.     "contractType": 0,
    9.     "contractPath": "/",
    10.     "contractName": "HelloWorld",
    11.     "contractSource": "cHJhZ21hIHNvbGlkaXR5IF4wLjQuMjsNCmNvbnRyYWN0IEhlbGxvV29ybGR7DQogICAgc3RyaW5nIG5hbWU7DQogICAgZXZlbnQgU2V0TmFtZShzdHJpbmcgbmFtZSk7DQogICAgZnVuY3Rpb24gZ2V0KCljb25zdGFudCByZXR1cm5zKHN0cmluZyl7DQogICAgICAgIHJldHVybiBuYW1lOw0KICAgIH0NCiAgICBmdW5jdGlvbiBzZXQoc3RyaW5nIG4pew0KICAgICAgICBlbWl0IFNldE5hbWUobik7DQogICAgICAgIG5hbWU9bjsNCiAgICB9DQp9",
    12.     "contractAbi": "[{\"constant\":true,\"inputs\":[],\"name\":\"get\",\"outputs\":[{\"name\":\"\",\"type\":\"string\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"n\",\"type\":\"string\"}],\"name\":\"set\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"name\",\"type\":\"string\"}],\"name\":\"SetName\",\"type\":\"event\"}]",
    13.     "runtimeBin": "xxx",
    14.     "bytecodeBin": "608060405234801561001057600080fd5b50610373806100206000396000f30060806040526004361061004c576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff168063299f7f9d146100515780633590b49f146100e1575b600080fd5b34801561005d57600080fd5b5061006661014a565b6040518080602001828103825283818151815260200191508051906020019080838360005b838110156100a657808201518184015260208101905061008b565b50505050905090810190601f1680156100d35780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b3480156100ed57600080fd5b50610148600480360381019080803590602001908201803590602001908080601f01602080910402602001604051908101604052809392919081815260200183838082843782019150505050505091929192905050506101ec565b005b606060008054600181600116156101000203166002900480601f0160208091040260200160405190810160405280929190818152602001828054600181600116156101000203166002900480156101e25780601f106101b7576101008083540402835291602001916101e2565b820191906000526020600020905b8154815290600101906020018083116101c557829003601f168201915b5050505050905090565b7f05432a43e07f36a8b98100b9cb3631e02f8e796b0a06813610ce8942e972fb81816040518080602001828103825283818151815260200191508051906020019080838360005b8381101561024e578082015181840152602081019050610233565b50505050905090810190601f16801561027b5780820380516001836020036101000a031916815260200191505b509250505060405180910390a1806000908051906020019061029e9291906102a2565b5050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106102e357805160ff1916838001178555610311565b82800160010185558215610311579182015b828111156103105782518255916020019190600101906102f5565b5b50905061031e9190610322565b5090565b61034491905b80821115610340576000816000905550600101610328565b5090565b905600a165627a7a72305820cff924cb0783dc84e2e107aae1fd09e1e04154b80834c9267a4eaa630997b2b90029",
    15.     "description": null,
    16.     "createTime": "2020-06-02 20:50:58",
    17.     "modifyTime": "2020-06-02 20:50:58"
    18.   }
    19. }
    • 失败：
    1. {
    2.     "code": 109000,
    3.     "message": "system exception",
    4.     "data": {}
    5. }

    6.2 查询合约列表

    传输协议

    • 网络传输协议：使用HTTP协议
    • 请求地址：/contract/list
    • 请求方式：POST
    • 返回格式：JSON

    请求参数

    1）入参表

    序号输入参数类型可为空备注
    1chainIdInt否链编号
    2groupIdInt否群组id
    3contractNameString是合约名
    4pageSizeInt是每页记录数
    5pageNumberInt是当前页码

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/contract/list
    1. {
    2.   "chainId": 1,
    3.   "groupId": 1,
    4.   "pageNumber": 1,
    5.   "pageSize": 2
    6. }

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3totalCountInt否总记录数
    4dataList是列表
    5.1Object返回信息实体
    5.1.1contractIdInt否合约编号
    5.1.2contractPathString否合约所在目录
    5.1.3contractNameString否合约名称
    5.1.4chainIdInt否链编号
    5.1.5groupIdInt否群组编号
    5.1.6contractTypeInt否合约类型(0-普通合约，1-系统合约)
    5.1.7contractSourceString否合约源码
    5.1.8contractAbiString是编译合约生成的abi文件内容
    5.1.9runtimeBinString是合约运行时binary，用于合约解析
    5.1.10bytecodeBinString是合约bytecode binary，用于部署合约
    5.1.11descriptionString是备注
    5.1.12createTimeLocalDateTime否创建时间
    5.1.13modifyTimeLocalDateTime是修改时间

    2）出参示例

    • 成功：
    1. {
    2.   "code": 0,
    3.   "message": "success",
    4.   "data": [
    5.     {
    6.       "contractId": 1,
    7.       "chainId": 1,
    8.       "groupId": 1,
    9.       "contractPath": "/",
    10.       "contractName": "HelloWorld",
    11.       "contractSource": "cHJhZ21hIHNvbGlkaXR5IF4wLjQuMjsNCmNvbnRyYWN0IEhlbGxvV29ybGR7DQogICAgc3RyaW5nIG5hbWU7DQogICAgZXZlbnQgU2V0TmFtZShzdHJpbmcgbmFtZSk7DQogICAgZnVuY3Rpb24gZ2V0KCljb25zdGFudCByZXR1cm5zKHN0cmluZyl7DQogICAgICAgIHJldHVybiBuYW1lOw0KICAgIH0NCiAgICBmdW5jdGlvbiBzZXQoc3RyaW5nIG4pew0KICAgICAgICBlbWl0IFNldE5hbWUobik7DQogICAgICAgIG5hbWU9bjsNCiAgICB9DQp9",
    12.       "contractAbi": "[{\"constant\":true,\"inputs\":[],\"name\":\"get\",\"outputs\":[{\"name\":\"\",\"type\":\"string\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"n\",\"type\":\"string\"}],\"name\":\"set\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"name\",\"type\":\"string\"}],\"name\":\"SetName\",\"type\":\"event\"}]",
    13.       "runtimeBin": "xxx",
    14.       "bytecodeBin": "608060405234801561001057600080fd5b50610373806100206000396000f30060806040526004361061004c576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff168063299f7f9d146100515780633590b49f146100e1575b600080fd5b34801561005d57600080fd5b5061006661014a565b6040518080602001828103825283818151815260200191508051906020019080838360005b838110156100a657808201518184015260208101905061008b565b50505050905090810190601f1680156100d35780820380516001836020036101000a031916815260200191505b509250505060405180910390f35b3480156100ed57600080fd5b50610148600480360381019080803590602001908201803590602001908080601f01602080910402602001604051908101604052809392919081815260200183838082843782019150505050505091929192905050506101ec565b005b606060008054600181600116156101000203166002900480601f0160208091040260200160405190810160405280929190818152602001828054600181600116156101000203166002900480156101e25780601f106101b7576101008083540402835291602001916101e2565b820191906000526020600020905b8154815290600101906020018083116101c557829003601f168201915b5050505050905090565b7f05432a43e07f36a8b98100b9cb3631e02f8e796b0a06813610ce8942e972fb81816040518080602001828103825283818151815260200191508051906020019080838360005b8381101561024e578082015181840152602081019050610233565b50505050905090810190601f16801561027b5780820380516001836020036101000a031916815260200191505b509250505060405180910390a1806000908051906020019061029e9291906102a2565b5050565b828054600181600116156101000203166002900490600052602060002090601f016020900481019282601f106102e357805160ff1916838001178555610311565b82800160010185558215610311579182015b828111156103105782518255916020019190600101906102f5565b5b50905061031e9190610322565b5090565b61034491905b80821115610340576000816000905550600101610328565b5090565b905600a165627a7a72305820cff924cb0783dc84e2e107aae1fd09e1e04154b80834c9267a4eaa630997b2b90029",
    15.       "contractType": 0,
    16.       "description": null,
    17.       "createTime": "2020-06-02 20:50:58",
    18.       "modifyTime": "2020-06-02 20:50:58"
    19.     }
    20.   ],
    21.   "totalCount": 1
    22. }
    • 失败：
    1. {
    2.     "code": 109000,
    3.     "message": "system exception",
    4.     "data": {}
    5. }

    6.3 删除合约

    传输协议

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

    请求参数

    1）入参表

    序号输入参数类型可为空备注
    1contractIdInt否合约编号

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/contract/1

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3dataobject是返回信息实体（空）

    2）出参示例

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

    6.4 保存合约方法信息

    传输协议

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

    请求参数

    1）入参表

    序号输入参数类型可为空备注
    1contractIdInt否合约编号
    2methodListList否方法列表
    2.1Object否方法实体
    2.1.1methodIdString否方法编号
    2.1.2methodNameString否方法名
    2.1.4methodTypeString否方法类型

    2）入参示例

    1. http://127.0.0.1:5009/WeBASE-Data-Collect/contract/addMethod
    1. {
    2.   "contractId": 2,
    3.   "methodList": [
    4.     {
    5.       "methodId": "0x3590b49f",
    6.       "methodName": "set",
    7.       "methodType": "function"
    8.     }，
    9.     {
    10.       "methodId": "0x9bd13510",
    11.       "methodName": "get",
    12.       "methodType": "function"
    13.     }
    14.   ]
    15. }

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3dataobject是返回信息实体（空）

    2）出参示例

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

    传输协议

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

    请求参数

    1）入参表

    序号输入参数类型可为空备注
    1encryptTypeInt是类型（0-ecdsa；1-guomi）

    2）入参示例

    1. http://localhost:5009/WeBASE-Data-Collect/solc/list

    返回参数

    1）出参表

    序号输出参数类型备注
    1codeInt否返回码，0：成功 其它：失败
    2messageString否描述
    3totalCountInt否总记录数
    4dataList否列表
    4.1Object对象
    4.1.1idInt否编号
    4.1.2solcNameInt否编译器文件名
    4.1.3encryptTypeInt否类型
    4.1.4md5String否md5值
    4.1.5fileSizeLong否文件长度
    4.1.6descriptionString是描述
    4.1.7createTimeLocalDateTime否落库时间
    4.1.8modifyTimeLocalDateTime否修改时间

    2）出参示例

    1. {
    2.   "code": 0,
    3.   "message": "success",
    4.   "data": [
    5.     {
    6.       "id": 1,
    7.       "solcName": "soljson-v0.4.25-gm.js",
    8.       "encryptType": 1,
    9.       "md5": "c0810103136fb9177df943346b2dcad4",
    10.       "fileSize": 8273598,
    11.       "description": "guomi",
    12.       "createTime": "2020-06-14 11:05:56",
    13.       "modifyTime": "2020-06-14 11:05:56"
    14.     },
    15.     {
    16.       "id": 2,
    17.       "solcName": "soljson-v0.4.25+commit.59dbf8f1.js",
    18.       "encryptType": 0,
    19.       "md5": "e201c5913e0982cb90cdb2a711e36f63",
    20.       "fileSize": 8276063,
    21.       "description": "ecdsa",
    22.       "createTime": "2020-06-14 11:19:10",
    23.       "modifyTime": "2020-06-14 11:19:10"
    24.     }

    附录

    1. 返回码信息列表