WeBASE-Data-Fetcher接口说明

1 区块链管理模块

1.1 全量数据概览

传输协议

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

请求参数

1）入参表

无

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/chain/general

返回参数

1）出参表

序号输出参数类型备注
1codeInt否返回码，0：成功 其它：失败
2messageString否描述
3dataobject否返回信息实体
2.1chainCountInt是链数量
2.2groupCountint否群组数量
2.3blockCountint否区块数量
2.4txnCountint否交易数量
2.5userCountint否用户数量
2.6contractCountint否合约数量

2）出参示例

  • 成功：
  1. {
  2.   "code": 0,
  3.   "message": "success",
  4.   "data": {
  5.     "chainCount": 1,
  6.     "groupCount": 2,
  7.     "blockCount": 360,
  8.     "txnCount": 360,
  9.     "userCount": 28,
  10.     "contractCount": 77
  11.   }
  12. }
  • 失败：
  1. {
  2.    "code": 110000,
  3.    "message": "system exception",
  4.    "data": {}
  5. }

1.2 查询链列表

传输协议

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

请求参数

1）入参表

无

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/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": 110000,
  3.    "message": "system exception",
  4.    "data": {}
  5. }

2 群组管理模块

2.1 查询群组列表

传输协议

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

请求参数

1）入参表

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

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/group/list?chainId=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": 110000,
  3.     "message": "system exception",
  4.     "data": {}
  5. }

2.2 查询群组概况

传输协议

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

请求参数

1）入参表

序号输入参数类型可为空备注
1chainIdInt否链编号
2groupIdint否群组id

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/group/general/1/1

返回参数

1）出参表

序号输出参数类型备注
1codeInt否返回码，0：成功 其它：失败
2messageString否描述
3dataobject否返回信息实体
2.1chainIdInt是链编号
2.2groupIdint否群组id
2.3nodeCountint否节点数量
2.4userCountint否用户数量
2.5contractCountint否已部署智能合约数量
2.6txnCountint否交易数量
2.7blockNumberint否当前块高

2）出参示例

  • 成功：
  1. {
  2.   "code": 0,
  3.   "message": "success",
  4.   "data": {
  5.     "chainId": 1,
  6.     "groupId": 1,
  7.     "nodeCount": 3,
  8.     "userCount": 22,
  9.     "contractCount": 58,
  10.     "txnCount": 237,
  11.     "blockNumber": 237
  12.   }
  13. }
  • 失败：
  1. {
  2.     "code": 110000,
  3.     "message": "system exception",
  4.     "data": {}
  5. }

2.3 查询近七日交易数据

传输协议

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

请求参数

1）入参表

序号输入参数类型可为空备注
1chainIdInt否链编号
2groupIdint否群组id

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/group/txnDaily/1/1

返回参数

1）出参表

序号输出参数类型备注
1codeInt否返回码，0：成功 其它：失败
2messageString否描述
3datalist否返回信息列表
4object返回信息实体
4.1statDatestring否日期YYYY-MM-DD
4.2chainIdInt是链编号
4.3groupIdint否群组编号
4.4txnint否交易数量

2）出参示例

  • 成功：
  1. {
  2.     "code": 0,
  3.     "data": [
  4.         {
  5.             "statDate": "2018-11-22",
  6.             "chainId": "1",
  7.             "groupId": "1",
  8.             "txn": 10
  9.         },
  10.         {
  11.             "statDate": "2018-11-21",
  12.             "chainId": "1",
  13.             "groupId": "1",
  14.             "txn": 5
  15.         }
  16.     ],
  17.     "message": "Success"
  18. }
  • 失败：
  1. {
  2.     "code": 110000,
  3.     "message": "system exception",
  4.     "data": {}
  5. }

2.4 查询群组节点列表

传输协议规范

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

请求参数

1）入参表

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

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/group/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": 110000,
  3.     "message": "system exception",
  4.     "data": {}
  5. }

2.5 查询机构节点列表

传输协议

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

请求参数

1）入参表

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

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/group/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": 110000,
  3.     "message": "system exception",
  4.     "data": {}
  5. }

2.6 查询区块列表

传输协议

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

请求参数

1）入参表

序号输入参数类型可为空备注
1chainIdInt否链编号
2groupIdInt否群组编号
3pageSizeInt否每页记录数
4pageNumberInt否当前页码
5blockHashString是区块hash
6blockNumberBigInteger是块高

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/group/blockList/1/1/1/2?blockHash=

返回参数

1）出参表

序号输出参数类型备注
1codeInt否返回码，0：成功 其它：失败
2messageString否描述
3totalCountInt否总记录数
4dataList是区块列表
4.1Object区块信息对象
4.1.1blockHashString否块hash
4.1.2blockNumberBigInteger否块高
4.1.3blockTimestampLocalDateTime否出块时间
4.1.4transCountInt否交易数
4.1.5sealerIndexInt否打包节点索引
4.1.6sealerString否打包节点
4.1.7blockDetailString否区块详情
4.1.8createTimeLocalDateTime否创建时间
4.1.9modifyTimeLocalDateTime否修改时间

2）出参示例

  • 成功：
  1. {
  2.   "code": 0,
  3.   "message": "success",
  4.   "data": [
  5.     {
  6.       "id": 26,
  7.       "blockHash": "0x1d0a57a6ee2b73e537ef6d929c8d0bdb2a9799dd6357f04dc5f38e4e0c6c5ac2",
  8.       "blockNumber": 35,
  9.       "blockTimestamp": "2020-05-13 19:47:37",
  10.       "transCount": 1,
  11.       "sealerIndex": 0,
  12.       "sealer": "944607f7e83efe2ba72476dc39a269a910811db8caac34f440dd9c9dd8ec2490b8854b903bd6c9b95c2c79909649977b8e92097c2f3ec32232c4f655b5a01850",
  13.       "blockDetail": "",
  14.       "createTime": "2020-05-20 20:22:41",
  15.       "modifyTime": "2020-05-20 20:22:41"
  16.     },
  17.     {
  18.       "id": 8,
  19.       "blockHash": "0x4c29bb921f4bf346ad1f92704e225f6323c85f16f2fa4eb0e3f126355ff9fa12",
  20.       "blockNumber": 34,
  21.       "blockTimestamp": "2020-05-13 19:12:20",
  22.       "transCount": 1,
  23.       "sealerIndex": 0,
  24.       "sealer": "944607f7e83efe2ba72476dc39a269a910811db8caac34f440dd9c9dd8ec2490b8854b903bd6c9b95c2c79909649977b8e92097c2f3ec32232c4f655b5a01850",
  25.       "blockDetail": "",
  26.       "createTime": "2020-05-20 20:22:41",
  27.       "modifyTime": "2020-05-20 20:22:41"
  28.     }
  29.   ],
  30.   "totalCount": 36
  31. }
  • 失败：
  1. {
  2.     "code": 110000,
  3.     "message": "system exception",
  4.     "data": {}
  5. }

2.7 查询交易列表

传输协议

  • 网络传输协议：使用HTTP协议
  • 请求地址：
  1. /group/transList/{chainId}/{groupId}/{pageNumber}/{pageSize}?transHash={transHash}&blockNumber={blockNumber}
  • 请求方式：GET
  • 返回格式：JSON

请求参数

1）入参表

序号输入参数类型可为空备注
1chainIdInt否链编号
2groupIdInt否群组编号
3pageNumberInt否当前页码
4pageSizeInt否每页记录数
5transHashString是交易hash
6blockNumberBigInteger是块高

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/group/transList/1/1/1/2?transHash=0x4933b1e0a7d6913a2179b879cdf716096d8da1c162fe400a492b0d61259e2ab2

返回参数

1）出参表

序号输出参数类型备注
1codeInt否返回码，0：成功 其它：失败
2messageString否描述
3totalCountInt否总记录数
4dataList否交易信息列表
4.1Object交易信息对象
4.1.1transHashString否交易hash
4.1.2blockNumberBigInteger否所属块高
4.1.3blockTimestampLocalDateTime否所属块出块时间
4.1.4transDetailString否交易详情
4.1.5receiptDetailString否交易回执详情
4.1.6auditFlagInt否是否已统计（1-未审计，2-已审计）
4.1.7createTimeLocalDateTime否落库时间
4.1.8modifyTimeLocalDateTime否修改时间

2）出参示例

  • 成功：
  1. {
  2.   "code": 0,
  3.   "message": "success",
  4.   "data": [
  5.     {
  6.       "id": 26,
  7.       "transHash": "0x4933b1e0a7d6913a2179b879cdf716096d8da1c162fe400a492b0d61259e2ab2",
  8.       "blockNumber": 35,
  9.       "blockTimestamp": "2020-05-13 19:47:37",
  10.       "transDetail": "{}",
  11.       "receiptDetail": "{}",
  12.       "auditFlag": 1,
  13.       "createTime": "2020-05-20 20:22:41",
  14.       "modifyTime": "2020-05-20 20:22:41"
  15.     }
  16.   ],
  17.   "totalCount": 1
  18. }
  • 失败：
  1. {
  2.     "code": 110000,
  3.     "message": "system exception",
  4.     "data": {}
  5. }

2.8 查询用户列表

传输协议

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

请求参数

1）入参表

序号输入参数类型可为空备注
1pageNumberInt否当前页码
2pageSizeInt否每页记录数
3chainIdInt否链编号
4groupIdInt否群组编号
5userParamString是参数，用户名或地址

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/group/userList/1/1/1/2

返回参数

1）出参表

序号输出参数类型备注
1codeInt否返回码，0：成功 其它：失败
2messageString否描述
3totalCountInt否总记录数
4dataList否列表
4.1Object对象
4.1.1userNameString否用户名
4.1.2userAddressString否用户地址

2）出参示例

  • 成功：
  1. {
  2.   "code": 0,
  3.   "message": "success",
  4.   "data": [
  5.     {
  6.       "userName": "alice",
  7.       "userAddress": "0x056a6b8bd27e861773ec2419a871ff245291a2d6"
  8.     }
  9.   ],
  10.   "totalCount": 1
  11. }
  • 失败：
  1. {
  2.    "code": 110000,
  3.    "message": "system exception",
  4.    "data": {}
  5. }

2.9 查询合约列表

传输协议

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

请求参数

1）入参表

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

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/group/contractList/1/1/1/2

返回参数

1）出参表

序号输出参数类型备注
1codeInt否返回码，0：成功 其它：失败
2messageString否描述
3totalCountInt否总记录数
4dataList是列表
5.1Object返回信息实体
5.1.1contractNameString否合约名称
5.1.2contractAddressString否合约地址
5.1.3contractAbiString是合约abi文件内容

2）出参示例

  • 成功：
  1. {
  2.   "code": 0,
  3.   "message": "success",
  4.   "data": [
  5.     {
  6.       "contractName": "ConsensusPrecompiled",
  7.       "contractAddress": "0x0000000000000000000000000000000000001003",
  8.       "contractAbi": "[{\"constant\":false,\"inputs\":[{\"name\":\"nodeID\",\"type\":\"string\"}],\"name\":\"addObserver\",\"outputs\":[{\"name\":\"\",\"type\":\"int256\"}],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"nodeID\",\"type\":\"string\"}],\"name\":\"remove\",\"outputs\":[{\"name\":\"\",\"type\":\"int256\"}],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"nodeID\",\"type\":\"string\"}],\"name\":\"addSealer\",\"outputs\":[{\"name\":\"\",\"type\":\"int256\"}],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"}]"
  9.     }
  10.   ],
  11.   "totalCount": 1
  12. }
  • 失败：
  1. {
  2.     "code": 110000,
  3.     "message": "system exception",
  4.     "data": {}
  5. }

3 数据检索模块

3.1 普通检索

传输协议

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

请求参数

1）入参表

序号输入参数类型可为空备注
1chainIdInt否链编号
2groupIdInt否群组编号
3pageSizeInt否每页记录数
4pageNumberInt否当前页码
5searchTypeInt否检索类型：1-区块；2-交易；3-用户；4-合约
6blockParamString是块高或区块Hash，检索类型为1时必填
7transHashString是交易Hash，检索类型为2时必填
8userParamString是用户名称或地址，检索类型为3时必填
9contractParamString是合约名称或地址，检索类型为4时必填

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/search/normal
  1. {
  2.     "chainId": 1,
  3.     "groupId": 1,
  4.     "pageSize": 1,
  5.     "pageNumber": 1,
  6.     "searchType": 2,
  7.     "transHash": "0x16dafe7f879f13d5fca6046e87022cdf71c9076b90c90b12403b82e1b68d3a22"
  8. }

返回参数

1）出参表

序号输出参数类型备注
1codeInt否返回码，0：成功 其它：失败
2messageString否描述
3totalCountInt否总记录数
4dataList是区块列表
4.1Object区块信息对象
4.1.1transHashString否块hash
4.1.2blockNumberBigInteger否块高
4.1.3blockTimestampLocalDateTime否出块时间
4.1.4userNameString否用户名称
4.1.5userAddressString否用户地址
4.1.6userTypeInt否用户类型(0-正常，1-异常)
4.1.7contractNameString否合约名称
4.1.8contractAddressString否合约地址
4.1.9interfaceNameString否合约接口名
4.1.10transTypeInt否交易类型(0-合约部署，1-接口调用)
4.1.11transParserTypeInt否交易解析类型(0-正常，1-异常合约，2-异常接口)
4.1.12inputString是交易输入信息
4.1.13outputString是交易输出信息
4.1.14logsString是交易event信息
4.1.15transDetailString是交易详情
4.1.16receiptDetailString是交易回执详情
4.1.17createTimeLocalDateTime否创建时间
4.1.18modifyTimeLocalDateTime否修改时间

2）出参示例

  • 成功：
  1. {
  2.   "code": 0,
  3.   "message": "success",
  4.   "data": [
  5.     {
  6.       "transHash": "0x16dafe7f879f13d5fca6046e87022cdf71c9076b90c90b12403b82e1b68d3a22",
  7.       "blockNumber": 35,
  8.       "blockTimestamp": "2020-05-13 19:47:37",
  9.       "userName": "alice",
  10.       "userAddress": "0x7939e26070be44e6c4fc759ce55c6c8b166d94be",
  11.       "userType": 0,
  12.       "contractName": "HelloWorld",
  13.       "contractAddress": "0x970d7d42726e8f1069f6d9aa0aca10e950fcebf9",
  14.       "interfaceName": "set(string)",
  15.       "transType": 1,
  16.       "transParserType": 0,
  17.       "input":"[{\"name\":\"n\",\"type\":\"string\",\"data\":\"test\"}]",
  18.       "output":"",
  19.       "logs":"{\"SetName(string)\":[[{\"name\":\"name\",\"type\":\"string\",\"data\":\"test\",\"indexed\":false}]]}",
  20.       "transDetail":"{}",
  21.       "receiptDetail":"{}",
  22.       "createTime": "2020-05-20 20:22:41",
  23.       "modifyTime": "2020-05-20 20:22:41"
  24.     }
  25.   ],
  26.   "totalCount": 1
  27. }
  • 失败：
  1. {
  2.     "code": 110000,
  3.     "message": "system exception",
  4.     "data": {}
  5. }

3.2 关键字检索

传输协议

  • 网络传输协议：使用HTTP协议
  • 请求地址：/search/keyword/{pageNumber}/{pageSize}?keyword={keyword}
  • 请求方式：GET
  • 返回格式：JSON

请求参数

1）入参表

序号输入参数类型可为空备注
1pageSizeInt否每页记录数
2pageNumberInt否当前页码
3keywordString否要检索的关键字

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/search/keyword/1/2?keyword="测试"

返回参数

1）出参表

序号输出参数类型备注
1codeInt否返回码，0：成功 其它：失败
2messageString否描述
3totalCountInt否总记录数
4dataList是区块列表
4.1Object区块信息对象
4.1.1transHashString否块hash
4.1.2blockNumberBigInteger否块高
4.1.3blockTimestampLocalDateTime否出块时间
4.1.4userNameString否用户名称
4.1.5userAddressString否用户地址
4.1.6userTypeInt否用户类型(0-正常，1-异常)
4.1.7contractNameString否合约名称
4.1.8contractAddressString否合约地址
4.1.9interfaceNameString否合约接口名
4.1.10transTypeInt否交易类型(0-合约部署，1-接口调用)
4.1.11transParserTypeInt否交易解析类型(0-正常，1-异常合约，2-异常接口)
4.1.12inputString是交易输入信息
4.1.13outputString是交易输出信息
4.1.14logsString是交易event信息
4.1.15chainIdInt否链编号
4.1.16groupIdInt否群组编号
4.1.17createTimeLocalDateTime否创建时间
4.1.18modifyTimeLocalDateTime否修改时间

2）出参示例

  • 成功：
  1. {
  2.   "code": 0,
  3.   "message": "success",
  4.   "data": [
  5.     {
  6.       "transParserType": 0,
  7.       "transHash": "0xd33a6343ecee98cd6804456d34299d893258e5e3ebc2b8d6d57dc1fdc9a34b43",
  8.       "groupId": 1,
  9.       "contractAddress": "0x513657158171fc69017b52ea997bdf49cd0260ba",
  10.       "userName": "bob",
  11.       "userAddress": "0x7939e26070be44e6c4fc759ce55c6c8b166d94be",
  12.       "output": null,
  13.       "input": "[{\"name\":\"n\",\"type\":\"string\",\"data\":\"试验\"}]",
  14.       "modifyTime": "2020-07-14 17:51:26",
  15.       "transType": 1,
  16.       "chainId": 1,
  17.       "createTime": "2020-07-14 17:51:26",
  18.       "blockNumber": 312,
  19.       "contractName": "HelloWorld",
  20.       "blockTimestamp": "2020-07-14 17:51:12",
  21.       "id": 312,
  22.       "userType": 0,
  23.       "interfaceName": "set(string)",
  24.       "logs": "{\"SetName(string)\":[[{\"name\":\"name\",\"type\":\"string\",\"data\":\"试验\",\"indexed\":false}]]}"
  25.     }
  26.   ],
  27.   "totalCount": 1
  28. }
  • 失败：
  1. {
  2.     "code": 110000,
  3.     "message": "system exception",
  4.     "data": {}
  5. }

4 关键字管理模块

4.1 新增关键字

传输协议

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

请求参数

1）入参表

序号输入参数类型可为空备注
1keywordString否关键字

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/keywords/add
  1. {
  2.   "keyword": "禽流感"
  3. }

返回参数

1）出参表

序号输出参数类型可为空备注
1codeInt否返回码，0：成功 其它：失败
2messageString否描述
3dataObject信息对象
3.1idInt否编号
3.2keywordString否关键字
3.3createTimeLocalDateTime是落库时间
3.2modifyTimeLocalDateTime是修改时间

2）出参示例

  • 成功：
  1. {
  2.   "code": 0,
  3.   "message": "success",
  4.   "data": {
  5.     "id": 1,
  6.     "keyword": "禽流感",
  7.     "createTime": "2020-07-30 20:14:38",
  8.     "modifyTime": "2020-07-30 20:14:38"
  9.   }
  10. }
  • 失败：
  1. {
  2.     "code": 110000,
  3.     "message": "system exception",
  4.     "data": {}
  5. }

4.2 获取关键字列表

传输协议

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

请求参数

1）入参表

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

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/keywords/list/1/2

返回参数

1）出参表

序号输出参数类型备注
1codeInt否返回码，0：成功 其它：失败
2messageString否描述
3totalCountInt否总记录数
4dataList否列表
4.1Object对象
4.1.1idInt否编号
4.1.2keywordString否关键字
4.1.3createTimeLocalDateTime否落库时间
4.1.4modifyTimeLocalDateTime否修改时间

2）出参示例

  • 成功：
  1. {
  2.   "code": 0,
  3.   "message": "success",
  4.   "data": [
  5.     {
  6.       "id": 1,
  7.       "keyword": "禽流感",
  8.       "createTime": "2020-07-30 20:14:38",
  9.       "modifyTime": "2020-07-30 20:14:38"
  10.     }
  11.   ],
  12.   "totalCount": 1
  13. }
  • 失败：
  1. {
  2.    "code": 110000,
  3.    "message": "system exception",
  4.    "data": {}
  5. }

4.3 修改关键字

传输协议

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

请求参数

1）入参表

序号输入参数类型可为空备注
1idInt否关键字编号
2keywordString否关键字

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/keywords/update
  1. {
  2.     "id": 1,
  3.     "keyword": "冠状病毒"
  4. }

返回参数

1）出参表

序号输出参数类型可为空备注
1codeInt否返回码，0：成功 其它：失败
2messageString否描述
3dataObject信息对象
3.1idInt否编号
3.2keywordString否关键字
3.3createTimeLocalDateTime是落库时间
3.2modifyTimeLocalDateTime是修改时间

2）出参示例

  • 成功：
  1. {
  2.   "code": 0,
  3.   "message": "success",
  4.   "data": {
  5.     "id": 1,
  6.     "keyword": "冠状病毒",
  7.     "createTime": "2020-07-30 20:14:38",
  8.     "modifyTime": "2020-07-30 20:15:35"
  9.   }
  10. }
  • 失败：
  1. {
  2.     "code": 110000,
  3.     "message": "system exception",
  4.     "data": {}
  5. }

4.4 删除关键字

传输协议

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

请求参数

1）入参表

序号输入参数类型可为空备注
1idInt否关键字编号

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/keywords/1

返回参数

1）出参表

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

2）出参示例

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

5 交易告警信息管理模块

5.1 新增告警信息

传输协议

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

请求参数

1）入参表

序号输入参数类型可为空备注
1chainIdInt否链编号
2groupIdInt否群组编号
3typeInt否信息来源类型，1-关键字 2-交易列表
4keywordString是关键字，type为1是必填
5commentString否监管意见
6txHashString否交易hash
7addressString否用户地址
8chainNameString是链名称
9appNameString是应用名称

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/transAudit/add
  1. {
  2.   "chainId": 1,
  3.   "groupId": 1,
  4.   "type": 1,
  5.   "keyword": "禽流感",
  6.   "comment": "停止售卖",
  7.   "txHash": "0x8e8b15e87f09e35f4ce811fb61b0bbd730eab0cfe63a350e2bab6f7a2bfe36b0",
  8.   "address": "0xd0332a67b2136ff5767c9ee7b775be83950da59c",
  9.   "chainName": "存证链",
  10.   "appName": "文件存证"
  11. }

返回参数

1）出参表

序号输出参数类型备注
1codeInt否返回码，0：成功 其它：失败
2messageString否描述
3dataObject信息对象
3.1idInt否编号
3.2chainIdInt否链编号
3.3groupIdInt否群组编号
3.4typeInt否信息来源类型，1-关键字 2-交易列表
3.5keywordString否关键字
3.6commentString否监管意见
3.7txHashString否交易hash
3.8addressString否用户地址
3.9statusInt否状态（1-未处理， 2-已处理）
3.10chainNameString是链名称
3.11appNameString是应用名称
3.12createTimeLocalDateTime否落库时间
3.13modifyTimeLocalDateTime否修改时间

2）出参示例

  • 成功：
  1. {
  2.   "code": 0,
  3.   "message": "success",
  4.   "data": {
  5.     "id": 1,
  6.     "chainId": 1,
  7.     "groupId": 1,
  8.     "type": 1,
  9.     "keyword": "禽流感",
  10.     "comment": "停止售卖",
  11.     "txHash": "0x8e8b15e87f09e35f4ce811fb61b0bbd730eab0cfe63a350e2bab6f7a2bfe36b0",
  12.     "address": "0xd0332a67b2136ff5767c9ee7b775be83950da59c",
  13.     "status": 1,
  14.     "chainName": "存证链",
  15.     "appName": "文件存证",
  16.     "createTime": "2020-07-30 20:19:39",
  17.     "modifyTime": "2020-07-30 20:19:39"
  18.   }
  19. }
  • 失败：
  1. {
  2.     "code": 110000,
  3.     "message": "system exception",
  4.     "data": {}
  5. }

5.2 获取告警信息列表

传输协议

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

请求参数

1）入参表

序号输入参数类型可为空备注
1pageNumberInt否当前页码
2pageSizeInt否每页记录数
3statusInt是状态（1-未处理， 2-已处理）
4chainIdInt是链编号
5groupIdInt是群组编号

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/transAudit/list/1/2

返回参数

1）出参表

序号输出参数类型备注
1codeInt否返回码，0：成功 其它：失败
2messageString否描述
3totalCountInt否总记录数
4dataList否列表
4.1Object对象
4.1.1idInt否编号
4.1.2chainIdInt否链编号
4.1.3groupIdInt否群组编号
4.1.4typeInt否信息来源类型，1-关键字 2-交易列表
4.1.5keywordString是关键字
4.1.6commentString是监管意见
4.1.7txHashString否交易hash
4.1.8addressString否用户地址
4.1.9statusInt否状态（1-未处理， 2-已处理）
4.1.10chainNameString是链名称
4.1.11appNameString是应用名称
4.1.12createTimeLocalDateTime否落库时间
4.1.13modifyTimeLocalDateTime否修改时间

2）出参示例

  • 成功：
  1. {
  2.   "code": 0,
  3.   "message": "success",
  4.   "data": [
  5.     {
  6.       "id": 1,
  7.       "chainId": 1,
  8.       "groupId": 1,
  9.       "type": 1,
  10.       "keyword": "禽流感",
  11.       "comment": "停止售卖",
  12.       "txHash": "0x8e8b15e87f09e35f4ce811fb61b0bbd730eab0cfe63a350e2bab6f7a2bfe36b0",
  13.       "address": "0xd0332a67b2136ff5767c9ee7b775be83950da59c",
  14.       "status": 1,
  15.       "chainName": "存证链",
  16.       "appName": "文件存证",
  17.       "createTime": "2020-07-30 20:19:39",
  18.       "modifyTime": "2020-07-30 20:19:39"
  19.     }
  20.   ],
  21.   "totalCount": 1
  22. }
  • 失败：
  1. {
  2.    "code": 110000,
  3.    "message": "system exception",
  4.    "data": {}
  5. }

5.3 确认处理状态

传输协议

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

请求参数

1）入参表

序号输入参数类型可为空备注
1idInt否告警信息编号

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/transAudit/confirm/1

返回参数

1）出参表

序号输出参数类型备注
1codeInt否返回码，0：成功 其它：失败
2messageString否描述
3dataObject信息对象
3.1idInt否编号
3.2chainIdInt否链编号
3.3groupIdInt否群组编号
3.4typeInt否信息来源类型，1-关键字 2-交易列表
3.5keywordString是关键字
3.6commentString否监管意见
3.7txHashString否交易hash
3.8addressString否用户地址
3.9statusInt否状态（1-未处理， 2-已处理）
3.10chainNameString是链名称
3.11appNameString是应用名称
3.12createTimeLocalDateTime否落库时间
3.13modifyTimeLocalDateTime否修改时间

2）出参示例

  • 成功：
  1. {
  2.   "code": 0,
  3.   "message": "success",
  4.   "data": {
  5.     "id": 1,
  6.     "chainId": 1,
  7.     "groupId": 1,
  8.     "type": 1,
  9.     "keyword": "禽流感",
  10.     "comment": "停止售卖",
  11.     "txHash": "0x8e8b15e87f09e35f4ce811fb61b0bbd730eab0cfe63a350e2bab6f7a2bfe36b0",
  12.     "address": "0xd0332a67b2136ff5767c9ee7b775be83950da59c",
  13.     "status": 2,
  14.     "chainName": "存证链",
  15.     "appName": "文件存证",
  16.     "createTime": "2020-07-30 20:19:39",
  17.     "modifyTime": "2020-07-30 20:22:06"
  18.   }
  19. }
  • 失败：
  1. {
  2.     "code": 110000,
  3.     "message": "system exception",
  4.     "data": {}
  5. }

5.4 删除告警信息

传输协议

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

请求参数

1）入参表

序号输入参数类型可为空备注
1idInt否告警信息编号

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/transAudit/1

返回参数

1）出参表

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

2）出参示例

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

6 应用告警信息管理模块

6.1 新增告警信息

传输协议

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

请求参数

1）入参表

序号输入参数类型可为空备注
1chainIdInt否链编号
2groupIdInt否群组编号
3commentString否监管意见
4chainNameString是链名称
5appNameString是应用名称
6appVersionString是应用版本号

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/appAudit/add
  1. {
  2.   "chainId": 1,
  3.   "groupId": 1,
  4.   "comment": "停止",
  5.   "chainName": "存证链",
  6.   "appName": "文件存证",
  7.   "appVersion": "1.0.0"
  8. }

返回参数

1）出参表

序号输出参数类型备注
1codeInt否返回码，0：成功 其它：失败
2messageString否描述
3dataObject信息对象
3.1idInt否编号
3.2chainIdInt否链编号
3.3groupIdInt否群组编号
3.4commentString否监管意见
3.5chainNameString是链名称
3.6appNameString是应用名称
3.7appVersionString是应用版本号
3.8statusInt否状态（1-未处理， 2-已处理）
3.9createTimeLocalDateTime否落库时间
3.10modifyTimeLocalDateTime否修改时间

2）出参示例

  • 成功：
  1. {
  2.   "code": 0,
  3.   "message": "success",
  4.   "data": {
  5.     "id": 1,
  6.     "chainId": 1,
  7.     "groupId": 1,
  8.     "comment": "停止",
  9.     "chainName": "存证链",
  10.     "appName": "文件存证",
  11.     "appVersion": "1.0.0",
  12.     "status": 1,
  13.     "createTime": "2020-07-30 20:19:39",
  14.     "modifyTime": "2020-07-30 20:19:39"
  15.   }
  16. }
  • 失败：
  1. {
  2.     "code": 110000,
  3.     "message": "system exception",
  4.     "data": {}
  5. }

6.2 获取告警信息列表

传输协议

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

请求参数

1）入参表

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

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/appAudit/list/1/2

返回参数

1）出参表

序号输出参数类型备注
1codeInt否返回码，0：成功 其它：失败
2messageString否描述
3totalCountInt否总记录数
4dataList否列表
4.1Object对象
4.1.1idInt否编号
4.1.2chainIdInt否链编号
4.1.3groupIdInt否群组编号
4.1.4commentString否监管意见
4.1.5chainNameString是链名称
4.1.6appNameString是应用名称
4.1.7appVersionString是应用版本号
4.1.8statusInt否状态（1-未处理， 2-已处理）
4.1.9createTimeLocalDateTime否落库时间
4.1.10modifyTimeLocalDateTime否修改时间

2）出参示例

  • 成功：
  1. {
  2.   "code": 0,
  3.   "message": "success",
  4.   "data": [
  5.     {
  6.       "id": 1,
  7.       "chainId": 1,
  8.       "groupId": 1,
  9.       "comment": "停止",
  10.       "chainName": "存证链",
  11.       "appName": "文件存证",
  12.       "appVersion": "1.0.0",
  13.       "status": 1,
  14.       "createTime": "2020-07-30 20:19:39",
  15.       "modifyTime": "2020-07-30 20:19:39"
  16.     }
  17.   ],
  18.   "totalCount": 1
  19. }
  • 失败：
  1. {
  2.    "code": 110000,
  3.    "message": "system exception",
  4.    "data": {}
  5. }

6.3 确认处理状态

传输协议

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

请求参数

1）入参表

序号输入参数类型可为空备注
1idInt否告警信息编号

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/appAudit/confirm/1

返回参数

1）出参表

序号输出参数类型备注
1codeInt否返回码，0：成功 其它：失败
2messageString否描述
3dataObject信息对象
3.1idInt否编号
3.2chainIdInt否链编号
3.3groupIdInt否群组编号
3.4commentString否监管意见
3.5chainNameString是链名称
3.6appNameString是应用名称
3.7appVersionString是应用版本号
3.8statusInt否状态（1-未处理， 2-已处理）
3.9createTimeLocalDateTime否落库时间
3.10modifyTimeLocalDateTime否修改时间

2）出参示例

  • 成功：
  1. {
  2.   "code": 0,
  3.   "message": "success",
  4.   "data": {
  5.     "id": 1,
  6.     "chainId": 1,
  7.     "groupId": 1,
  8.     "comment": "停止",
  9.     "chainName": "存证链",
  10.     "appName": "文件存证",
  11.     "appVersion": "1.0.0",
  12.     "status": 2,
  13.     "createTime": "2020-07-30 20:19:39",
  14.     "modifyTime": "2020-07-30 20:22:06"
  15.   }
  16. }
  • 失败：
  1. {
  2.     "code": 110000,
  3.     "message": "system exception",
  4.     "data": {}
  5. }

6.4 删除告警信息

传输协议

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

请求参数

1）入参表

序号输入参数类型可为空备注
1idInt否告警信息编号

2）入参示例

  1. http://localhost:5010/WeBASE-Data-Fetcher/appAudit/1

返回参数

1）出参表

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

2）出参示例

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

附录

1. 返回码信息列表

Codemessage描述
0success正常
110000system exception系统异常
110001param exception请求参数错误
110002database exception数据库异常
210101invalid group id无效群组编号
210201searchType not exists搜索类型不存在
210202search content can not be empty搜索内容不能为空
210203search index not exists索引不存在
210204search fail搜索失败
210205elasticsearch’s config is falseelasticsearch配置未启用
210301keyword id not exists关键字不存在
210302keyword exists关键字已存在
210303save keyword fail关键字保存失败
210401audit id not exists告警信息不存在
210402audit inffo exists告警信息已存在
210403save audit info fail告警信息保存失败