接口说明

接口说明

1 前置管理模块

1.1 新增节点前置信息

1.1.1 传输协议规范

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

1.1.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	frontIp	string	否	前置ip
2	frontPort	int	否	前置服务端口
3	agency	int	否	所属机构

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/front/new

{
    "frontIp": "127.0.0.1",
    "frontPort": "5002",
    "agency": "abc"
}

1.1.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3		Object		节点信息对象
3.1	frontId	int	否	前置编号
3.2	frontIp	string	否	前置ip
3.3	frontPort	int	否	前置端口
3.4	agency	string	否	所属机构
3.5	createTime	LocalDateTime	否	落库时间
3.6	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "frontId": 500001,
        "frontIp": "127.0.0.1",
        "frontPort": 8181,
        "agency": "abc",
        "createTime": "2019-02-14 17:47:00",
        "modifyTime": "2019-03-15 11:14:29"
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

1.2 获取所有前置列表

1.2.1 传输协议规范

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

1.2.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	frontId	Int	是	前置编号
2	groupId	Int	是	所属群组编号

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/front/find

1.2.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	totalCount	Int	否	总记录数
4	data	List	否	组织列表
4.1		Object		节点信息对象
4.1.1	frontId	int	否	前置编号
4.1.2	frontIp	string	否	前置ip
4.1.3	frontPort	int	否	前置端口
4.1.4	createTime	LocalDateTime	否	落库时间
4.1.5	modifyTime	LocalDateTime	否	修改时间
4.1.6	agency	string	否	备注所属机构
4.1.7	frontVersion	string	否	前置的后台版本，如: v1.4.0
4.1.8	signVersion	string	否	前置所连接签名服务的后台版本，如: v1.4.0
4.1.9	clientVersion	string	否	链节点的版本，如: 2.5.0 gm
4.1.10	supportVersion	string	否	链节点所支持的最高版本, 如: 2.5.0, (此处仅显示支持的最高版本，不显示是否为国密。若从2.4.0升级到2.5.0，此处将返回2.4.0)
4.1.11	status	int	否	前置服务状态：0，未创建；1，停止；2，启动；
4.1.12	runType	int	否	运行方式：0，命令行；1，Docker
4.1.13	agencyId	int	否	所属机构 ID
4.1.14	agencyName	string	否	所属机构名称
4.1.15	hostId	int	否	所属主机
4.1.16	hostIndex	int	否	一台主机可能有多个节点。表示在主机中的编号，从 0 开始编号
4.1.17	imageTag	string	否	运行的镜像版本标签
4.1.18	containerName	string	否	Docker 启动的容器名称
4.1.19	jsonrpcPort	int	否	jsonrpc 端口
4.1.20	p2pPort	int	否	p2p 端口
4.1.21	channelPort	int	否	channel 端口
4.1.22	chainId	int	否	所属链 ID
4.1.23	chainName	string	否	所属链名称

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "frontId": 500001,
            "frontIp": "127.0.0.1",
            "frontPort": 5002,
            "agency": "aa",
            "frontVersion": "v1.4.0",
            "signVersion": "v1.4.0",
            "clientVersion": "2.5.0 gm",
            "supportVersion": "2.5.0",
            "createTime": "2019-06-04 20:49:42",
            "modifyTime": "2019-06-04 20:49:42",
            "status": 1,
            "runType": 1,
            "agencyId": 1,
            "agencyName": "AgencyA",
            "hostId": 1,
            "hostIndex": 0,
            "imageTag": "v2.5.0",
            "containerName": "rootfisconode0",
            "jsonrpcPort": 8545,
            "p2pPort": 30300,
            "channelPort": 20200,
            "chainId": 1,
            "chainName": "default_chain"
        }
    ],
    "totalCount": 1
}

失败：

{
   "code": 102000,
   "message": "system exception",
   "data": {}
}

1.3 删除前置信息

1.3.1 传输协议规范

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

1.3.2 请求参数

1）入参表

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

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/front/500001

1.3.3 返回参数

1）出参表

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

2）出参示例

成功：

{
    "code": 0,
    "data": {},
    "message": "Success"
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

2 交易信息模块

2.1 查询交易信息列表

2.1.1 传输协议规范

网络传输协议：使用HTTP协议
请求地址：

/transaction/transList/{groupId}/{pageNumber}/{pageSize}?transactionHash={transactionHash}&blockNumber={blockNumber}

请求方式：GET
返回格式：JSON

2.1.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	所属群组编号
2	transactionHash	String	是	交易hash
3	blockNumber	BigInteger	是	块高
4	pageSize	int	否	每页记录数
5	pageNumber	int	否	当前页码

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/transaction/transList/300001/1/10?transactionHash=0x303daa78ebe9e6f5a6d9761a8eab4bf5a0ed0b06c28764488e4716de42e1df01

2.1.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	totalCount	Int	否	总记录数
4	data	List	否	交易信息列表
4.1		Object		交易信息对象
4.1.1	transHash	String	否	交易hash
4.1.2	groupId	Int	否	所属群组编号
4.1.3	blockNumber	BigInteger	否	所属块高
4.1.4	statisticsFlag	Int	否	是否已经统计
4.1.5	createTime	LocalDateTime	否	落库时间
4.1.6	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "transHash": "0x303daa78ebe9e6f5a6d9761a8eab4bf5a0ed0b06c28764488e4716de42e1df01",
            "groupId": 300001,
            "blockNumber": 133,
            "statisticsFlag": 1,
            "createTime": "2019-03-15 09:36:17",
            "modifyTime": "2019-03-15 09:36:17"
        }
    ],
    "totalCount": 1
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

2.2 查询交易回执

2.2.1 传输协议规范

网络传输协议：使用HTTP协议
请求地址：/transaction/transactionReceipt/{groupId}/{transHash}
请求方式：GET
返回格式：JSON

2.2.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	所属群组编号
2	transHash	String	是	交易hash

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/transaction/transactionReceipt/1/0xda879949df6b5d75d2d807f036b461e0cebcc1abaccac119c9a282d3941a4818

2.2.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3		Object		交易信息对象
3.1	transactionHash	String	否	交易hash
3.2	transactionIndex	Int	否	在区块中的索引
3.2	blockHash	String	否	区块hash
3.3	blockNumber	BigInteger	否	所属块高
3.4	cumulativeGasUsed	Int	否
3.5	gasUsed	Int	否	交易消耗的gas
3.6	contractAddress	String	否	合约地址
3.7	status	String	否	交易的状态值
3.8	from	String	否	交易发起者
3.9	to	String	否	交易目标
3.10	output	String	否	交易输出内容
3.11	logs	String	否	日志
3.12	logsBloom	String	否	log的布隆过滤值

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "transactionHash": "0xda879949df6b5d75d2d807f036b461e0cebcc1abaccac119c9a282d3941a4818",
        "transactionIndex": 0,
        "blockHash": "0x739853061c6c87ed691c0ee6f938589f7e2e442d42b16f582b353a475359b91d",
        "blockNumber": 4311,
        "cumulativeGasUsed": 0,
        "gasUsed": 32940,
        "contractAddress": "0x0000000000000000000000000000000000000000",
        "status": "0x0",
        "from": "0xe4bc056009daed8253008e03db6f62d93ccfacea",
        "to": "0x522eda3fbe88c07025f1db3f7dc7d9836af95b3f",
        "output": "0x",
        "logs": [],
        "logsBloom": "0x000000000000000000000000000000000000000",
        "blockNumberRaw": "0x10d7",
        "transactionIndexRaw": "0x0",
        "statusOK": true,
        "gasUsedRaw": "0x80ac"
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

2.3 根据交易hash查询交易信息

2.3.1 传输协议规范

网络传输协议：使用HTTP协议
请求地址：/transaction/transInfo/{groupId}/{transHash}
请求方式：GET
返回格式：JSON

2.3.2 参数信息详情

请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	所属群组编号
2	transHash	String	是	交易hash

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/transaction/transInfo/1/0xda879949df6b5d75d2d807f036b461e0cebcc1abaccac119c9a282d3941a4818

2.3.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3		Object		交易信息对象
3.1	hash	String	否	交易hash
3.2	transactionIndex	Int	否	在区块中的索引
3.2	blockHash	String	否	区块hash
3.3	blockNumber	BigInteger	否	所属块高
3.4	cumulativeGasUsed	Int	否
3.5	gasUsed	Int	否	交易消耗的gas
3.6	contractAddress	String	否	合约地址
3.7	status	String	否	交易的状态值
3.8	from	String	否	交易发起者
3.9	to	String	否	交易目标
3.10	output	String	否	交易输出内容
3.11	logs	String	否	日志
3.12	logsBloom	String	否	log的布隆过滤值
3.13	nonce	String	否
3.14	value	String	否
3.15	gasPrice	long	否
3.16	gas	long	否
3.17	input	String	否
3.18	v	int	否
3.19	nonceRaw	String	否
3.20	blockNumberRaw	String	否
3.21	gasPriceRaw	String	否
3.22	gasRaw	String	否

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "hash": "0xda879949df6b5d75d2d807f036b461e0cebcc1abaccac119c9a282d3941a4818",
        "nonce": "600264747827990445399299219738839026203774909117379671331964756256186263529",
        "blockHash": "0x739853061c6c87ed691c0ee6f938589f7e2e442d42b16f582b353a475359b91d",
        "blockNumber": 4311,
        "transactionIndex": 0,
        "from": "0xe4bc056009daed8253008e03db6f62d93ccfacea",
        "to": "0x522eda3fbe88c07025f1db3f7dc7d9836af95b3f",
        "value": 0,
        "gasPrice": 100000000,
        "gas": 100000000,
        "input": "0x4ed3885e000000000000000",
        "v": 0,
        "nonceRaw": "0x153bce0f26461030fe5189385b9c3e84336b007769a3849524ca3f4af7d67e9",
        "blockNumberRaw": "0x10d7",
        "transactionIndexRaw": "0x0",
        "gasPriceRaw": "0x5f5e100",
        "gasRaw": "0x5f5e100"
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

3 帐号管理模块

3.1 新增帐号

3.1.1 传输协议规范

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

3.1.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	account	String	否	帐号名称
2	accountPwd	String	否	登录密码（sha256）
3	roleId	int	否	所属角色

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/account/accountInfo

{
    "account": "testAccount",
    "accountPwd": "3f21a8490cef2bfb60a9702e9d2ddb7a805c9bd1a263557dfd51a7d0e9dfa93e",
    "roleId": 100001
}

3.1.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	object	否	返回信息实体
3.1	account	String	否	帐号
3.2	roleId	Integer	否	所属角色
3.3	roleName	String	否	角色名称
3.4	roleNameZh	String	否	角色中文名
3.5	loginFailTime	Integer	是	登录失败次数
3.6	accountStatus	Integer	否	帐号状态
3.7	description	String	是	备注
3.8	createTime	LocalDateTime	否	创建时间
3.9	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "account": "testAccount",
        "roleId": 100001,
        "roleName": "visitor",
        "roleNameZh": "访客",
        "loginFailTime": 0,
        "accountStatus": 1,
        "description": null,
        "createTime": "2019-03-04 15:11:44",
        "modifyTime": "2019-03-04 15:11:44"
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

3.2 修改帐号

3.2.1 传输协议规范

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

3.2.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	account	String	否	帐号名称
2	accountPwd	String	否	登录密码（sha256）
3	roleId	int	否	所属角色

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/account/accountInfo

{
    "account": "testAccount",
    "accountPwd": "82ca84cf0d2ae423c09a214cee2bd5a7ac65c230c07d1859b9c43b30c3a9fc80",
    "roleId": 100001
}

3.2.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	object	否	返回信息实体
3.1	account	String	否	帐号
3.2	roleId	Integer	否	所属角色
3.3	roleName	String	否	角色名称
3.4	roleNameZh	String	否	角色中文名
3.5	loginFailTime	Integer	是	登录失败次数
3.6	accountStatus	Integer	否	帐号状态
3.7	description	String	是	备注
3.8	createTime	LocalDateTime	否	创建时间
3.9	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "account": "testAccount",
        "roleId": 100001,
        "roleName": "visitor",
        "roleNameZh": "访客",
        "loginFailTime": 0,
        "accountStatus": 1,
        "description": null,
        "createTime": "2019-03-04 15:11:44",
        "modifyTime": "2019-03-04 15:11:44"
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

3.3 删除帐号

3.3.1 传输协议规范

网络传输协议：使用HTTP协议
请求地址：/account/{account}
请求方式：DELETE
返回格式：JSON

3.3.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	account	String	否	帐号名称

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/account/testAccount

3.3.3 返回参数

1）出参表

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

2）出参示例

成功：

{
    "code": 0,
    "data": {},
    "message": "Success"
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

3.4 查询帐号列表

3.4.1 传输协议规范

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

3.4.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	pageSize	Int	否	每页记录数
2	pageNumber	Int	否	当前页码
3	account	String	是	帐号

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/account/accountList/1/10?account=

3.4.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	totalCount	Int	否	总记录数
4	data	List	是	信息列表
4.1		Object		信息对象
4.1.1	account	String	否	帐号
4.1.2	roleId	Integer	否	所属角色
4.1.3	roleName	String	否	角色名称
4.1.4	roleNameZh	String	否	角色中文名
4.1.5	loginFailTime	Integer	是	登录失败次数
4.1.6	accountStatus	Integer	否	帐号状态
4.1.7	description	String	是	备注
4.1.8	createTime	LocalDateTime	否	创建时间
4.1.9	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "account": "testAccount",
            "roleId": 100001,
            "roleName": "visitor",
            "roleNameZh": "访客",
            "loginFailTime": 0,
            "accountStatus": 1,
            "description": null,
            "createTime": "2019-03-04 15:11:44",
            "modifyTime": "2019-03-04 15:18:47"
        },
        {
            "account": "admin",
            "roleId": 100000,
            "roleName": "admin",
            "roleNameZh": "管理员",
            "loginFailTime": 0,
            "accountStatus": 2,
            "description": null,
            "createTime": "2019-02-14 17:33:50",
            "modifyTime": "2019-02-14 17:45:53"
        }
    ],
    "totalCount": 2
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

3.5 更新当前密码

3.5.1 传输协议规范

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

3.5.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	oldAccountPwd	String	否	旧密码（sha256）
2	newAccountPwd	String	否	新密码（sha256）

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/account/passwordUpdate

{
    "oldAccountPwd": "dfdfgdg490cef2bfb60a9702erd2ddb7a805c9bd1arrrewefd51a7d0etttfa93e ",
    "newAccountPwd": "3f21a8490cef2bfb60a9702e9d2ddb7a805c9bd1a263557dfd51a7d0e9dfa93e"
}

3.5.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述

2）出参示例

成功：

{
    "code": 0,
    "message": "success"
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

3.6 获取登录验证码

3.6.1 传输协议规范

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

3.6.2 请求参数

1）入参表 无

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/account/pictureCheckCode

3.6.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	Object	否	图片信息实体
3.1	base64Image	String	否	图片的base64
3.2	token	String	否	token（登录接口需要用到此值）

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "base64Image": "iVBORw0KGgoAAAANSUhEUgAAAJsAAAA8CAIAAAD+Gl+NAAAC3ElEQVR42u3cO04DMRAG4DkER6CFhoNwCgoq6DgQh0DiVJR0oUCKovWuPU977P2trZK1s/GnGb8g9PN7wbXSRReUtQpEIYoCURSIokAUBaIQTV2+P798r3mfnJbB69nXvmAnjdHm9+8ZgruNjI31mUQrvWPpPpeuH+43n2g9FOJyrOJmiMpQ+4fC0cdVniED6hzj6NjMdv3cZvJHjCpz70DazJY+oh2mBptmH+7um5eo/ff3F+mVENJHVDrMeEUGB1W0mFGgLrhnVI9OL1QdZ58wzTnVIMcA3X3FXTQP6tjJ7dFuBjnm29JgXlGXbazoubcs63K23JgSxu/MQXXpKd1IWS6XQ42b7ZOoH/lIZfp9ff7YXCuJHvX709sj87Jb1kQ5Ichp/XpPySmlra9hvCJAl3vr77qg8kO/h2idU4eaRJTTCXzRo9QtSuOkBuOjckQVriWqC7MIldnX6jD1OfF25NwNUP679X50n+4qljH2rMBJvNYY5QefDrWspZ4xRSxjOqMyh1I+arhoqbVbS4HK5IzebejAKUIlS/AlRL0OJ1OgShcwyvVotKjjLGmD2vSOXptGc3J63iSaBFUUx+oDmVSilf4/nWieMHURLRWsomrUnhvcOVEdRW8tyIIkuj9OtKmVUDSC01NUh9ozr2ZDdU+5jRPvIFHmEsUy3eVMeqP37jtwVk7uyCgkrcU5VtOFcsW1/2F4kCjnCLZxPqqI1Hot/mmMPVKDNgXdRflnMso9I07Aqc/abl+PWMOsispvmaRZVL3ru3vmF7EkdT+NWUq0kr5FO4Vl3U31iB0GL865UAV/Czj8X/tOUoxdhN9hyChqqQ7RpTghClEUiKJAFKIQBSpEF0aFKETX7cRsW1q6JyEoHh0qZABWfDqdnDPi5rGPSqflHLK06OBKiM7O1e0DRH1EIETn2HY4bMxffp31F5MHRmeQq3EW5vPrN2eOTq8h2X0u/d/aH4oBfftm+5EiAAAAAElFTkSuQmCC",
        "token": "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIzOGM0NjlhNC1kMTg3LTQyZDQtYWM1YS02OWU0OWM5MjMxNTkiLCJpYXQiOjE1NjAyNDY3MzksInN1YiI6ImU1RnoiLCJleHAiOjE1NjAyNDY3OTl9.FJYRZJSAhFjvO_P4AjMO6bnoOZJiu-AOSdO9ikb-30M"
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

3.7 登录接口

3.7.1 传输协议规范

网络传输协议：使用HTTP协议
请求地址：/account/login?checkCode={checkCode}
请求方式：get
请求头：Content-type: application/json;token:{token}
返回格式：JSON

3.7.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	checkCode	String	否	登录验证码
2	account	String	否	帐号
3	accountPwd	String	否	密码
4	token	String	否	随验证码返回的token

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/account/login?checkCode=aege

{
    "account": "admin",
    "accountPwd": "Abcd1234"
}

1.1.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	Object	否	图片信息实体
3.1	account	String	否	账户
3.2	roleName	String	否	角色
3.3	accountStatus	Int	否	状态

2）出参示例

成功：

{
    "code": 0,
    "data": {
        "accountStatus": 2,
        "roleName": "admin",
        "account": "admin"
    },
    "message": "success"
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

4 区块管理模块

4.1 查询区块列表

4.1.1 传输协议规范

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

4.1.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	Int	否	当前所属链
2	pageSize	Int	否	每页记录数
3	pageNumber	Int	否	当前页码
4	pkHash	String	是	区块hash
5	blockNumber	BigInteger	是	块高

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/block/blockList/300001/1/10?pkHash=

4.1.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	totalCount	Int	否	总记录数
4	data	List	是	区块列表
4.1		Object		区块信息对象
4.1.1	pkHash	String	否	块hash
4.1.2	blockNumber	BigInteger	否	块高
4.1.3	blockTimestamp	LocalDateTime	否	出块时间
4.1.4	transCount	int	否	交易数
4.1.5	sealerIndex	int	否	打包节点索引
4.1.6	sealer	String	否	打包节点
4.1.7	createTime	LocalDateTime	否	创建时间
4.1.8	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "pkHash": "0x10fb8485eebffbb2a0b0d4f22d58d5cd54df2ac53f974b6c731c954957f36dd7",
            "blockNumber": 127,
            "blockTimestamp": "2019-06-11 18:11:32",
            "transCount": 1,
            "sealerIndex": 2,
            "sealer": "552398be0eef124c000e632b0b76a48c52b6cfbd547d92c15527c2d1df15fab2bcded48353db22526c3540e4ab2027630722889f20a4a614bb11a7887a85941b",
            "createTime": "2019-06-11 18:11:36",
            "modifyTime": "2019-06-11 18:11:36"
        }
    ],
    "totalCount": 1
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

4.2 根据块高或hash查询区块信息

4.2.1 传输协议规范

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

4.2.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	Int	否	当前所属链
2	pageSize	Int	否	每页记录数
3	pageNumber	Int	否	当前页码
4	pkHash	String	是	区块hash
5	blockNumber	BigInteger	是	块高

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/block/blockByNumber/1/11

4.2.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3		Object		区块信息对象
3.1	number	BigInteger	否	块高
3.2	hash	String	否	区块hsah
3.3	parentHash	String	否	父块hash
3.4	nonce	String	否	随机数
3.5	sealer	String	否	打包节点索
3.6	logsBloom	String	否	log的布隆过滤值
3.7	transactionsRoot	String	否
3.8	stateRoot	String	否
3.9	difficulty	String	否
3.10	totalDifficulty	String	否
3.11	extraData	String	否
3.12	size	int	否
3.13	gasLimit	long	否	限制gas值
3.14	gasUsed	long	否	已使用的gas值
3.15	timestamp	String	否	出块时间
3.16	gasLimitRaw	String	否
3.17	timestampRaw	String	否
3.18	gasUsedRaw	String	否
3.19	numberRaw	String	否
3.20	transactions	List	否
3.20.1		Object		交易信息对象
3.20.1.1	hash	String	否	交易hash
3.20.1.2	blockHash	String	否	区块hash
3.20.1.3	blockNumber	BigInteger	否	所属块高
3.20.1.4	cumulativeGasUsed	Int	否
3.20.1.5	gasUsed	Int	否	交易消耗的gas
3.20.1.6	contractAddress	String	否	合约地址
3.20.1.7	status	String	否	交易的状态值
3.20.1.8	from	String	否	交易发起者
3.20.1.9	to	String	否	交易目标
3.20.1.10	output	String	否	交易输出内容
3.20.1.11	logs	String	否	日志
3.20.1.12	logsBloom	String	否	log的布隆过滤值
3.20.1.13	nonce	String	否
3.20.1.14	value	String	否
3.20.1.15	gasPrice	long	否
3.20.1.16	gas	long	否
3.20.1.17	input	String	否
3.20.1.18	v	int	否
3.20.1.19	nonceRaw	String	否
3.20.1.20	blockNumberRaw	String	否
3.20.1.21	gasPriceRaw	String	否
3.20.1.22	gasRaw	String	否
3.20.1.23	transactionIndex	Int	否	在区块中的索引

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "number": 11,
        "hash": "0xeef574a136f1d5031ce7f5d4bbc19fa1a1b5736f38ec5687d43405a572219405",
        "parentHash": "0xca84147e343acb972dc9247727b920b5c081320bbe940f4e2b24363836dca4a1",
        "nonce": "0",
        "sealer": "0x0",
        "logsBloom": "0x000000000000000000000000000000000000",
        "transactionsRoot": "0x68510be0e37b993874c6cb59170b87f01fc9672a162b30df7ea96cb026f3ab27",
        "stateRoot": "0xa6e930f100c2f4a13816e57aede9b63f3b7d51d64148f4412d8a6efcb0fa9c79",
        "difficulty": 0,
        "totalDifficulty": 0,
        "extraData": [],
        "size": 0,
        "gasLimit": 0,
        "gasUsed": 0,
        "timestamp": "1551667286153",
        "gasLimitRaw": "0x0",
        "timestampRaw": "0x1694693d089",
        "gasUsedRaw": "0x0",
        "numberRaw": "0xb",
        "transactions": [
            {
                "hash": "0x30ab22a942a6545cfe46fd725e53311fbcfea655f9c0d1e198b83749f5d7bf9b",
                "nonce": "1224685724047484442779169279180691132123728860283320089873703663086305160417",
                "blockHash": "0xeef574a136f1d5031ce7f5d4bbc19fa1a1b5736f38ec5687d43405a572219405",
                "blockNumber": 11,
                "transactionIndex": 0,
                "from": "0x148947262ec5e21739fe3a931c29e8b84ee34a0f",
                "to": "0xdfb1684019f7f6ea2c41590ac55d29961de5deba",
                "value": 0,
                "gasPrice": 300000000,
                "gas": 300000000,
                "input": "0x66c991390000000000000000000000000000000000000000000000000000000000000004",
                "v": 0,
                "nonceRaw": "0x2b525c633f530fdd935428a58afcfbb533e4dd16f24eda6b6a860b63e6a2ce1",
                "blockNumberRaw": "0xb",
                "transactionIndexRaw": "0x0",
                "gasPriceRaw": "0x11e1a300",
                "gasRaw": "0x11e1a300"
            }
        ]
    }

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

5 合约管理模块

5.1 查询合约列表

5.1.1 传输协议规范

网络传输协议：使用HTTP协议
请求地址：/contract/contractList/{groupId}/{pageNumber}/{pageSize}
请求方式：POST
返回格式：JSON

5.1.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组id
2	contractName	String	否	合约名
3	contractAddress	String	否	合约地址
4	pageSize	int	否	每页记录数
5	pageNumber	int	否	当前页码
6	contractStatus	int	否	1未部署，2已部署

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/contract/contractList

5.1.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	totalCount	Int	否	总记录数
4	data	List	是	列表
5.1		Object		返回信息实体
5.1.1	contractId	int	否	合约编号
5.1.2	contractPath	String	否	合约所在目录
5.1.3	contractName	String	否	合约名称
5.1.4	groupId	Int	否	所属群组编号
5.1.5	contractStatus	int	否	1未部署，2已部署
5.1.6	contractType	Int	否	合约类型(0-普通合约，1-系统合约)
5.1.7	contractSource	String	否	合约源码base64
5.1.8	contractAbi	String	是	合约编译后生成的abi文件内容
5.1.9	contractBin	String	是	合约编译后生成的bin,可用于交易解析
5.1.10	bytecodeBin	String	是	合约编译后生成的bytecodeBin，可用于合约部署
5.1.11	contractAddress	String	是	合约地址
5.1.12	deployTime	LocalDateTime	是	部署时间
5.1.13	contractVersion	String	否	合约版本（会去除该字段）
5.1.14	description	String	是	备注
5.1.15	createTime	LocalDateTime	否	创建时间
5.1.16	modifyTime	LocalDateTime	是	修改时间
*2）出参示例*

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "contractId": 200002,
            "contractPath": "hellos",
            "contractVersion": null,
            "contractName": "hellos",
            "contractStatus": 2,
            "groupId": 1,
            "contractType": 0,
            "contractSource": "cHJhZ21hIHNvbGlkaXgICAJbmFtZSA9IG47CiAgICB9Cn0=",
            "contractAbi": "[\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"constructor\"}]",
            "contractBin": "608060405234801561001057600080004d4c",
            "bytecodeBin": "60806040526004361061004c576000398de7e4ddf5fdc9ccbcfd44565fed695cd960b0029",
            "deployTime": "2019-06-11 18:11:33",
            "description": null,
            "createTime": "2019-06-05 16:40:40",
            "modifyTime": "2019-06-11 18:11:33"
        }
    ],
    "totalCount": 1
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

5.2 查询合约信息

5.2.1 传输协议规范

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

5.2.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组id
2	contractId	int	否	合约编号

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/contract/200001

5.2.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3		Object		返回信息实体
3.1	contractId	int	否	合约编号
3.2	contractPath	String	否	合约所在目录
3.3	contractName	String	否	合约名称
3.4	groupId	Int	否	所属群组编号
3.5	contractStatus	int	否	1未部署，2已部署
3.6	contractType	Int	否	合约类型(0-普通合约，1-系统合约)
3.7	contractSource	String	否	合约源码
3.8	contractAbi	String	是	编译合约生成的abi文件内容
3.9	contractBin	String	是	合约编译的runtime-bytecode(runtime-bin)，用于交易解析
3.10	bytecodeBin	String	是	合约编译的bytecode(bin)，用于部署合约
3.11	contractAddress	String	是	合约地址
3.12	deployTime	LocalDateTime	是	部署时间
3.13	contractVersion	String	否	合约版本（会去除该字段）
3.14	description	String	是	备注
3.15	createTime	LocalDateTime	否	创建时间
3.16	modifyTime	LocalDateTime	是	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "contractId": 200002,
        "contractPath": "hellos",
        "contractVersion": null,
        "contractName": "hellos",
        "contractStatus": 2,
        "groupId": 1,
        "contractType": 0,
        "contractSource": "cHJhZ21hIHNvbGlkaXgICAJbmFtZSA9IG47CiAgICB9Cn0=",
        "contractAbi": "[\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"constructor\"}]",
        "bytecodeBin": "60806040526004361061004c576000398de7e4ddf5fdc9ccbcfd44565fed695cd960b0029",
        "contractBin": "608060405234801561001057600080004d4c",
        "deployTime": "2019-06-11 18:11:33",
        "description": null,
        "createTime": "2019-06-05 16:40:40",
        "modifyTime": "2019-06-11 18:11:33"
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

5.3 部署合约

构造方法参数（funcParam）为JSON数组，多个参数以逗号分隔（参数为数组时同理），示例：

constructor(string s) -> ["aa,bb\"cc"]  // 双引号要转义
constructor(uint n,bool b) -> [1,true]
constructor(bytes b,address[] a) -> ["0x1a",["0x7939E26070BE44E6c4Fc759Ce55C6C8b166d94BE","0xce867fD9afa64175bb50A4Aa0c17fC7C4A3C67D9"]]

5.3.1 传输协议规范

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

5.3.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	Int	否	所属群组编号
2	contractName	String	否	合约名称
3	contractSource	String	否	合约源码
4	contractAbi	String	否	编译合约生成的abi文件内容
5	contractBin	String	否	合约编译的runtime-bytecode(runtime-bin)，用于交易解析
6	bytecodeBin	String	否	合约编译的bytecode(bin)，用于部署合约
7	contractId	String	否	合约名称
8	contractPath	String	否	合约所在目录
9	user	String	否	私钥用户的地址
10	constructorParams	List	是	构造函数入参

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/contract/deploy

{
    "groupId": "1",
    "contractBin": "60806040526004361061004c576000357c010000002269b80029",
    "bytecodeBin": "60806040523480156100105761146031c79ef057dd274c87bff322ea2269b80029",
    "contractAbi": "[]",
    "contractSource": "cHJhZ21hIHNvbGlkaXR5IF4wLICAJbmFtZSA9IG47CiAgICB9Cn0=",
    "user": "0x2db346f9d24324a4b0eac7fb7f3379a2422704db",
    "contractName": "HeHe",
    "contractId": 200008,
    "contractPath": "Hi",
    "constructorParams": ["a"]
}

5.3.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3		Object		返回信息实体
3.1	contractId	int	否	合约编号
3.2	contractPath	String	否	合约所在目录
3.3	contractName	String	否	合约名称
3.4	groupId	Int	否	所属群组编号
3.5	contractStatus	int	否	1未部署，2已部署
3.6	contractType	Int	否	合约类型(0-普通合约，1-系统合约)
3.7	contractSource	String	否	合约源码
3.8	contractAbi	String	是	编译合约生成的abi文件内容
3.9	contractBin	String	是	合约编译的runtime-bytecode(runtime-bin)，用于交易解析
3.10	bytecodeBin	String	是	合约编译的bytecode(bin)，用于部署合约
3.11	contractAddress	String	是	合约地址
3.12	deployTime	LocalDateTime	是	部署时间
3.13	contractVersion	String	否	合约版本（会去除该字段）
3.14	description	String	是	备注
3.15	createTime	LocalDateTime	否	创建时间
3.16	modifyTime	LocalDateTime	是	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "contractId": 200008,
        "contractPath": "Hi",
        "contractVersion": null,
        "contractName": "HeHe",
        "contractStatus": 2,
        "groupId": 1,
        "contractType": null,
        "contractSource": "cHJhZ21hIHNvbGlkaXR5IF4wLjQuM0=",
        "contractAbi": "[]",
        "bytecodeBin": "60806040526004361061004c576000357c010274c87bff322ea2269b80029",
        "contractBin": "608060405234801561001057629",
        "contractAddress": "0xa2ea2280b3a08a3ae2e1785dff09561e13915fb2",
        "deployTime": "2019-06-11 18:58:33",
        "description": null,
        "createTime": null,
        "modifyTime": null
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

5.4 发送交易

方法入参（funcParam）为JSON数组，多个参数以逗号分隔（参数为数组时同理），示例：

function set(string s) -> ["aa,bb\"cc"] // 双引号要转义
function set(uint n,bool b) -> [1,true]
function set(bytes b,address[] a) -> ["0x1a",["0x7939E26070BE44E6c4Fc759Ce55C6C8b166d94BE","0xce867fD9afa64175bb50A4Aa0c17fC7C4A3C67D9"]]

5.4.1 传输协议规范

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

5.4.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	Int	否	所属群组编号
2	user	String	否	私钥用户的地址
3	contractName	String	否	合约名称
4	contractId	Int	否	合约编号
5	funcName	String	否	合约方法名
6	contractAddress	String	是	合约地址
7	funcParam	List	是	合约方法入参
8	contractAbi	List	否	合约abi/合约单个函数的abi

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/contract/transaction

{
    "groupId":"1",
    "user":"0x6accbdb86107b70decceee618ce40e20e15c8ad4",
    "contractName":"HelloWorld",
    "funcName":"set",
    "funcParam":["gwes"],
    "contractAbi": [{\"constant\":false,\"inputs\":[{\"indexed\":false,\"name\":\"n\",\"type\":\"string\"}],\"name\":\"set\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"}],
    "contractId":200002,
    "contractAddress":"0x7bd586b045e3684dbcd5506cb175c5d771f38d13"
}

5.4.3 返回参数

1）出参表

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

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {}
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

5.5 根据包含bytecodeBin的字符串查询合约

5.5.1 传输协议规范

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

5.5.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	所属群组编号
2	partOfBytecodeBin	String	否	包含合约bytecodeBin的的字符串

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/contract/findByPartOfBytecodeBin

{
    "groupId": "300001",
    "partOfBytecodeBin": "abc123455dev"
}

5.5.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3		Object		返回信息实体
3.1	contractId	int	否	合约编号
3.2	contractName	String	否	合约名称
3.3	groupId	Int	否	所属群组编号
3.4	contractType	Int	否	合约类型(0-普通合约，1-系统合约)
3.5	contractSource	String	否	合约源码
3.6	contractAbi	String	是	编译合约生成的abi文件内容
3.7	contractBin	String	是	合约编译的runtime-bytecode(runtime-bin)，用于交易解析
3.8	bytecodeBin	String	是	合约编译的bytecode(bin)，用于部署合约
3.9	contractAddress	String	是	合约地址
3.10	deployTime	LocalDateTime	是	部署时间
3.11	contractVersion	String	否	合约版本
3.12	description	String	是	备注
3.13	createTime	LocalDateTime	否	创建时间
3.14	modifyTime	LocalDateTime	是	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "contractId": 200002,
        "contractName": "Ok",
        "groupId": 2,
        "chainIndex": null,
        "contractType": 0,
        "contractSource": "cHJhZ21hIDQoNCg0KfQ==",
        "contractAbi": "[]",
        "contractBin": "60606040526000357c01000000000029",
        "bytecodeBin": "123455",
        "contractAddress": "0x19146d3a2f138aacb97ac52dd45dd7ba7cb3e04a",
        "deployTime": null,
        "contractVersion": "v6.0",
        "description": null,
        "createTime": "2019-04-15 21:14:40",
        "modifyTime": "2019-04-15 21:14:40"
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

5.6. 保存合约接口

5.6.1 传输协议规范

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

5.6.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	所属群组编号
2	contractId	int	是	合约编号，传入contractId表示更新，否则新增
3	contractName	String	否	合约名称
4	contractPath	String	否	合约所在目录
5	contractSource	String	是	合约源码的base64
6	contractAbi	String	是	合约编译后生成的abi文件内容
7	contractBin	String	是	合约编译后生成的bin,可用于交易解析
8	bytecodeBin	String	是	合约编译后生成的bytecodeBin，可用于合约部署

2）入参示例

{
    "groupId": "1",
    "contractName": "HeHe",
    "contractPath": "/",
    "contractSource": "cHJhZ21hIHNvbGlkaXR5IF4wLjQuMjsn0=",
    "contractAbi": “[]”
    "contractBin": "60806040526004361061004c576000357c0100000000000000000000000029",
    "bytecodeBin": "6080604052348015610010572269b80029",
    "contractId": 1
}

5.6.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3		Object		返回信息实体
3.1	contractId	int	否	合约编号
3.2	contractPath	String	否	合约所在目录
3.3	contractName	String	否	合约名称
3.4	groupId	Int	否	所属群组编号
3.5	contractStatus	int	否	1未部署，2已部署
3.6	contractType	Int	否	合约类型(0-普通合约，1-系统合约)
3.7	contractSource	String	否	合约源码base64
3.8	contractAbi	String	是	合约编译后生成的abi文件内容
3.9	contractBin	String	是	合约编译后生成的bin,可用于交易解析
3.10	bytecodeBin	String	是	合约编译后生成的bytecodeBin，可用于合约部署
3.11	contractAddress	String	是	合约地址
3.12	deployTime	LocalDateTime	是	部署时间
3.13	contractVersion	String	否	合约版本（会去除该字段）
3.14	description	String	是	备注
3.15	createTime	LocalDateTime	否	创建时间
3.16	modifyTime	LocalDateTime	是	修改时间

5.7 获取Abi信息

5.7.1 传输协议规范

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

5.7.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	abiId	Long	否	abi编号

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/abi/1

5.7.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3		Object		返回信息实体
3.1	abiId	int	否	合约编号
3.2	contractName	String	否	合约名称
3.3	groupId	Int	否	所属群组编号
3.4	contractAddress	String	否	合约地址
3.5	contractAbi	String	是	导入的abi文件内容
3.6	contractBin	String	是	合约runtime-bytecode(runtime-bin)
3.7	createTime	LocalDateTime	否	创建时间
3.8	modifyTime	LocalDateTime	是	修改时间

2）出参示例

成功：

{
  "code": 0,
  "message": "success",
  "data": {
    "abiId": 1,
    "groupId": 1,
    "contractName": "TTT",
    "contractAddress": "0x3214227e87bccca63893317febadd0b51ade735e",
    "contractAbi": "[{\"constant\":false,\"inputs\":[{\"name\":\"n\",\"type\":\"string\"}],\"name\":\"set\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"get\",\"outputs\":[{\"name\":\"\",\"type\":\"string\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"n\",\"type\":\"string\"}],\"name\":\"setSender\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"name\",\"type\":\"string\"}],\"name\":\"SetName\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"\",\"type\":\"uint256[2]\"}],\"name\":\"EventList\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"sender\",\"type\":\"address\"}],\"name\":\"SetSender\",\"type\":\"event\"}]",
    "contractBin": "608060405260043610610057576000357...",
    "createTime": "2020-05-18 10:59:02",
    "modifyTime": "2020-05-18 10:59:02"
  }
}

5.8 获取Abi信息分页列表

5.8.1 传输协议规范

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

5.8.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组编号
2	pageNumber	int	否	页码，从1开始
3	pageSize	int	否	页大小

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/abi/list/1/1/5

5.8.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3		Object		返回信息实体
3.1	abiId	int	否	合约编号
3.2	contractName	String	否	合约名称
3.3	groupId	Int	否	所属群组编号
3.4	contractAddress	String	否	合约地址
3.5	contractAbi	String	是	导入的abi文件内容
3.6	contractBin	String	是	合约runtime-bytecode(runtime-bin)
3.7	createTime	LocalDateTime	否	创建时间
3.8	modifyTime	LocalDateTime	是	修改时间

2）出参示例

成功：

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "abiId": 1,
      "groupId": 1,
      "contractName": "TTT",
      "contractAddress": "0x3214227e87bccca63893317febadd0b51ade735e",
      "contractAbi": "[{\"constant\":false,\"inputs\":[{\"name\":\"n\",\"type\":\"string\"}],\"name\":\"set\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"get\",\"outputs\":[{\"name\":\"\",\"type\":\"string\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[{\"name\":\"n\",\"type\":\"string\"}],\"name\":\"setSender\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"name\",\"type\":\"string\"}],\"name\":\"SetName\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"\",\"type\":\"uint256[2]\"}],\"name\":\"EventList\",\"type\":\"event\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"sender\",\"type\":\"address\"}],\"name\":\"SetSender\",\"type\":\"event\"}]",
      "contractBin": "608060405260043610610057576000357c0100000000000000000000000000000000000000000000000000000000900463fffff...29",
      "createTime": "2020-05-18 10:59:02",
      "modifyTime": "2020-05-18 10:59:02"
    }
  ],
  "totalCount": 1
}

5.9. 导入已部署合约的abi

将其他平台已部署的合约导入到本平台进行管理

5.9.1 传输协议规范

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

5.9.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	所属群组编号
2	contractAddress	String	否	合约地址
3	contractName	String	否	合约名称
4	contractAbi	String	否	合约编译后生成的abi文件内容

2）入参示例

{
    "groupId": 1,
    "contractAddress": "0x3214227e87bccca63893317febadd0b51ade735e",
    "contractName": "HelloWorld",
    "contractAbi": [{"constant":false,"inputs":[{"name":"n","type":"string"}],"name":"set","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":true,"inputs":[],"name":"get","outputs":[{"name":"","type":"string"}],"payable":false,"stateMutability":"view","type":"function"},{"anonymous":false,"inputs":[{"indexed":false,"name":"name","type":"string"}],"name":"SetName","type":"event"}]
}

5.9.3 返回参数

1）出参表

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

2）出参示例

成功：

{
    "code": 0,
    "message": "success"
}

5.10. 导入已部署合约的abi

将其他平台已部署的合约导入到本平台进行管理

5.10.1 传输协议规范

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

5.10.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	abiId	long	否	abi编号
2	groupId	int	否	所属群组编号
3	contractAddress	String	否	合约地址
4	contractName	String	否	合约名称
5	contractAbi	String	否	合约编译后生成的abi文件内容

2）入参示例

{
    "abiId": 1,
    "groupId": 1,
    "contractAddress": "0x3214227e87bccca63893317febadd0b51ade735e",
    "contractName": "HelloWorld",
    "contractAbi": [{"constant":false,"inputs":[{"name":"n","type":"string"}],"name":"set","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":true,"inputs":[],"name":"get","outputs":[{"name":"","type":"string"}],"payable":false,"stateMutability":"view","type":"function"},{"anonymous":false,"inputs":[{"indexed":false,"name":"name","type":"string"}],"name":"SetName","type":"event"}]
}

5.10.3 返回参数

1）出参表

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

2）出参示例

成功：

{
    "code": 0,
    "message": "success"
}

6 服务器监控相关

6.1 获取节点监控信息

6.1.1 传输协议规范

网络传输协议：使用HTTP协议
请求地址：

/chain/mointorInfo/{nodeId}?beginDate={beginDate}&endDate={endDate}&contrastBeginDate={contrastBeginDate}&contrastEndDate={contrastEndDate}&gap={gap}

请求方式：GET
返回格式：JSON

6.1.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	nodeId	int	否	群组id
2	beginDate	LocalDateTime	是	显示时间（开始） yyyy-MM-dd’T’HH:mm:ss.SSS 2019-03-13T00:00:00
3	endDate	LocalDateTime	是	显示时间（结束）
4	contrastBeginDate	LocalDateTime	是	对比时间（开始）
5	contrastEndDate	LocalDateTime	是	对比时间（结束）
6	gap	Int	是	数据粒度

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/chain/mointorInfo/500001?gap=60&beginDate=2019-03-13T00:00:00&endDate=2019-03-13T14:34:22&contrastBeginDate=2019-03-13T00:00:00&contrastEndDate=2019-03-13T14:34:22

6.1.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	int	否	返回码
2	message	String	否	描述信息
3	data	Array	否	返回信息列表
3.1		Object		返回信息实体
3.1.1	metricType	String	否	测量类型：blockHeight、pbftView
3.1.2	data	Object	否
3.1.2.1	lineDataList	Object	否
3.1.2.1.1	timestampList	List\<String>	否	时间戳列表
3.1.2.1.2	valueList	List\<Integer>	否	值列表
3.1.2.2	contrastDataList	Object	否
3.1.2.2.1	timestampList	List\<String>	否	时间戳列表
3.1.2.2.2	valueList	List\<Integer>	否	值列表

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "metricType": "blockHeight",
            "data": {
                "lineDataList": {
                    "timestampList": [
                        1552406401042,
                        1552406701001
                    ],
                    "valueList": [
                        747309,
                        747309
                    ]
                },
                "contrastDataList": {
                    "timestampList": [
                        1552320005000,
                        1552320301001
                    ],
                    "valueList": [
                        null,
                        747309
                    ]
                }
            }
        },
        {
            "metricType": "pbftView",
            "data": {
                "lineDataList": {
                    "timestampList": null,
                    "valueList": [
                        118457,
                        157604
                    ]
                },
                "contrastDataList": {
                    "timestampList": null,
                    "valueList": [
                        null,
                        33298
                    ]
                }
            }
        }
    ]
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

6.2 获取服务器监控信息

6.2.1 传输协议规范

网络传输协议：使用HTTP协议
请求地址：

performance/ratio/{nodeId}?gap={gap}&beginDate={beginDate}&endDate={endDate}&contrastBeginDate={contrastBeginDate}&contrastEndDate={contrastEndDate}

请求方式：GET
返回格式：JSON

6.2.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	nodeId	int	否	群组id
2	beginDate	LocalDateTime	是	显示时间（开始） yyyy-MM-dd’T’HH:mm:ss.SSS 2019-03-13T00:00:00
3	endDate	LocalDateTime	是	显示时间（结束）
4	contrastBeginDate	LocalDateTime	是	对比时间（开始）
5	contrastEndDate	LocalDateTime	是	对比时间（结束）
6	gap	Int	是	数据粒度

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/performance/ratio/500001?gap=1&beginDate=2019-03-15T00:00:00&endDate=2019-03-15T15:26:55&contrastBeginDate=2019-03-15T00:00:00&contrastEndDate=2019-03-15T15:26:55

6.2.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	int	否	返回码
2	message	String	否	描述信息
3	data	Array	否	返回信息列表
3.1		Object		返回信息实体
3.1.1	metricType	String	否	测量类型: cpu、memory、disk、txbps、rxbps
3.1.2	data	Object	否
3.1.2.1	lineDataList	Object	否
3.1.2.1.1	timestampList	List\<String>	否	时间戳列表
3.1.2.1.2	valueList	List\<Integer>	否	值列表
3.1.2.2	contrastDataList	Object	否
3.1.2.2.1	timestampList	List\<String>	否	时间戳列表
3.1.2.2.2	valueList	List\<Integer>	否	值列表

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "metricType": "txbps",
            "data": {
                "lineDataList": {
                    "timestampList": [
                        1552406401042,
                        1552406701001
                    ],
                    "valueList": [
                        12.24,
                        54.48
                    ]
                },
                "contrastDataList": {
                    "timestampList": [
                        1552320005000,
                        1552320301001
                    ],
                    "valueList": [
                        22.24,
                        24.48
                    ]
                }
            }
        },
        {
            "metricType": "cpu",
            "data": {
                "lineDataList": {
                    "timestampList": null,
                    "valueList": [
                        118457,
                        157604
                    ]
                },
                "contrastDataList": {
                    "timestampList": null,
                    "valueList": [
                        null,
                        33298
                    ]
                }
            }
        }
    ]
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

6.3 获取邮件告警配置

配置邮件告警的邮件服务器的相关参数，包含协议类型protocol、邮件服务器地址host、端口port、用户邮箱地址username、用户邮箱授权码password；包含Authentication验证开关（默认开启）authentication，以及邮件告警模块的开关enable；

注：邮件告警的邮箱协议类型默认使用SMTP协议，使用25默认端口，默认使用username/password进行用户验证，目前仅支持通过TLS/SSL连接邮件服务器；

6.3.1 传输协议规范

网络传输协议：使用HTTP协议
请求地址： /mailServer/config/{serverId}
请求方式：GET
请求头：Content-type: application/json
返回格式：JSON

6.3.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	serverId	Int	否	邮件服务的编号

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/mailServer/config/1

6.3.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	Object	否	成功时返回
3.1		Object		返回信息实体
3.1.1	serverId	Int	否	邮件服务器的编号
3.1.2	serverName	String	否	邮件服务器的名字
3.1.3	host	String	否	邮件服务器的主机地址
3.1.4	port	Int	否	邮件服务器的端口号
3.1.5	username	String	否	邮件服务器的用户地址
3.1.6	password	String	否	邮件服务器的用户授权码
3.1.7	protocol	String	否	邮件服务器的协议
3.1.8	defaultEncoding	String	否	邮件服务器的编码
3.1.9	authentication	Int	否	开启验证：0-关闭，1-开启
3.1.10	starttlsEnable	Int	否	开启优先使用STARTTLS：0-关闭，1-开启
3.1.11	enable	Int	否	开启邮件服务器：0-关闭，1-开启
3.1.12	starttlsRequired	Int	否	必须使用STARTTLS：0-关闭，1-开启
3.1.13	socketFactoryPort	Int	否	TLS使用的端口号
3.1.14	socketFactoryClass	String	否	TLS使用的java类
3.1.15	socketFactoryFallback	Int	否	开启TLS Fallback函数：0-关闭，1-开启
3.1.16	timeout	Int	否	从邮箱服务器读取超时时间
3.1.17	connectionTimeout	Int	否	邮箱服务器连接超时时间
3.1.18	writeTimeout	Int	否	从邮箱服务器写超时时间
3.1.19	createTime	LocalDateTime	否	创建时间
3.1.20	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "serverId": 1,
        "serverName": "Default config",
        "host": "smtp.qq.com",
        "port": 25,
        "username": "yourmail@qq.com",
        "password": "yourpassword",
        "protocol": "smtp",
        "defaultEncoding": "UTF-8",
        "createTime": "2019-10-29 20:02:30",
        "modifyTime": "2019-10-29 20:02:30",
        "authentication": 1,
        "starttlsEnable": 1,
        "starttlsRequired": 0,
        "socketFactoryPort": 465,
        "socketFactoryClass": "javax.net.ssl.SSLSocketFactory",
        "socketFactoryFallback": 0,
        "enable": 0,
        "timeout": 5000,
        "connectionTimeout": 5000,
        "writeTimeout": 5000
    }
}

6.4 获取全部邮件告警配置

返回所有的邮件告警的邮件服务配置

6.4.1 传输协议规范

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

6.4.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
-	-	-	-	-

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/mailServer/config/list

6.4.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	List	否	成功时返回
3.1		Object		返回信息实体
3.1.1	serverId	Int	否	邮件服务器的编号
3.1.2	serverName	String	否	邮件服务器的名字
3.1.3	host	String	否	邮件服务器的主机地址
3.1.4	port	Int	否	邮件服务器的端口号
3.1.5	username	String	否	邮件服务器的用户地址
3.1.6	password	String	否	邮件服务器的用户授权码
3.1.7	protocol	String	否	邮件服务器的协议
3.1.8	defaultEncoding	String	否	邮件服务器的编码
3.1.9	authentication	Int	否	开启验证：0-关闭，1-开启
3.1.10	starttlsEnable	Int	否	开启优先使用STARTTLS：0-关闭，1-开启
3.1.11	enable	Int	否	开启邮件服务器：0-关闭，1-开启
3.1.12	starttlsRequired	Int	否	必须使用STARTTLS：0-关闭，1-开启
3.1.13	socketFactoryPort	Int	否	TLS使用的端口号
3.1.14	socketFactoryClass	String	否	TLS使用的java类
3.1.15	socketFactoryFallback	Int	否	开启TLS Fallback函数：0-关闭，1-开启
3.1.16	timeout	Int	否	从邮箱服务器读取超时时间
3.1.17	connectionTimeout	Int	否	邮箱服务器连接超时时间
3.1.18	writeTimeout	Int	否	从邮箱服务器写超时时间
3.1.19	createTime	LocalDateTime	否	创建时间
3.1.20	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "serverId": 1,
            "serverName": "Default config",
            "host": "smtp.qq.com",
            "port": 25,
            "username": "yourmail@qq.com",
            "password": "yourpassword",
            "protocol": "smtp",
            "defaultEncoding": "UTF-8",
            "createTime": "2019-10-29 20:02:30",
            "modifyTime": "2019-10-29 20:02:30",
            "authentication": 1,
            "starttlsEnable": 1,
            "starttlsRequired": 0,
            "socketFactoryPort": 465,
            "socketFactoryClass": "javax.net.ssl.SSLSocketFactory",
            "socketFactoryFallback": 0,
            "enable": 0,
            "timeout": 5000,
            "connectionTimeout": 5000,
            "writeTimeout": 5000
        }
    ]
}

6.5 更新邮件告警配置

更新邮件告警的配置内容；目前仅支持单个邮件服务器配置，不支持新增配置；

6.5.1 传输协议规范

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

6.5.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	serverId	int	否	邮件告警配置的编号
2	protocol	String	否	邮件服务的协议类型，小写（发件服务器默认使用smtp）
3	host	String	否	邮件服务的地址
4	port	int	否	邮件服务使用的端口，默认25
5	username	String	是	邮件服务的用户邮箱地址，authentication开启时为必填
6	password	String	是	邮件服务的用户邮箱授权码，authentication开启时为必填
7	authentication	int	否	是否启用验证，默认使用username/password验证：0-关闭，1-开启
8	enable	int	否	是否启用邮件服务：0-关闭，1-开启

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/mailServer/config

{
    "serverId": 1,
    "host": "smtp.qq.com",
    "port": 25,
    "username": "yourmail@qq.com",
    "password": "yourpassword",
    "protocol": "smtp",
    "authentication": 1,
    "enable": 1
}

6.5.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	Object	否	返回邮件服务配置的具体内容
3.1		Object	否	参数含义参考上文GET接口出参表

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "serverId": 1,
        "serverName": "Default config",
        "host": "smtp.qq.com",
        "port": 25,
        "username": "yourmail@qq.com",
        "password": "yourpassword",
        "protocol": "smtp",
        "defaultEncoding": "UTF-8",
        "createTime": "2019-10-29 20:02:30",
        "modifyTime": "2019-11-07 10:04:47",
        "authentication": 1,
        "starttlsEnable": 1,
        "starttlsRequired": 0,
        "socketFactoryPort": 465,
        "socketFactoryClass": "javax.net.ssl.SSLSocketFactory",
        "socketFactoryFallback": 0,
        "enable": 1,
        "timeout": 5000,
        "connectionTimeout": 5000,
        "writeTimeout": 5000
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

6.6 发送测试邮件

使用当前的邮件服务配置，向指定的邮箱地址发送测试邮件，如果配置错误将发送失败；

注：需要确保配置正确才能使用后续的邮件告警功能；返回成功信息后，需要用户到自己的邮箱查看是否收到邮测试邮件；

6.6.1 传输协议规范

网络传输协议：使用HTTP协议
请求地址： /alert/mail/test/{toMailAddress}
请求方式：POST
请求头：Content-type: application/json
返回格式：JSON

6.6.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	{toMailAddress}	String	否	接收测试邮件的邮箱地址
2	host	String	否	邮件服务的地址
3	port	int	否	邮件服务使用的端口，默认25
4	protocol	String	是	邮件服务的协议类型，默认使用smtp
5	defaultEncoding	String	是	邮件服务的邮件编码格式，默认为UTF-8编码
6	username	String	否	邮件服务的用户邮箱地址，authentication开启时为必填
7	password	String	否	邮件服务的用户邮箱授权码，authentication开启时为必填
8	authentication	int	否	开启鉴权验证，默认开启（使用username/password验证）0-关闭，1-开启
9	starttlsEnable	int	是	开启优先使用STARTTLS，默认开启 0-关闭，1-开启
10	starttlsRequired	int	是	开启必须使用STARTTLS，默认关闭，开启时需要配置socketFactoryPort, socketFactoryClass, socketFactoryFallback 0-关闭，1-开启
11	socketFactoryPort	String	是	TLS/SSL的Socket端口，默认465
12	socketFactoryClass	String	是	TLS/SSL的Socket工厂类
13	socketFactoryFallback	int	是	开启Socket的Fallback函数，默认关闭 0-关闭，1-开启
14	timeout	int	是	读超时时间值，默认5000ms
15	connectionTimeout	int	是	连接超时时间值，默认5000ms
16	writeTimeout	int	是	写超时时间值，默认5000ms

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/alert/mail/test/yourmail@qq.com

{
    "host": "smtp.qq.com",
    "port": 25,
    "username": "yourmail@qq.com",
    "password": "yourpassword",
    "protocol": "smtp",
    "defaultEncoding": "UTF-8",
    "authentication": 1,
    "starttlsEnable": 1,
    "starttlsRequired": 0,
    "socketFactoryPort": 465,
    "socketFactoryClass": "javax.net.ssl.SSLSocketFactory",
    "socketFactoryFallback": 0,
    "timeout": 5000,
    "connectionTimeout": 5000,
    "writeTimeout": 5000
}

6.6.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	Object	否	错误时返回错误原因

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": null
}

失败：

{
    "code": 202080,
    "message": "Send mail error, please check mail server configuration.",
    "data": "Failed messages: javax.mail.SendFailedException: No recipient addresses"
}

6.7 获取告警类型配置

获取单个告警配置的内容；告警类型配置是对不同告警类型下的不同内容，包含告警邮件标题ruleName，告警邮件内容alertContent，告警邮件发送时间间隔alertIntervalSeconds，上次告警时间lastAlertTime，目标告警邮箱地址列表userList，是否启用该类型的邮件告警enable，告警等级alertLevel等；

6.7.1 传输协议规范

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

6.7.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	ruleId	Int	否	告警配置的编号

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/alert/1

6.7.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	Object	否	成功时返回
3.1		Object		返回信息实体
3.1.1	ruleId	Int	否	告警类型配置的编号
3.1.2	ruleName	String	否	告警类型的名字/告警邮件标题
3.1.3	enable	Int	否	是否开启该告警：0-关闭，1-开启
3.1.4	alertType	Int	否	告警类型：1-节点状态告警，2-审计告警，3-证书有效期
3.1.5	alertLevel	Int	否	告警等级：1-高，2-中，3-低
3.1.6	alertIntervalSeconds	Long	否	告警邮件发送时间间隔
3.1.7	alertContent	String	否	告警邮件内容，其中包含{}括起来的变量
3.1.8	contentParamList	String	否	告警邮件内容中变量的列表，由`List<String>`序列化为String
3.1.9	description	String	否	告警描述
3.1.10	userList	Int	否	目标告警邮箱地址列表，由`List<String>`序列化为String
3.1.11	lastAlertTime	LocalDateTime	否	上次告警时间
3.1.12	isAllUser	Int	否	发送给所有用户：0-关闭，1-开启
3.1.13	createTime	LocalDateTime	否	创建时间
3.1.14	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "ruleId": 1,
        "ruleName": "节点异常告警",
        "enable": 0,
        "alertType": 1,
        "alertLevel": 1,
        "alertIntervalSeconds": 3600,
        "alertContent": "{nodeId}节点异常，请到\"节点管理\"页面查看具体信息",
        "contentParamList": "[\"{nodeId}\"]",
        "description": null,
        "createTime": "2019-10-29 20:02:30",
        "modifyTime": "2019-10-29 20:02:30",
        "isAllUser": 0,
        "userList": "[\"targetmail@qq.com\"]",
        "lastAlertTime": null
    }
}

6.8 获取全部告警类型配置列表

返回所有的告警类型配置

6.8.1 传输协议规范

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

6.8.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
-	-	-	-	-

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/alert/list

6.8.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	List	否	成功时返回
3.1		Object		返回信息实体
3.1.1	ruleId	Int	否	告警类型配置的编号
3.1.2	ruleName	String	否	告警类型的名字/告警邮件标题
3.1.3	enable	Int	否	是否开启该告警：0-关闭，1-开启
3.1.4	alertType	Int	否	告警类型：1-节点状态告警，2-审计告警，3-证书有效期
3.1.5	alertLevel	Int	否	告警等级：1-高，2-中，3-低
3.1.6	alertIntervalSeconds	Long	否	告警邮件发送时间间隔
3.1.7	alertContent	String	否	告警邮件内容，其中包含{}括起来的变量
3.1.8	contentParamList	String	否	告警邮件内容中变量的列表，由`List<String>`序列化为String
3.1.9	description	String	否	告警描述
3.1.10	userList	Int	否	目标告警邮箱地址列表，由`List<String>`序列化为String
3.1.11	lastAlertTime	LocalDateTime	否	上次告警时间
3.1.12	isAllUser	Int	否	发送给所有用户：0-关闭，1-开启
3.1.13	createTime	LocalDateTime	否	创建时间
3.1.14	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "ruleId": 1,
            "ruleName": "节点异常告警",
            "enable": 0,
            "alertType": 1,
            "alertLevel": 1,
            "alertIntervalSeconds": 3600,
            "alertContent": "{nodeId}节点异常，请到\"节点管理\"页面查看具体信息",
            "contentParamList": "[\"{nodeId}\"]",
            "description": null,
            "createTime": "2019-10-29 20:02:30",
            "modifyTime": "2019-10-29 20:02:30",
            "isAllUser": 0,
            "userList": "[\"targetmail@qq.com\"]",
            "lastAlertTime": null
        },
        {
            "ruleId": 2,
            "ruleName": "审计异常",
            "enable": 0,
            "alertType": 2,
            "alertLevel": 1,
            "alertIntervalSeconds": 3600,
            "alertContent": "审计异常：{auditType}，请到\"交易审计\"页面查看具体信息",
            "contentParamList": "[\"{auditType}\"]",
            "description": null,
            "createTime": "2019-10-29 20:02:30",
            "modifyTime": "2019-10-29 20:02:30",
            "isAllUser": 0,
            "userList": "[\"targetmail@qq.com\"]",
            "lastAlertTime": null
        },
        {
            "ruleId": 3,
            "ruleName": "证书有效期告警",
            "enable": 0,
            "alertType": 3,
            "alertLevel": 1,
            "alertIntervalSeconds": 3600,
            "alertContent": "证书将在{time}过期，请到\"证书管理\"页面查看具体信息",
            "contentParamList": "[\"{time}\"]",
            "description": null,
            "createTime": "2019-10-29 20:02:30",
            "modifyTime": "2019-10-29 20:02:30",
            "isAllUser": 0,
            "userList": "[\"targetmail@qq.com\"]",
            "lastAlertTime": null
        }
    ]
}

6.9 更新告警类型配置

更新告警类型配置的内容；目前仅支持更新原有的三个邮件告警的配置，不支持新增配置；

6.9.1 传输协议规范

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

6.9.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	ruleId	int	否	告警类型配置编号
2	ruleName	String	是	告警邮件的标题
3	enable	int	否	是否启用该类型的告警：0-关闭，1-开启
4	alertType	int	是	告警类型：1-节点状态告警，2-审计告警，3-证书有效期告警
6	alertIntervalSeconds	int	是	告警邮件的发送间隔时间（秒），默认3600s
7	alertContent	String	是	告警邮件的内容，其中大括号`{}`及里面的英文变量不可去除
8	userList	String	否	接收告警邮件的邮箱列表，以`List<String>`序列化得到的字符串
9	alertLevel	Int	是	告警等级：1-高，2-中，3-低

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/mailServer/config

{
    "ruleId": 3,
    "ruleName": "证书有效期告警",
    "enable": 0,
    "alertType": 3,
    "alertIntervalSeconds": 1800,
    "alertContent": "证书将在{time}过期，请到\"证书管理\"页面查看具体信息",
    "userList": "[\"targetmail@qq.com\"]",
    "alertLevel": 1
}

6.9.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	Object	否	返回邮件服务配置的具体内容
3.1		Object	否	参数含义参考上文GET接口出参表

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "ruleId": 3,
        "ruleName": "证书有效期告警",
        "enable": 0,
        "alertType": 3,
        "alertLevel": 1,
        "alertIntervalSeconds": 1800,
        "alertContent": "证书将在{time}过期，请到\"证书管理\"页面查看具体信息",
        "contentParamList": "[\"{time}\"]",
        "description": null,
        "createTime": "2019-10-29 20:02:30",
        "modifyTime": "2019-11-07 10:35:03",
        "isAllUser": 0,
        "userList": "[\"targetmail@qq.com\"]",
        "lastAlertTime": null
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

6.9 开启/关闭告警类型

修改告警类型配置中的enable，0-关闭，1-开启；

6.9.1 传输协议规范

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

6.9.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	ruleId	int	否	告警类型配置编号
2	enable	int	否	是否启用该类型的告警：0-关闭，1-开启

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/alert/toggle

{
   "ruleId": 3,
   "enable": 1
}

6.9.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	Object	否	返回邮件服务配置的具体内容
3.1		Object	否	参数含义参考上文GET接口出参表

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "ruleId": 3,
        "ruleName": "证书有效期告警",
        "enable": 1,
        "alertType": 3,
        "alertLevel": 1,
        "alertIntervalSeconds": 1800,
        "alertContent": "证书将在{time}过期，请到\"证书管理\"页面查看具体信息",
        "contentParamList": "[\"{time}\"]",
        "description": null,
        "createTime": "2019-10-29 20:02:30",
        "modifyTime": "2019-11-07 10:35:03",
        "isAllUser": 0,
        "userList": "[\"targetmail@qq.com\"]",
        "lastAlertTime": null
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

7 审计相关模块

7.1 获取用户交易监管信息列表

7.1.1 传输协议规范

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

7.1.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	所属群组编号

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/monitor/userList/300001

7.1.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	List	是	信息列表
3.1		Object	是	监管信息对象
3.1.1	userName	String	是	用户名称
3.1.2	userType	Int	是	用户类型(0-正常，1-异常)
3.1.3	groupId	Int	是	所属群组
3.1.4	contractName	String	是	合约名称
3.1.5	contractAddress	String	是	合约地址
3.1.6	interfaceName	String	是	合约接口名
3.1.7	transType	Int	是	交易类型(0-合约部署，1-接口调用)
3.1.8	transUnusualType	Int	是	交易异常类型 (0-正常，1-异常合约，2-异常接口)
3.1.9	transCount	Int	是	交易量
3.1.10	transHashs	String	是	交易hashs(最多5个)
3.1.11	transHashLastest	String	是	最新交易hash
3.1.12	createTime	LocalDateTime	是	落库时间
3.1.13	modifyTime	LocalDateTime	是	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "userName": "SYSTEMUSER",
            "userType": 0,
            "groupId": null,
            "contractName": null,
            "contractAddress": null,
            "interfaceName": null,
            "transType": null,
            "transUnusualType": null,
            "transCount": null,
            "transHashs": null,
            "transHashLastest": null,
            "createTime": null,
            "modifyTime": null
        },
        {
            "userName": "asdf",
            "userType": 0,
            "groupId": null,
            "contractName": null,
            "contractAddress": null,
            "interfaceName": null,
            "transType": null,
            "transUnusualType": null,
            "transCount": null,
            "transHashs": null,
            "transHashLastest": null,
            "createTime": null,
            "modifyTime": null
        }
    ]
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

7.2 获取合约方法监管信息列表

7.2.1 传输协议规范

网络传输协议：使用HTTP协议
请求地址：/monitor/interfaceList/{groupId}?userName={userName}
请求方式：GET
返回格式：JSON

7.2.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	所属群组编号
2	userName	String	是	用户名

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/monitor/interfaceList/300001

7.2.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	List	是	信息列表
3.1		Object	是	监管信息对象
3.1.1	userName	String	是	用户名称
3.1.2	userType	Int	是	用户类型(0-正常，1-异常)
3.1.3	groupId	Int	是	所属群组
3.1.4	contractName	String	是	合约名称
3.1.5	contractAddress	String	是	合约地址
3.1.6	interfaceName	String	是	合约接口名
3.1.7	transType	Int	是	交易类型(0-合约部署，1-接口调用)
3.1.8	transUnusualType	Int	是	交易异常类型 (0-正常，1-异常合约，2-异常接口)
3.1.9	transCount	Int	是	交易量
3.1.10	transHashs	String	是	交易hashs(最多5个)
3.1.11	transHashLastest	String	是	最新交易hash
3.1.12	createTime	LocalDateTime	是	落库时间
3.1.13	modifyTime	LocalDateTime	是	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "userName": "SYSTEMUSER",
            "userType": 0,
            "groupId": null,
            "contractName": null,
            "contractAddress": null,
            "interfaceName": null,
            "transType": null,
            "transUnusualType": null,
            "transCount": null,
            "transHashs": null,
            "transHashLastest": null,
            "createTime": null,
            "modifyTime": null
        },
        {
            "userName": "asdf",
            "userType": 0,
            "groupId": null,
            "contractName": null,
            "contractAddress": null,
            "interfaceName": null,
            "transType": null,
            "transUnusualType": null,
            "transCount": null,
            "transHashs": null,
            "transHashLastest": null,
            "createTime": null,
            "modifyTime": null
        }
    ]
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

7.3 获取交易hash监管信息列表

7.3.1 传输协议规范

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

7.3.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	所属群组编号
2	userName	String	是	用户名
3	startDate	String		开始时间
4	endDate	String		结束时间
5	interfaceName	String		接口名称

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/monitor/transList/300001?userName=0x5d97f8d41638a7b1b669b70b307bab6d49df8e2c&interfaceName=0x4ed3885e

7.3.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	Object	否	返回结果实体
3.1	groupId	Int	否	所属群组编号
3.2	userName	String	否	用户名
3.3	interfaceName	String	否	接口名
3.4	totalCount	Int	否	总记录数
3.5	transInfoList	List\<Object>	是	交易信息列表
3.5.1		Object	是	交易信息实体
3.5.1.1	transCount	Int	是	交易记录数
3.5.1.2	time	LcalDateTime	是	时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "groupId": 300001,
        "userName": "0x5d97f8d41638a7b1b669b70b307bab6d49df8e2c",
        "interfaceName": "0x4ed3885e",
        "totalCount": 1,
        "transInfoList": [
            {
                "transCount": 1,
                "time": "2019-03-13 15:41:56"
            }
        ]
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

7.4 获取异常用户信息列表

7.4.1 传输协议规范

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

7.4.2 参数信息详情

请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	所属群组编号
2	userName	String	是	用户名
3	pageNumber	int	否	当前页码
4	pageSize	int	否	页面大小

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/monitor/unusualUserList/300001/1/10?userName=

7.4.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	totalCount	Int	否	总记录数
4	data	List	否	返回信息列表
4.1		object	是	返回信息实体
4.1.1	userName	String	是	用户名
4.1.2	transCount	int	是	交易数
4.1.3	hashs	String	是	交易hash
4.1.4	time	LocalDateTime	是	时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "userName": "0x08b52f85638a925929cf62a3ac77c67415012c24",
            "transCount": 1,
            "hashs": "0x43b50faa3f007c22cf5dd710c3561c5cde516e01a55b5b4acffd7d94cf61fc57",
            "time": "2019-03-13 22:28:29"
        }
    ],
    "totalCount": 1
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

7.5 获取异常合约信息列表

7.5.1 传输协议规范

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

7.5.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	所属群组编号
2	contractAddress	String	是	合约地址
3	pageNumber	int	否	当前页码
4	pageSize	int	否	页面大小

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/monitor/unusualContractList/300001/1/10?contractAddress=

7.5.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	totalCount	Int	否	总记录数
4	data	List	否	返回信息列表
4.1		object	是	返回信息实体
4.1.1	contractName	String	是	合约名称
4.1.2	contractAddress	String	是	合约地址
4.1.3	transCount	int	是	交易数
4.1.4	hashs	String	是	交易hash
4.1.5	time	LocalDateTime	是	时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "totalCount": 1,
    "data": [
        {
            "contractName": "0x00000000",
            "contractAddress": "0x0000000000000000000000000000000000000000",
            "transCount": 3,
            "hashs": "0xc87e306db85740895369cc2a849984fe544a6e9b0ecdbd2d898fc0756a02a4ce",
            "time": "2019-03-13 15:41:56"
        }
    ]
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

8 群组信息模块

8.1 获取群组概况

8.1.1 传输协议规范

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

8.1.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组id

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/group/300001

8.1.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	object	否	返回信息实体
3.1	groupId	int	否	群组id
3.2	nodeCount	int	否	节点数量
3.3	contractCount	int	否	已部署智能合约数量
3.4	transactionCount	int	否	交易数量
3.5	latestBlock	int	否	当前块高

2）出参示例

成功：

{
    "code": 0,
    "data": {
        "latestBlock": 7156,
        "contractCount": 0,
        "groupId": "300001",
        "nodeCount": 2,
        "transactionCount": 7131
    },
    "message": "Success"
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

8.2 获取所有群组列表

默认只返回groupStatus为1的群组ID，可传入groupStatus筛选群组 (1-normal, 2-maintaining, 3-conflict-genesisi, 4-conflict-data)

8.2.1 传输协议规范

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

8.2.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupStatus	int	是	群组状态，1-normal, 2-maintaining, 3-conflict-genesisi, 4-conflict-data

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/group/all
http://127.0.0.1:5001/WeBASE-Node-Manager/group/all/{groupStatus}

8.2.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	totalCount	Int	否	总记录数
4	data	List	否	组织列表
4.1		Object		组织信息对象
4.1.1	groupId	Integer	否	群组编号
4.1.2	groupName	String	否	群组名称
4.1.2	groupStatus	Integer	否	群组状态：1-正常, 2-维护中, 3-脏数据, 4-创世块冲突
4.1.2	nodeCount	Integer	否	群组节点数
4.1.3	latestBlock	BigInteger	否	最新块高
4.1.4	transCount	BigInteger	否	交易量
4.1.5	createTime	LocalDateTime	否	落库时间
4.1.6	modifyTime	LocalDateTime	否	修改时间
4.1.2	description	String	否	群组描述
4.1.2	groupType	Integer	否	群组类别：1-同步，2-动态创建

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "totalCount": 1,
    "data": [
        {
            "groupId":1,
            "groupName":"group1",
            "groupStatus":1,
            "nodeCount":4,
            "latestBlock":0,
            "transCount":0,
            "createTime":"2020-05-07 16:32:02",
            "modifyTime":"2020-05-08 10:50:13",
            "description":"synchronous",
            "groupType":1
        }
    ]
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

8.3 查询每日交易数据

8.3.1 传输协议规范

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

8.3.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组id

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/group/transDaily/300001

8.3.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	list	否	返回信息列表
3.1		object		返回信息实体
4.1	day	string	否	日期YYYY-MM-DD
4.2	groupId	int	否	群组编号
4.3	transCount	int	否	交易数量

2）出参示例

成功：

{
    "code": 0,
    "data": [
        {
            "day": "2018-11-21",
            "groupId": "300001",
            "transCount": 12561
        },
        {
            "day": "2018-11-22",
            "groupId": "300001",
            "transCount": 1251
        }
    ],
    "message": "Success"
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

8.4 向单个节点生成新群组

向单个节点的前置发起请求，以当前时间生成timestamp时间戳，nodeList为群组创世块的共识节点列表，生成新群组配置信息；节点和前置一一对应，节点编号可以从前置列表获取。

nodeList需要填入新群组中所有的nodeId，通过本接口分别请求每个节点，在每个节点生成群组配置信息。

群组生成后，需对应调用新群组启动的接口，并确保新节点加入新群组的共识节点/观察节点

节点加入已存在群组并启动后，可调用POST /precompiled/consensus接口将该节点加入到新加入群组的共识节点或观察节点中

8.4.1 传输协议规范

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

8.4.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	nodeId	String	否	路径变量：节点id
2	generateGroupId	Integer	否	新群组编号
3	timestamp	Integer	否	群组创世块时间戳
4	nodeList	List	否	新群组中所有共识节点
5	description	String	是	群组描述

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/group/generate/78e467957af3d0f77e19b952a740ba8c53ac76913df7dbd48d7a0fe27f4c902b55e8543e1c4f65b4a61695c3b490a5e8584149809f66e9ffc8c05b427e9d3ca2

{
    "generateGroupId": 2,
    "timestamp": 1574853659000,
    "nodeList": [
       "78e467957af3d0f77e19b952a740ba8c53ac76913df7dbd48d7a0fe27f4c902b55e8543e1c4f65b4a61695c3b490a5e8584149809f66e9ffc8c05b427e9d3ca2",
       "dd7a2964007d583b719412d86dab9dcf773c61bccab18cb646cd480973de0827cc94fa84f33982285701c8b7a7f465a69e980126a77e8353981049831b550f5c"
    ],
    "description": "test"
}

8.4.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	List	否	组织列表
3.1		Object		组织信息对象
3.1.1	groupId	int	否	群组编号
3.1.2	groupName	String	否	群组名称
3.1.3	groupStatus	Integer	否	群组状态：1-正常, 2-维护中, 3-脏数据, 4-创世块冲突
3.1.4	nodeCount	Integer	否	群组节点数
3.1.5	description	String	否	描述
3.1.6	groupType	Integer	否	群组类型： 1-同步 2-动态创建
3.1.7	createTime	LocalDateTime	否	落库时间
3.1.8	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "groupId": 2,
        "groupName": "group2",
        "nodeCount": 2,
        "groupStatus": 2,
        "groupType": 2,
        "description": "test",
        "createTime": "2019-02-14 17:33:50",
        "modifyTime": "2019-03-15 09:36:17"
    }
}

失败：

{
    "code": 202301,
    "message": "node's front not exists",
    "data": {}
}

8.5 向多个节点生成新群组

向nodeList中所有节点的前置发起请求，以当前时间生成timestamp时间戳，以nodeList为创世块的共识节点列表，生成新群组配置信息；节点和前置一一对应，节点编号可以从前置列表获取。

群组生成后，需对应调用新群组启动的接口，并确保新节点加入新群组的共识节点/观察节点

节点加入已存在群组并启动后，可调用POST /precompiled/consensus接口将该节点加入到新加入群组的共识节点或观察节点中

8.5.1 传输协议规范

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

8.5.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	generateGroupId	Integer	否	新群组编号
2	timestamp	Integer	否	群组创世块时间戳
3	nodeList	List	否	新群组中所有共识节点
4	description	String	是	群组描述

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/group/generate

{
    "generateGroupId": 2,
    "timestamp": 1574853659000,
    "nodeList": [
       "78e467957af3d0f77e19b952a740ba8c53ac76913df7dbd48d7a0fe27f4c902b55e8543e1c4f65b4a61695c3b490a5e8584149809f66e9ffc8c05b427e9d3ca2",
       "dd7a2964007d583b719412d86dab9dcf773c61bccab18cb646cd480973de0827cc94fa84f33982285701c8b7a7f465a69e980126a77e8353981049831b550f5c"
    ],
    "description": "test"
}

8.5.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	List	否	群组操作结果
3.1	frontId	Integer	否	群组操作请求的节点前置编号
3.2	code	Integer	否	群组操作结果，0-成功，其他：失败

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [{
        "frontId": 500011,
        "code": 0
    }, {
        "frontId": 500013,
        "code": 1
    }]
}

失败：

{
    "code": 202301,
    "message": "node's front not exists",
    "data": {}
}

8.6 动态操作群组

可以对已存在的群组或新生成的群组进行动态操作，包括启动、停止、删除、恢复、状态查询。

说明： 生成新群组后，需要向每个前置调用启动群组的操作，并确保新节点是新群组中的共识节点/观察节点

节点加入已存在群组并启动后，可调用POST /precompiled/consensus接口将该节点加入到新加入群组的共识节点或观察节点中

8.6.1 传输协议规范

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

8.6.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	nodeId	String	否	路径变量：节点id
2	generateGroupId	Integer	否	新群组编号
3	type	String	否	操作类型： start, stop, remove, recover, getStatus

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/group/operate/78e467957af3d0f77e19b952a740ba8c53ac76913df7dbd48d7a0fe27f4c902b55e8543e1c4f65b4a61695c3b490a5e8584149809f66e9ffc8c05b427e9d3ca2

{
    "generateGroupId": 2,
    "type": "start"
}

8.6.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {}
}

失败：

{
  "code": 205032,
  "message": "Group 2 is already running",
  "data": null
}

8.7 批量启动群组

批量启动多个节点的群组，向nodeList中所有节点批量发起启动群组的请求；nodeId可以从前置列表获取。

8.7.1 传输协议规范

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

8.7.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	generateGroupId	Integer	否	新群组编号
2	nodeList	List	否	新群组中所有需要启动的节点nodeId

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/group/batchStart

{
    "generateGroupId": 2,
    "nodeList": [
       "78e467957af3d0f77e19b952a740ba8c53ac76913df7dbd48d7a0fe27f4c902b55e8543e1c4f65b4a61695c3b490a5e8584149809f66e9ffc8c05b427e9d3ca2",
       "dd7a2964007d583b719412d86dab9dcf773c61bccab18cb646cd480973de0827cc94fa84f33982285701c8b7a7f465a69e980126a77e8353981049831b550f5c"
    ]
}

8.7.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	List	否	群组操作结果
3.1	frontId	Integer	否	群组操作请求的节点前置编号
3.2	code	Integer	否	群组操作结果，0-成功，其他：失败

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [{
        "frontId": 500011,
        "code": 0  // 启动成功
    }, {
        "frontId": 500013,
        "code": 1 // 启动失败
    }]
}

失败：

{
  "code": 205032,
  "message": "Group 2 is already running",
  "data": null
}

8.8 多个节点获取该节点的多个群组状态

向多个节点获取该节点视角下groupIdList中所有群组的状态；nodeId可以从前置列表获取。

群组状态包含：群组不存在”INEXISTENT”、群组正在停止”STOPPING”、群组运行中”RUNNING”、群组已停止”STOPPED”、群组已删除”DELETED”

8.8.1 传输协议规范

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

8.8.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	nodeIdList	List	否	需要获取群组状态的节点编号列表
2	groupIdList	List	否	需要查询群组状态的群组编号列表

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/group/queryGroupStatus/list

{
    "nodeIdList": [
        "02ad41a54e5403293855624e6088a1ac6c0a391d6381175bb9c9881f2ae83de6db54fc95a772f22b9e62109393c1a4229dc6d99536548db693e43b244a5b9d84",
        "3fc60c4dddcb8f64c910b7afc4bd400339a007eff9be22012c5ae2f7eebef67a4b770094bf7564dd100e1456d85a72f3488457e9f4d44d51e289071d995285d7"
    ]
    "groupIdList": [2]
}

8.8.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Integer	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	List	否	GroupStatusInfo的列表
3.1	nodeId	String		包含groupId和GroupStatus的Map, 如`{“1”: “RUNNING”,”20”,”INEXISTENT”}`
3.2	groupStatusMap	Map		包含groupId和GroupStatus的`Map<String,String>`, 如`{“1”: “RUNNING”,”20”,”INEXISTENT”}`
3.2.1	groupId	String	否	群组编号，如果获取失败，则显示为`<nodeId, “FAIL”>`，如下所示
3.2.2	groupStatus	String	否	链上的群组状态：”INEXISTENT”、”STOPPING”、”RUNNING”、”STOPPED”、”DELETED”, 获取失败为”FAIL”

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [{
        "nodeId": "02ad41a54e5403293855624e6088a1ac6c0a391d6381175bb9c9881f2ae83de6db54fc95a772f22b9e62109393c1a4229dc6d99536548db693e43b244a5b9d84",
        "groupStatusMap": {
            // 当前nodeId获取群组2状态成功
            "2": "RUNNING" 
        }
    }, {
        "nodeId": "3fc60c4dddcb8f64c910b7afc4bd400339a007eff9be22012c5ae2f7eebef67a4b770094bf7564dd100e1456d85a72f3488457e9f4d44d51e289071d995285d7",
        "groupStatusMap": {
            // 当前nodeId获取群组2状态成功
            "2": "RUNNING"
        }
    }]
}

获取群组状态成功，但某个节点的获取请求失败：

{
    "code": 0,
    "message": "success",
    "data": [{
        "nodeId": "02ad41a54e5403293855624e6088a1ac6c0a391d6381175bb9c9881f2ae83de6db54fc95a772f22b9e62109393c1a4229dc6d99536548db693e43b244a5b9d84",
        "groupStatusMap": {
            "2": "RUNNING"
        }
    }, {
        "nodeId": "3fc60c4dddcb8f64c910b7afc4bd400339a007eff9be22012c5ae2f7eebef67a4b770094bf7564dd100e1456d85a72f3488457e9f4d44d51e289071d995285d7",
        "groupStatusMap": {
            // 3fc6..节点的状态获取失败
            "3fc60c4dddcb8f64c910b7afc4bd400339a007eff9be22012c5ae2f7eebef67a4b770094bf7564dd100e1456d85a72f3488457e9f4d44d51e289071d995285d7": "FAIL"
        }
    }]
}

失败：

{
    "code": 202301,
    "message": "node's front not exists"
}

8.9 刷新群组列表

刷新节点管理服务的群组列表，检查本地群组数据与链上群组数据是否有冲突，检查多个节点之间的创世块是否一致，并从链上拉取最新的群组列表

8.9.1 传输协议规范

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

8.9.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	-	-	-	-

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/group/update

8.9.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	list	否	返回信息列表

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {}
}

8.10 获取所有群组列表（包含异常群组）

返回所有群组，包含正常运行、维护中、脏数据冲突、创世块冲突4种状态的群组

8.10.1 传输协议规范

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

8.10.2 请求参数

1）入参表 | 序号 | 输入参数 | 类型 | 可为空 | 备注 | |——|————-|—————|——–|——————————-| | 1 | pageSize | Integer | 否 | 每页记录数 | | 2 | pageNumber | Integer | 否 | 当前页码 |

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/group/all/invalidIncluded/{pageNumber}/{pageSize}

8.10.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Integer	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	totalCount	Integer	否	总记录数
4	data	List	否	组织列表
4.1		Object		组织信息对象
4.1.1	groupId	Integer	否	群组编号
4.1.2	groupName	String	否	群组名称
4.1.2	groupStatus	Integer	否	群组状态：1-正常, 2-维护中, 3-脏数据, 4-创世块冲突
4.1.2	nodeCount	Integer	否	群组节点数
4.1.3	latestBlock	BigInteger	否	最新块高
4.1.4	transCount	BigInteger	否	交易量
4.1.5	createTime	LocalDateTime	否	落库时间
4.1.6	modifyTime	LocalDateTime	否	修改时间
4.1.2	description	String	否	群组描述
4.1.2	groupType	Integer	否	群组类别：1-同步，2-动态创建

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "totalCount": 1,
    "data": [
        {
            "groupId":1,
            "groupName":"group1",
            "groupStatus":1,
            "nodeCount":4,
            "latestBlock":0,
            "transCount":0,
            "createTime":"2020-05-07 16:32:02",
            "modifyTime":"2020-05-08 10:50:13",
            "description":"synchronous",
            "groupType":1
        },
         {
            "groupId":2020,
            "groupName":"group2020",
            "groupStatus":2,
            "nodeCount":2,
            "latestBlock":0,
            "transCount":0,
            "createTime":"2020-05-07 16:32:02",
            "modifyTime":"2020-05-08 10:50:13",
            "description":"",
            "groupType":2
        }
    ]
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

8.11 删除群组所有数据

删除指定群组编号的群组的所有数据，包含节点数据、交易数据、交易审计数据等等。

8.11.1 传输协议规范

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

8.11.2 请求参数

1）入参表 | 序号 | 输入参数 | 类型 | 可为空 | 备注 | |——|————-|—————|——–|——————————-| | 1 | groupId | Integer | 否 | 群组编号 |

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/group/{groupId}

8.11.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Integer	否	返回码，0：成功其它：失败
2	message	String	否	描述

2）出参示例

成功：

{
    "code": 0,
    "message": "success"
}

失败：

{
    "code": 202006,
    "message": "invalid group id"
}

9 节点管理模块

9.1 查询节点列表

9.1.1 传输协议规范

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

9.1.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组id
2	pageSize	Int	否	每页记录数
3	pageNumber	Int	否	当前页码
4	nodeName	String	是	节点名称

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/node/nodeList/300001/1/10?nodeName=

9.1.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	totalCount	Int	否	总记录数
4	data	List	是	节点列表
4.1		Object		节点信息对象
4.1.1	nodeId	int	否	节点编号
4.1.2	nodeName	string	否	节点名称
4.1.3	groupId	int	否	所属群组编号
4.1.4	nodeActive	int	否	状态
4.1.5	nodeIp	string	否	节点ip
4.1.6	P2pPort	int	否	节点p2p端口
4.1.7	description	String	否	备注
4.1.8	blockNumber	BigInteger	否	节点块高
4.1.9	pbftView	BigInteger	否	Pbft view
4.1.10	createTime	LocalDateTime	否	落库时间
4.1.11	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "totalCount": 1,
    "data": [
        {
            "nodeId": 500001,
            "nodeName": "127.0.0.1_10303",
            "groupId": 300001,
            "nodeIp": "127.0.0.1",
            "p2pPort": 10303,
            "description": null,
            "blockNumber": 133,
            "pbftView": 5852,
            "nodeActive": 1,
            "createTime": "2019-02-14 17:47:00",
            "modifyTime": "2019-03-15 11:14:29"
        }
    ]
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

9.2 查询节点信息

9.2.1 传输协议规范

网络传输协议：使用HTTP协议
请求地址：/node/nodeInfo/{groupId}?nodeType={nodeType}
请求方式：GET
返回格式：JSON

9.2.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组id

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/node/nodeInfo/1

9.2.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3		Object		节点信息对象
3.1	nodeId	int	否	节点编号
3.2	nodeName	string	否	节点名称
3.3	groupId	int	否	所属群组编号
3.4	nodeActive	int	否	状态
3.5	nodeIp	string	否	节点ip
3.6	P2pPort	int	否	节点p2p端口
3.7	description	String	否	备注
3.8	blockNumber	BigInteger	否	节点块高
3.9	pbftView	BigInteger	否	Pbft view
3.10	createTime	LocalDateTime	否	落库时间
3.11	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "nodeId": 500001,
        "nodeName": "127.0.0.1_10303",
        "groupId": 1,
        "nodeIp": "127.0.0.1",
        "p2pPort": 10303,
        "description": null,
        "blockNumber": 133,
        "pbftView": 5852,
        "nodeActive": 1,
        "createTime": "2019-02-14 17:47:00",
        "modifyTime": "2019-03-15 11:14:29"
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

10 角色管理模块

10.1 查询角色列表

10.1.1 传输协议规范

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

10.1.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	roleId	int	否	角色id
2	roleName	String	是	角色名称
3	pageSize	int	否	每页记录数
4	pageNumber	int	否	当前页码

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/role/roleList?groupId=300001&pageNumber=&pageSize=&roleId=&roleName=

10.1.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	totalCount	Int	否	总记录数
4	data	List	否	组织列表
4.1		Object		组织信息对象
4.1.1	roleId	Int	否	角色编号
4.1.2	roleName	String	否	角色名称
4.1.3	roleNameZh	String	否	角色中文名称
4.1.4	roleStatus	Int	否	状态（1-正常2-无效）默认1
4.1.5	description	String	否	备注
4.1.6	createTime	LocalDateTime	否	创建时间
4.1.7	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "totalCount": 2,
    "data": [
        {
            "roleId": 100000,
            "roleName": "admin",
            "roleNameZh": "管理员",
            "roleStatus": 1,
            "description": null,
            "createTime": "2019-02-14 17:33:50",
            "modifyTime": "2019-02-14 17:33:50"
        },
        {
            "roleId": 100001,
            "roleName": "visitor",
            "roleNameZh": "访客",
            "roleStatus": 1,
            "description": null,
            "createTime": "2019-02-14 17:33:50",
            "modifyTime": "2019-02-14 17:33:50"
        }
    ]
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

11 用户管理模块

11.1 新增私钥用户

11.1.1 传输协议规范

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

11.1.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	userName	string	否	用户名称
2	description	string	是	备注
3	groupId	Int	否	所属群组

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/user/userInfo

{
    "groupId": "300001",
    "description": "密钥拥有者",
    "userName": "user1"
}

11.1.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	object	是	返回信息实体（成功时不为空）
3.1	userId	int	否	用户编号
3.2	userName	string	否	用户名称
3.3	groupId	int	否	所属群组编号
3.4	description	String	是	备注
3.5	userStatus	int	否	状态（1-正常 2-停用）默认1
3.6	publicKey	String	否	公钥信息
3.7	address	String	是	在链上位置的hash
3.8	hasPk	Int	否	是否拥有私钥信息(1-拥有，2-不拥有)
3.9	createTime	LocalDateTime	否	创建时间
3.10	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "userId": 700007,
        "userName": "asdfvw",
        "groupId": 300001,
        "publicKey": "0x4189fdacff55fb99172e015e1adc360777bee6682fcc975238aabf144fbf610a3057fd4b5",
        "userStatus": 1,
        "userType": 1,
        "address": "0x40ec3c20b5178401ae14ad8ce9c9f94fa5ebb86a",
        "hasPk": 1,
        "description": "sda",
        "createTime": "2019-03-15 18:00:27",
        "modifyTime": "2019-03-15 18:00:27"
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

11.2 绑定公钥用户

11.2.1 传输协议规范

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

11.2.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	userName	string	否	用户名称
2	description	string	是	备注
3	groupId	Int	否	所属群组

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/user/userInfo

{
    "userName": "sdfasd",
    "publicKey": "0x4189fdacff55fb99172e015e1adb96dc77b0cae1619b1a41cc360777bee6682fcc9752d8aabf144fbf610a3057fd4b5",
    "groupId": "300001",
    "description": "sdfa"
}

11.2.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	object	是	返回信息实体（成功时不为空）
3.1	userId	int	否	用户编号
3.2	userName	string	否	用户名称
3.3	groupId	int	否	所属群组编号
3.4	description	String	是	备注
3.5	userStatus	int	否	状态（1-正常 2-停用）默认1
3.6	publicKey	String	否	公钥信息
3.7	address	String	是	在链上位置的hash
3.8	hasPk	Int	否	是否拥有私钥信息(1-拥有，2-不拥有)
3.9	createTime	LocalDateTime	否	创建时间
3.10	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "userId": 700007,
        "userName": "asdfvw",
        "groupId": 300001,
        "publicKey": "0x4189fdacff55fb99172e015e1adb96dc77b0cae1619b1a41cc360777bee6682fcc9752d8aabf144fbf610a3057fd4b5",
        "userStatus": 1,
        "userType": 1,
        "address": "0x40ec3c20b5178401ae14ad8ce9c9f94fa5ebb86a",
        "hasPk": 1,
        "description": "sda",
        "createTime": "2019-03-15 18:00:27",
        "modifyTime": "2019-03-15 18:00:27"
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

11.3 修改用户备注

11.3.1 传输协议规范

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

11.3.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	userId	int	否	用户编号
2	description	String	是	备注

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/user/userInfo

{
    "userId": "400001",
    "description": "newDescription"
}

11.3.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	object	是	返回信息实体（成功时不为空）
3.1	userId	int	否	用户编号
3.2	userName	string	否	用户名称
3.3	groupId	int	否	所属群组编号
3.4	description	String	是	备注
3.5	userStatus	int	否	状态（1-正常 2-停用）默认1
3.6	publicKey	String	否	公钥信息
3.7	address	String	是	在链上位置的hash
3.8	hasPk	Int	否	是否拥有私钥信息(1-拥有，2-不拥有)
3.9	createTime	LocalDateTime	否	创建时间
3.10	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "userId": 400001,
        "userName": "asdfvw",
        "groupId": 300001,
        "publicKey": "0x4189fdacff55fb99172e015e1682fcc9752d8aabf144fbf610a3057fd4b5",
        "userStatus": 1,
        "userType": 1,
        "address": "0x40ec3c20b5178401ae14ad8ce9c9f94fa5ebb86a",
        "hasPk": 1,
        "description": "newDescription",
        "createTime": "2019-03-15 18:00:27",
        "modifyTime": "2019-03-15 18:00:27"
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

11.4 查询私钥（1.3.0已移除）

11.4.1 传输协议规范

网络传输协议：使用HTTP协议
请求地址：/user/privateKey/{userId}
请求方式：GET
返回格式：json

11.4.2 请求参数

1）入参表

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

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/user/privateKey/4585

11.4.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	Object	否	返回私钥信息实体
3.1	privateKey	String	否	私钥
3.2	address	String	否	用户链上地址

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "privateKey": 123456,
        "address": "asfsafasfasfasfasfas"
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

11.5 查询用户列表

11.5.1 传输协议规范

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

11.5.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	所属群组id
2	pageSize	Int	否	每页记录数
3	pageNumber	Int	否	当前页码
4	userParam	String	是	查询参数（用户名或公钥地址）

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/user/userList/300001/1/10?userParam=asdfvw

11.5.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	totalCount	Int	否	总记录数
4	data	List	是	用户列表
4.1		Object		用户信息对象
4.1.1	userId	int	否	用户编号
4.1.2	userName	string	否	用户名称
4.1.3	groupId	int	否	所属群组编号
4.1.4	description	String	是	备注
4.1.5	userStatus	int	否	状态（1-正常 2-停用）默认1
4.1.6	publicKey	String	否	公钥信息
4.1.7	address	String	是	在链上位置的hash
4.1.8	hasPk	Int	否	是否拥有私钥信息(1-拥有，2-不拥有)
4.1.9	createTime	LocalDateTime	否	创建时间
4.1.10	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "totalCount": 1,
    "data": [
        {
            "userId": 700007,
            "userName": "asdfvw",
            "groupId": 300001,
            "publicKey": "0x4189fdacff55fb99172e015e1adb96dc71cc360777bee6682fcc975238aabf144fbf610a3057fd4b5",
            "userStatus": 1,
            "userType": 1,
            "address": "0x40ec3c20b5178401ae14ad8ce9c9f94fa5ebb86a",
            "hasPk": 1,
            "description": "sda",
            "createTime": "2019-03-15 18:00:27",
            "modifyTime": "2019-03-15 18:00:28"
        }
    ]
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

11.6 导入私钥用户

可在页面导入WeBASE-Front所导出的私钥txt文件

其中私钥字段用Base64加密

11.6.1 传输协议规范

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

11.6.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	privateKey	string	否	Base64加密后的私钥内容
2	userName	string	否	用户名称
3	description	string	是	备注
4	groupId	Int	否	所属群组

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/user/import

{
    "privateKey": "OGFmNWIzMzNmYTc3MGFhY2UwNjdjYTY3ZDRmMzE4MzU4OWRmOThkMjVjYzEzZGFlMGJmODhkYjhlYzVhMDcxYw==",
    "groupId": "300001",
    "description": "密钥拥有者",
    "userName": "user1"
}

11.6.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述

2）出参示例

成功：

{
    "code": 0,
    "message": "success"
}

失败：

{
    "code": 201031,
    "message": "privateKey decode fail",
    "data": null
}

11.7 导入.pem私钥

可导入控制台所生成的私钥.pem文件

11.7.1 传输协议规范

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

11.7.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	pemContent	string	否	pem文件的内容，必须以`——-BEGIN PRIVATE KEY——-\n`开头，以`\n——-END PRIVATE KEY——-\n`结尾的格式
2	userName	string	否	用户名称
3	description	string	是	备注
4	groupId	Int	否	所属群组

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/user/importPem

{
    "pemContent":"-----BEGIN PRIVATE KEY-----\nMIGEAgEAMBAGByqGSM49AgEGBSuBBAAKBG0wawIBAQQgC8TbvFSMA9y3CghFt51/\nXmExewlioX99veYHOV7dTvOhRANCAASZtMhCTcaedNP+H7iljbTIqXOFM6qm5aVs\nfM/yuDBK2MRfFbfnOYVTNKyOSnmkY+xBfCR8Q86wcsQm9NZpkmFK\n-----END PRIVATE KEY-----\n",
    "groupId": "1",
    "description": "密钥拥有者",
    "userName": "user2"
}

11.7.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述

2）出参示例

成功：

{
    "code": 0,
    "message": "success"
}

失败：

{
    "code": 201232,
    "message": "Pem file format error, must surrounded by -----XXXXX PRIVATE KEY-----"",
    "data": null
}

11.8 导入.p12私钥

可导入控制台生成的私钥.p12文件

11.8.1 传输协议规范

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

11.8.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	p12File	MultipartFile	否	.p12文件
2	p12Password	string	是	.p12文件的密码，缺省时默认为””，即空密码；p12无密码时，可传入空值或不传；不包含中文
3	userName	string	否	用户名称
4	description	string	是	备注
5	groupId	Int	否	所属群组

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/user/importP12

使用form-data传参

11.8.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述

2）出参示例

成功：

{
    "code": 0,
    "message": "success"
}

失败：（p12文件的密码错误）

{
    "code": 201236,
    "message": "p12's password not match",
    "data": null
}

12 合约方法管理模块

12.1 新增合约方法

12.1.1 传输协议规范

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

12.1.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	Int	否	所属群组
2	methodList	List	否	方法列表
2.1		Object	否	方法实体
2.1.1	abiInfo	String	否	合约abi信息
2.1.2	methodId	String	否	方法编号
2.1.3	methodType	String	否	方法类型

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/method/add

{
    "groupId": 2,
    "methodList": [
        {
            "abiInfo": "fsdabiTestfd232222",
            "methodId": "methodIasdfdttttt",
            "methodType": "function"
        }
    ]
}

1.1.3 返回参数

1）出参表

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

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": null
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

12.2 根据方法编号查询

12.1.1 传输协议规范

网络传输协议：使用HTTP协议
请求地址：/method/findById/{groupId}/{methodId}
请求方式：POST
请求头：Content-type: application/json
返回格式：JSON

12.1.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	Int	否	所属群组
2	methodId	String	否	方法编号

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/method/findById/2/methodIasdfdttttt

1.1.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3		Object	否	方法实体
3.1	abiInfo	String	否	合约abi信息
3.2	methodId	String	否	方法编号
3.3	methodType	String	否	方法类型
3.4	createTime	LocalDateTime	否	创建时间
3.5	modifyTime	LocalDateTime	否	修改时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "methodId": "methodIasdfdttttt",
        "groupId": 2,
        "abiInfo": "fsdabiTestfd232222",
        "methodType": "function",
        "createTime": "2019-04-16 16:59:27",
        "modifyTime": "2019-04-16 16:59:27"
    }
}

失败：

{
    "code": 102000,
    "message": "system exception",
    "data": {}
}

13 系统管理模块

13.1 查看权限管理

根据PermissionType权限类型，查询该类权限记录列表。共支持查看六种权限的管理员列表：权限管理权限permission, 用户表管理权限userTable, 部署合约和创建用户表权限deployAndCreate, 节点管理权限node, 使用CNS权限cns, 系统参数管理权限sysConfig

13.1.1 传输协议规范

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

13.1.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组id
2	permissionType	String	否	查看拥有某个权限的address list
3	tableName	String	是	type=UserTable的时候不能为空。查看某个表的管理员list
4	pageSize	int	否
5	pageNumber	int	否

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/permission?groupId=1&permissionType=cns&pageSize=5&pageNumber=1

13.1.3 返回参数

1）出参表

序号	输出参数	类型	备注
1	code	Int	返回码，0：成功其它：失败
2	message	String	描述
3	data	List数组	直接返回数组
4	totalCount	int	总数目

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "address": "0x009fb217b6d7f010f12e7876d31a738389fecd51",
            "table_name": "_sys_table_access_",
            "enable_num": "84"
        }
    ],
    "totalCount": 1
}

失败：

{
    "code": 400,
    "message": "Required String parameter 'tableName' is not present"
}

13.2 查看权限管理列表（不分页）

13.2.1 传输协议规范

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

13.2.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组id
2	permissionType	String	否	查看拥有某个权限的address list
3	tableName	String	是

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/permission/full?groupId=1&permissionType=cns

13.2.3 返回参数

1）出参表

序号	输出参数	类型	备注
1	code	Int	返回码，0：成功其它：失败
2	message	String	描述
3	data	List数组	直接返回数组
4	totalCount	int	总数目

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "address": "0x009fb217b6d7f010f12e7876d31a738389fecd51",
            "table_name": "_sys_table_access_",
            "enable_num": "84"
        }
    ],
    "totalCount": 1
}

失败：

{
    "code": 400,
    "message": "Required String parameter 'tableName' is not present"
}

13.3 增加管理权限接口

由管理员赋予外部账户地址不同类型的权限，包含六种：权限管理权限permission, 用户表管理权限userTable, 部署合约和创建用户表权限deployAndCreate, 节点管理权限node, 使用CNS权限cns, 系统参数管理权限sysConfig

其中userTable权限还需传入相应的表明tableName

13.3.1 传输协议规范

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

13.3.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组id
2	permissionType	String	否	分配权限的类型（六种：permission, userTable, deployAndCreate, node, cns, sysConfig)
3	fromAddress	String	否	管理员自己的地址
4	address	String	否	分配链管理员的用户地址
5	tableName	String	是	当permissionType为userTable时不可为空
6	useAes	Boolean	是	发交易的私钥是否为加密私钥，默认为false

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/permission

{
    "groupId": 1,
    "permissionType": "permission",
    "fromAddress": "0xd5bba8fe456fce310f529edecef902e4b63129b1",
    "address": "0x2357ad9d97027cd71eea1d639f1e5750fbdfd38e"
}

13.3.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述

2）出参示例

成功：

{
    "code": 0,
    "message": "success"
}

失败：

{
    "code": -51000,
    "message": "table name and address already exist"
}

13.4 去除管理权限接口

由管理员去除外部账户地址不同类型的权限，包含六种：权限管理权限permission, 用户表管理权限userTable, 部署合约和创建用户表权限deployAndCreate, 节点管理权限node, 使用CNS权限cns, 系统参数管理权限sysConfig

其中userTable权限还需传入相应的表明tableName

13.4.1 传输协议规范

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

13.4.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组id
2	permissionType	String	否	分配权限的类型（六种：permission, userTable, deployAndCreate, node, cns, sysConfig)
3	fromAddress	String	否	管理员自己的地址
4	address	String	否	分配链管理员的用户地址
5	tableName	String	是	当permissionType为userTable时不可为空
6	useAes	Boolean	是	发交易的私钥是否为加密私钥，默认为false

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/permission

{
    "groupId": 1,
    "permissionType": "permission",
    "fromAddress": "0xd5bba8fe456fce310f529edecef902e4b63129b1",
    "address": "0x2357ad9d97027cd71eea1d639f1e5750fbdfd38e"
}

13.4.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述

2）出参示例

成功：

{
    "code": 0,
    "message": "success"
}

失败：

{
    "code": -51001,
    "message": "table name and address does not exist"
}

13.5 获取用户权限状态列表

获取所有用户的权限状态列表，权限状态包含有四种权限：部署合约和创建用户表权限deployAndCreate, 节点管理权限node, 使用CNS权限cns, 系统参数管理权限sysConfig

13.5.1 传输协议规范

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

13.5.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组id
2	pageSize	int	是	分页大小
3	pageNumber	int	是	分页页码

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/permission/sorted?groupId=1&pageSize=3&pageNumber=1

13.5.3 返回参数

1）出参表

序号	输出参数	类型	备注
1	code	Int	返回码，0：成功其它：失败
2	message	String	描述
3	data	List数组	返回权限状态数组
3.1		Object	以用户地址为key，以用户的权限状态为value的的Map结构体，1为赋予，0为去除
3.1.1	deployAndCreate	Int	用户的部署与建表权限状态：0-已去除，1-已赋予
3.1.2	cns	Int	用户的CNS管理权限状态：0-已去除，1-已赋予
3.1.3	sysConfig	Int	用户的系统配置管理权限状态：0-已去除，1-已赋予
3.1.4	node	Int	用户的节点共识管理权限状态：0-已去除，1-已赋予
4	totalCount	Int	总数目

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "0x17de6cd8e173bac6f457f3f73d8d9a1b1dd33451": {
                "deployAndCreate": 0,
                "cns": 1,
                "sysConfig": 0,
                "node": 0
            }
        },
        {
            "0x202b4245087dbf797f954d8425459bfee3c790f8": {
                "deployAndCreate": 1,
                "cns": 1,
                "sysConfig": 1,
                "node": 1
            }
        },
        {
            "0x99af2eb68db52ba21a033af235e680feb0ca7ae5": {
                "deployAndCreate": 0,
                "cns": 0,
                "sysConfig": 0,
                "node": 0
            }
        }
    ],
    "totalCount": 11
}

13.6 管理用户权限状态接口

管理用户的权限状态，权限状态包含有四种权限：部署合约和创建用户表权限deployAndCreate, 节点管理权限node, 使用CNS权限cns, 系统参数管理权限sysConfig；1代表赋予权限，0代表去除权限

13.6.1 传输协议规范

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

13.6.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组id
2	fromAddress	String	否	管理员自己的地址
3	address	String	否	分配链管理员的用户地址
4	permissionState	Object	否	使用{“permissionType”: 1}的结构格式，1代表赋予，0代表去除；支持cns、deployAndCreate、sysConfig、node四种权限
5	useAes	Boolean	是	发交易的私钥是否为加密私钥，默认为false

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/permission/sorted

{
 "groupId": "2",
 "fromAddress": "0x09fb217b6d7f010f12e7876d31a738389fecd517",
 "address": "0x09fb217b6d7f010f12e7876d31a738389fecd517",
 "permissionState": {
      "deployAndCreate": 1,
      "node": 1,
      "sysConfig": 1,
      "cns": 1             
 }
}

13.6.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	List数组		返回权限状态数组
3.1		Object		以用户地址为key，以用户的权限状态为value的的Map结构体，1为赋予，0为去除
3.1.1	deployAndCreate	Int		用户的部署与建表权限状态：0-已去除，1-已赋予
3.1.2	cns	Int		用户的CNS管理权限状态：0-已去除，1-已赋予
3.1.3	sysConfig	Int		用户的系统配置管理权限状态：0-已去除，1-已赋予
3.1.4	node	Int		用户的节点共识管理权限状态：0-已去除，1-已赋予

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "node": 1,
        "sysConfig": 1,
        "cns": 1,
        "deployAndCreate": 1
    }
}

失败：

{
    "code": 201202,
    "message": "permission denied, please check chain administrator permission"
}

13.7 查询CNS接口

根据群组id和合约名（或合约名加版本）获取CNS的list列表。

13.7.1 传输协议规范

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

13.7.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组id
2	contractNameAndVersion	String	否	只需要合约名,version缺乏时返回所有版本，version与contractName用英文冒号”:”连接
4	pageSize	int	否
5	pageNumber	int	否

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/precompiled/cns/list?groupId=1&contractNameAndVersion=HelloWorld&pageSize=10&pageNumber=1

13.7.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	List数组	否	描述
4	totalCount	int		总数目

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "name": "HelloWorld",
            "version": "2d36b8ed7ed12da01ed51cc0c85c3002085b17b6",
            "address": "0x2d36b8ed7ed12da01ed51cc0c85c3002085b17b6",
            "abi": "[{\"constant\":false,\"inputs\":[{\"indexed\":false,\"name\":\"n\",\"type\":\"string\"}],\"name\":\"set\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"get\",\"outputs\":[{\"indexed\":false,\"name\":\"\",\"type\":\"string\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"constant\":false,\"inputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"constructor\"},{\"constant\":false,\"inputs\":[{\"indexed\":false,\"name\":\"name\",\"type\":\"string\"}],\"name\":\"nameEvent\",\"payable\":false,\"type\":\"event\"}]"
        }
    ],
    "totalCount": 1
}

13.8 获取系统配置

根据群组id获取系统配置SystemConfig的list列表，目前只支持tx_count_limit, tx_gas_limit两个参数。

13.8.1 传输协议规范

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

13.8.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组id
2	pageSize	int	否
3	pageNumber	int	否

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/sys/config/list?groupId=1&pageSize=10&pageNumber=1

13.8.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	数组	否	list包含数据库存储的配置key与对应value

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "id": 6,
            "groupId": 1,
            "fromAddress": "0x",
            "configKey": "tx_gas_limit",
            "configValue": "300000000"
        },
        {
            "id": 5,
            "groupId": 1,
            "fromAddress": "0xd0b56b4ce0e8ce5e064f896d9ad1c16b2603f285",
            "configKey": "tx_count_limit",
            "configValue": "10002"
        }
    ],
    "totalCount": 2
}

13.9 设置系统配置

系统配置管理员设置系统配置，目前只支持tx_count_limit, tx_gas_limit两个参数。

13.9.1 传输协议规范

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

13.9.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组id
2	fromAddress	String	否	管理员自己的地址
3	configKey	String	否	目前类型两种(tx_count_limit， tx_gas_limit，用户可自定义key如tx_gas_price
4	configValue	String	否
5	useAes	Boolean	是	发交易的私钥是否为加密私钥，默认为false

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/sys/config

{
    "groupId": 1,
    "fromAddress": "0xd5bba8fe456fce310f529edecef902e4b63129b1",
    "configKey": "tx_count_limit",
    "configValue": "1001"
}

13.9.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述

2）出参示例

成功：

{
  "code": 0,
  "message": "success"
 }

失败：

{
    "code": -50000,
    "message": "permission denied"
}

13.10 获取节点列表(节点管理)

获取节点的list列表，包含节点id，节点共识状态。

注：接口返回所有的共识/观察节点（无论运行或停止），以及正在运行的游离节点

13.10.1 传输协议规范

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

13.10.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组id
2	pageSize	int	否
3	pageNumber	int	否

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/precompiled/consensus/list?groupId=1&pageSize=10&pageNumber=1

13.10.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	List	否	成功时返回

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "nodeId": "13e0f2b94cbce924cc3737385a38587939e809fb786c4fc34a6ba3ea97693bccfa173b352ac41f1dbb97e9e4910ccbec1df38ad4020cef3b2044e833188adad9",
            "nodeType": "sealer"
        },
        {
            "nodeId": "bce4b2269c25c2cdba30155396bfe90af08c3c08cff205213477683117e4243ebe26588479519e636a5d5d93545cab778435cacacc41993f28f58f60fa5ceb72",
            "nodeType": "sealer"
        },
        {
            "nodeId": "e815cc5637cb8c3274c83215c680822e4a0110d0a8315fcf03e43e8e3944edd758c8b173c4e0076f599aa1f853fa207d47cc95d201ae8d0206b71ad5aa8c3f59",
            "nodeType": "sealer"
        }
    ],
    "totalCount": 3
}

13.11 设置节点共识状态接口（节点管理）

节点管理相关接口，可用于节点三种共识状态的切换。分别是共识节点sealer, 观察节点observer, 游离节点remove

13.11.1 传输协议规范

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

13.11.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组id
2	fromAddress	String	否	管理员的地址
3	nodeType	String	否	节点类型：observer,sealer,remove
4	nodeId	String	否	节点id
5	useAes	Boolean	是	发交易的私钥是否为加密私钥，默认为false

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/precompiled/consensus

{
    "groupId": 1,
    "fromAddress": "0xd5bba8fe456fce310f529edecef902e4b63129b1",
    "nodeType": "remove",
    "nodeId": "224e6ee23e8a02d371298b9aec828f77cc2711da3a981684896715a3711885a3177b3cf7906bf9d1b84e597fad1e0049511139332c04edfe3daddba5ed60cffa"
}

13.12.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述｜

2）出参示例

成功：

[
    {
      "code": 0,
      "message": "success"
     }
]

失败：

{
    "code": -51000,
    "message": "nodeId already exist"
}

13.13 CRUD表格操作接口

用于操作用户表的CRUD操作，包含create, desc, insert, update, select, remove。

具体sql要求语法参考Fisco-bcos技术文档的 Precompiled Crud API

13.13.1 传输协议规范

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

13.13.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	int	否	群组id
2	fromAddress	String	否	UserTable管理员的地址
3	sql	String	否	需要调用的sql语句
4	useAes	Boolean	是	发交易的私钥是否为加密私钥，默认为false

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/precompiled/crud

{
    "groupId": 1,
    "fromAddress": "0xd5bba8fe456fce310f529edecef902e4b63129b1",
    "sql": "desc t_demo"
}

13.13.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	String	否	调用结果

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": {
        "tableName": "t_demo",
        "key": "name",
        "valueFields": "item_id,item_name",
        "optional": "",
        "entry": {
            "fields": {}
        },
        "condition": {
            "conditions": {}
        }
    }
}

或者

{
    "code": 0,
    "message": "success",
    "data": {
        "Insert OK, 1 row effected"
    }
}

失败：

{
    "code": 201228,
    "message": "table not exists",
    "data": "Table not exists "
}

14 证书管理模块

14.1 获取证书列表接口

获取证书的list列表，返回的列表包含证书指纹、证书内容、证书名字、证书的父证书、证书对应nodeid（节点证书）、证书有效期

注：首次启动项目会自动拉取每一个Front的证书

14.1.1 传输协议规范

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

14.1.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
	-	-

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/cert/list

14.1.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	List	否	成功时返回证书相关信息的列表
3		Object	否	单个证书相关信息
3.1	fingerPrint	String	否	证书的指纹
3.1	certName	String	否	证书名字
3.1	content	String	否	证书文件的内容
3.1	certType	String	否	证书类型：chain, agency, node, sdk等，国密版中node证书分为加密ennode证书与签名gmnode证书
3.1	publicKey	String	否	证书对应nodeid（仅限节点证书公钥）
3.1	address	String	否	证书对应地址（仅限节点证书公钥）
3.1	father	String	否	证书的父证书指纹
3.1	validityFrom	Date	否	证书有效期开始时间
3.1	validityTo	Date	否	证书有效期结束时间
3.1	createTime	LocalDateTime	否	导入创建时间

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "fingerPrint": "814D51FB7CBAB33676FE73E8FBBFECB3D3B1301A",
            "certName": "sdk",
            "content": "-----BEGIN CERTIFICATE-----\nMIICOTCCASGgAwIBAgIJAKHsAYI3TsAOMA0GCSqGSIb3DQEBCwUAMDgxEDAOBgNV\nBAMMB2FnZW5jeUExEzARBgNVBAoMCmZpc2NvLWJjb3MxDzANBgNVBAsMBmFnZW5j\neTAeFw0xOTA3MTIwMjA2MTZaFw0yOTA3MDkwMjA2MTZaMDIxDDAKBgNVBAMMA3Nk\nazETMBEGA1UECgwKZmlzY28tYmNvczENMAsGA1UECwwEbm9kZTBWMBAGByqGSM49\nAgEGBSuBBAAKA0IABJ79rSKIb97xZwByW58xH6tzoNKNLaKG7J5wxAEgAb03O2h4\nMkEMLtf/LB7tELOiyCiIEhLScprb1LjvDDt2RDGjGjAYMAkGA1UdEwQCMAAwCwYD\nVR0PBAQDAgXgMA0GCSqGSIb3DQEBCwUAA4IBAQC0u2lfclRmCszBTi2rtvMibZec\noalRC0sQPBPRb7UQhGCodxmsAT3dBUf+s4wLLrmN/cnNhq5HVObbWxzfu7gn3+IN\nyQEeqdbGdzlu1EDcaMgAz6p2W3+FG/tmx/yrNza29cYekWRL44OT5LOUPEKrJ4bJ\neOBRY4QlwZPFmM0QgP7DoKxHXldRopkmvqT4pbW51hWvPgj7KrdqwbVWzuWQuI3i\n3j3O96XZJsaDZ0+IGa5093+TsTNPfWUZzp5Kg+EyNR6Ea1evuMDNq9NAqqcd5bX9\nO9kgkb8+llO8I5ZhdnN0BuhGvv9wpsa9hW8BImOLzUBwfSVYouGCkoqlVq9X\n-----END CERTIFICATE-----\n",
            "certType": "node",
            "publicKey": "9efdad22886fdef16700725b9f311fab73a0d28d2da286ec9e70c4012001bd373b687832410c2ed7ff2c1eed10b3a2c828881212d2729adbd4b8ef0c3b764431",
            "address": "5cb81b06ef0734fff99929c5deae4a5b25e800cc",
            "father": "EEBAAB2F674D05CF1EAD70367B4D2A928D894EF8",
            "validityFrom": 1562860800000,
            "validityTo": 1878220800000,
            "createTime": 1569686400000
        }
    ],
    "totalCount": 1
}

14.2 根据指纹获取证书接口

根据指纹获取单个证书

14.2.1 传输协议规范

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

14.2.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	fingerPrint	String	否	证书指纹，证书唯一标识

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/cert?fingerPrint=814D51FB7CBAB33676FE73E8FBBFECB3D3B1301A

14.2.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	List	否	成功时返回
3		Object	否	单个证书相关信息
3.1	fingerPrint	String	否	证书的指纹
3.1	certName	String	否	证书名字
3.1	content	String	否	证书文件的内容
3.1	certType	String	否	证书类型：chain, agency, node, sdk等，国密版node证书分为加密ennode证书与签名gmnode证书
3.1	publicKey	String	否	证书对应nodeid（仅限节点证书公钥）
3.1	address	String	否	证书对应地址（仅限节点证书公钥）
3.1	father	String	否	证书的父证书指纹
3.1	validityFrom	Date	否	证书有效期开始时间
3.1	validityTo	Date	否	证书有效期结束时间
3.1	createTime	LocalDateTime	否	导入创建时间

2）出参示例

成功：’

{
    "code": 0,
    "message": "success",
    "data": {
        "fingerPrint": "EEBAAB2F674D05CF1EAD70367B4D2A928D894EF8",
        "certName": "agencyA",
        "content": "-----BEGIN CERTIFICATE-----\nMIIDADCCAeigAwIBAgIJAJUF2Dp1a9U6MA0GCSqGSIb3DQEBCwUAMDUxDjAMBgNV\nBAMMBWNoYWluMRMwEQYDVQQKDApmaXNjby1iY29zMQ4wDAYDVQQLDAVjaGFpbjAe\nFw0xOTA3MTIwMjA2MTZaFw0yOTA3MDkwMjA2MTZaMDgxEDAOBgNVBAMMB2FnZW5j\neUExEzARBgNVBAoMCmZpc2NvLWJjb3MxDzANBgNVBAsMBmFnZW5jeTCCASIwDQYJ\nKoZIhvcNAQEBBQADggEPADCCAQoCggEBANBT4CTciIYdSeEabgJzif+CFB0y3GzG\ny+XQYtWK+TtdJWduXqhnnZiYAZs7OPGEu79Yx/bEpjEXsu2cXH0D6BHZk+wvuxG6\nezXWq5MYjCw3fQiSRWkDYoxzWgulkRyYROF1xoZeNGQssReFmCgP+pcQwRxjcq8z\nIA9iT61YxyW5nrS7xnra9uZq/EE3tsJ0ae3ax6zixCT66aV49S27cMcisS+XKP/q\nEVPxhO7SUjnzZY69MgZzNSFxCzIbapnlmYAOS26vIT0taSkoKXmIsYssga45XPwI\n7YBVCc/34kHzW9xrNjyyThMWOgDsuBqZN9xvapGSQ82Lsh7ObN0dZVUCAwEAAaMQ\nMA4wDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAu3aHxJnCZnICpHbQ\nv1Lc5tiXtAYE9aEP5cxb/cO14xY8dS+t0wiLIvyrE2aTcgImzr4BYNBm1XDt5suc\nMpzha1oJytGv79M9/WnI/BKmgUqTaaXOV2Ux2yPX9SadNcsD9/IbrV0b/hlsPd6M\nK8w7ndowvBgopei+A1NQY6jTDUKif4RxD4u5HZFWUu7pByNLFaydU4qBKVkucXOq\nxmWoupL5XrDk5o490kiz/Zgufqtb4w6oUr3lrQASAbFB3lID/P1ipi0DwX7kZwVX\nECDLYvr+eX6GbTClzn0JGuzqV4OoRo1rrRv+0tp1aLZKpCYn0Lhf6s1iw/kCeM2O\nnP9l2Q==\n-----END CERTIFICATE-----\n",
        "certType": "agency",
        "publicKey": "",
        "address": "",
        "father": "",
        "validityFrom": 1562860800000,
        "validityTo": 1878220800000,
        "createTime": 1569686400000
    }
}

14.3 导入证书接口

导入保存证书文件

14.3.1 传输协议规范

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

14.3.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	content	String	否	证书文件的内容，需保留开头与结尾以及证书原有的回车\n的格式文本；证书中包含多个证书亦可

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/cert

{
    "content": "-----BEGIN CERTIFICATE-----\nMIICOzCCASOgAwIBAgIJANJZtoFLZsGcMA0GCSqGSIb3DQEBCwUAMDgxEDAOBgNVBAMMB2FnZW5jeUExEzARBgNVBAoMCmZpc2NvLWJjb3MxDzANBgNVBAsMBmFnZW5jeTAeFw0xOTA5MDUwNzQ3NDdaFw0yOTA5MDIwNzQ3NDdaMDQxDjAMBgNVBAMMBW5vZGUzMRMwEQYDVQQKDApmaXNjby1iY29zMQ0wCwYDVQQLDARub2RlMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAE9CwTicQwi5Gx1gckJ0ibZbcIoL13IHyLK7z4xuzkAi+PbgI9M3vKDuMzZ73IFKCYOwzfhvqM8ksFonpBZqT0NqMaMBgwCQYDVR0TBAIwADALBgNVHQ8EBAMCBeAwDQYJKoZIhvcNAQELBQADggEBAIv+PE8bQlxxVDxfUlevf3jJeaK97U5tmP8Tx1pesblzcMWTC8OxfUtYP0zy4CQL0zo6OjmSn4FYvTyDUSVqj5BXXDXiZQwtWxnPgLD75tqSTlFcR2jB+amhmzWQ7mXgfepvL+RV+1OL8WXJy7Xl01fL0nCwHaWCCwaBg+KnUgbc9YXhhyH8X8aqDDpjz9oYpZcbLITGI0V8lvr1EU3NII6LudgGp/xNolQDBOYZX1E0XtUwMUp6Az2xbmSH/7S3sXJCwgHZrtoiKkcFLbss1TDk/UdUya4n/dz4BcH3OzR2MvMHenA8kh4yaofJNsJeXFqPHAbI5+yUVK2+VK2hI0o=\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIDPTCCAiWgAwIBAgIJAKUGxOHHqV05MA0GCSqGSIb3DQEBCwUAMDUxDjAMBgNVBAMMBWNoYWluMRMwEQYDVQQKDApmaXNjby1iY29zMQ4wDAYDVQQLDAVjaGFpbjAeFw0xOTA5MDUwNzI2MTJaFw0yOTA5MDIwNzI2MTJaMDUxDjAMBgNVBAMMBWNoYWluMRMwEQYDVQQKDApmaXNjby1iY29zMQ4wDAYDVQQLDAVjaGFpbjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAM9LlTwIAKp36uB8sjoai2O3R+3KPMN9xAt8/k5+B943CUPF/RDxZ8/7Q2v6Z+t+1v3Dc81aszMr/8YyyCQWh0I3EdWyInsocZ2pBkjymetyE5VOSd+p7I8qc9PpHJKZjy2M9J5bePVjHJxleHP2u6I4QctjZoE8PJnZYT5Q0On0MJATpY856vHbF3Amvxj9dmeLKjF62T/KtyDKlyPTETXOFGMiLerWusXZxFgj0K0xhuXaNkbJI6AdhQnywgn755ugfBDzi24rfsk/BkUf5DVitfWePh4C7zaCZIeTTr8whV3twE2BTv4LENdidxCVUHN1JBvZNGyHaH4gIbwtsZcCAwEAAaNQME4wHQYDVR0OBBYEFNTCWbm1EzCYIXyoF7j3l6IXX3BoMB8GA1UdIwQYMBaAFNTCWbm1EzCYIXyoF7j3l6IXX3BoMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAIjYTyxP5ikaGYdwYzQZdF4aqx+7UL3Wo/6LNJa8w2m+pAvC3ILIBcvpDe6lH3cMOz2HwCzFkKlT8Ji1HwsKPywx/9fmO60RvEoPIBanziqONLb8HDUT0QHz3jgCTj46URM6hXIEhFwg4KekpzvqaLPRHHtoCrcebUAmySOlNvlwkSnxJnufp0zFpdNu+kSl1/r21ZRMeu/hNaUb1gOzP06NOB7NodOQ5MR7ItVXyN9rl3fABP3rUFIJ+Z11WmSldaCRCQMlEOkdD8LGFYVj4Q5fx06hcJlPd2arnxALWrZUl2cs+K+MW9qQUUKAQ+7FirdRRk6ZfZtlpHMdlTfAVWA=\n-----END CERTIFICATE-----\n"
}

14.3.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	String	否	成功保存证书的个数或错误信息

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": 2
}

失败：

{
    "code": 202060,
    "message": "cert handle error",
    "data": "Could not parse certificate: java.io.IOException: Empty input"
}

14.4 删除证书接口

根据证书指纹删除一个证书

14.4.1 传输协议规范

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

14.4.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	fingerPrint	String	否	证书指纹，证书的唯一标识

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/cert

{
    "fingerPrint": "F588C511F5471860120F7BE8127DE026ADD8378C"
}

14.4.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	String	否	成功删除证书的个数或错误信息

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": 1
}

15 订阅事件管理

15.1 获取已订阅的出块事件列表

获取所有前置中已订阅的节点出块事件列表

15.1.1 传输协议规范

网络传输协议：使用HTTP协议
请求地址： /event/newBlockEvent/list/{groupId}
请求方式：GET
请求头：Content-type: application/json
返回格式：JSON

15.1.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	Integer	否	群组编号
2	pageNumber	Integer	否	页码，从1开始
3	pageSize	Integer	否	页容量

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/event/newBlockEvent/list/{groupId}/{pageNumber}/{pageSize}

15.1.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Integer	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	List	否	newBlockEvent info
3.1	frontInfo	String	否	前置对应IP
3.1	id	String	否	订阅信息的id
3.1	eventType	Integer	否	事件通知类型，1: newBlockEvent, 2: contractEvent, 3: others
3.1	appId	String	否	事件通知对应的应用Id
3.1	groupId	Integer	否	群组编号
3.1	exchangeName	String	否	exchange名
3.1	queueName	String	否	队列名
3.1	routingKey	String	否	路由键值
3.1	createTime	String	否	订阅信息创建时间
4	totalCount	Integer	否	1: 国密，0：非国密

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "frontInfo": "127.0.0.1",
            "id": "8aba82b570f22a750170f22bcab90000",
            "eventType": 1,
            "appId": "app2",
            "groupId": 1,
            "exchangeName": "group001",
            "queueName": "user1",
            "routingKey": "app2_block_b63",
            "createTime": "2020-03-19 17:42:01"
        }
    ],
    "totalCount": 1
}

15.2 获取已订阅的合约Event事件列表

获取所有前置中已订阅的合约Event事件列表

15.2.1 传输协议规范

网络传输协议：使用HTTP协议
请求地址： /event/contractEvent/list/{groupId}
请求方式：GET
请求头：Content-type: application/json
返回格式：JSON

15.2.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	groupId	Integer	否	群组编号
2	pageNumber	Integer	否	页码，从1开始
3	pageSize	Integer	否	页容量

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/event/contractEvent/list/{groupId}/{pageNumber}/{pageSize}

15.2.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Integer	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	List	否	newBlockEvent info
3.1	frontInfo	String	否	前置对应IP
3.1	id	String	否	订阅信息的id
3.1	eventType	Integer	否	事件通知类型，1: newBlockEvent, 2: contractEvent, 3: others
3.1	appId	String	否	事件通知对应的应用Id
3.1	groupId	Integer	否	群组编号
3.1	exchangeName	String	否	exchange名
3.1	queueName	String	否	队列名
3.1	routingKey	String	否	路由键值
3.1	createTime	String	否	起始区块范围
3.1	fromBlock	String	否	末区块范围
3.1	toBlock	String	否	订阅信息创建时间
3.1	contractAddress	String	否	订阅的合约地址
3.1	contractAbi	String	否	对应合约ABI
3.1	topicList	String	否	订阅的合约Event
4	totalCount	Integer	否	1: 国密，0：非国密

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": [
        {
            "frontInfo": "127.0.0.1",
            "id": "8aba82b5708095af01708095e4f70001",
            "eventType": 2,
            "appId": "app1",
            "groupId": 1,
            "exchangeName": "group001",
            "queueName": "user1",
            "routingKey": "user1_event_app1",
            "fromBlock": "latest",
            "toBlock": "latest",
            "contractAddress": "0x657201d59ec41d1dc278a67916f751f86ca672f7",
            "contractAbi": "[{\"constant\":false,\"inputs\":[{\"name\":\"n\",\"type\":\"string\"}],\"name\":\"set\",\"outputs\":[],\"payable\":false,\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"constant\":true,\"inputs\":[],\"name\":\"get\",\"outputs\":[{\"name\":\"\",\"type\":\"string\"}],\"payable\":false,\"stateMutability\":\"view\",\"type\":\"function\"},{\"anonymous\":false,\"inputs\":[{\"indexed\":false,\"name\":\"name\",\"type\":\"string\"}],\"name\":\"SetName\",\"type\":\"event\"}]",
            "topicList": "SetName(string)",
            "createTime": "2020-02-26 16:21:12"
        }
    ],
    "totalCount": 1
}

16 可视化部署

16.1 获取 Docker 镜像版本

查询部署时可以选择的 Docker 镜像版本

16.1.1 传输协议规范

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

16.1.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	type	Integer	否	获取配置类型，1: Docker 镜像列表

2）入参示例

http://127.0.0.1:5001/WeBASE-Node-Manager/config/list?type=1

16.1.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Integer	否	返回码，0：成功；其它：失败
2	message	String	否	描述
3	data	List	否	镜像列表｜
3.1	id	Integer	否	镜像编号
3.1	configName	String	否	配置名称
3.1	configType	Integer	否	配置类型，1: Docker 镜像列表
3.1	configValue	String	否	镜像版本
3.1	createTime	Long	否	创建时间
3.1	modifyTime	Long	否	修改时间

2）出参示例

成功：

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "id": 1,
      "configName": "docker 镜像版本",
      "configType": 1,
      "configValue": "v2.5.0",
      "createTime": 1590577419000,
      "modifyTime": 1590577419000
    }
  ]
}

16.2 部署区块链底层服务

根据填写主机信息和选择的镜像版本部署区块链底层服务。服务器接收部署请求后，完成参数校验和数据库数据插入后，返回客户端请求结果，再异步完成区块链的部署操作。

16.2.1 传输协议规范

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

16.2.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	ipconf	Integer	否	主机 IP，数量，机构名称，所属群组信息
2	tagId	Integer	否	镜像编号，16.1.3 返回参数中的 id 值
3	dockerImageType	Integer	否	Docker 镜像拉取方式，0: 手动获取；1: 自动从 Docker Hub 拉取

注：ipconf 格式参考

# 1. 可以添加多行；
# 2. 页面需要提示，机构名只能包含英文字母，数字和下划线'_'；
# 3. 群组编号必须是数字；
# 4. 数量至少为 1，客户端的输入框默认为 1；
# 5. 同一个 IP 的主机，只属于一个机构；如果在单机部署，只能填写一个机构名
# 
# 格式：IP:数量 机构名 群组列表
# 比如：
172.0.0.1:2 agencyA 1,2,3
172.0.0.2:2 agencyB 2
172.0.0.3:2 agencyC 3
# 上面配置的意思：
1. 部署三台主机：172.0.0.1，172.0.0.2，172.0.0.3。
2. 172.0.0.x 的每台机器上创建 2 个节点，一共创建 6 个节点。
3. 创建 3 个机构：agencyA，agencyB，agencyC。
4. 创建三个群组：1，2，3。其中，群组 1 包含 172.0.0.1 中的两个节点；群组 2 包括 172.0.0.1 和 172.0.0.2 的 4 个节点；群组 3 包含 172.0.0.1 和 172.0.0.3 的 4 个节点。
5. 群组后续可以动态添加。

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/deploy/init

{
  "ipconf": [
    "172.0.0.2:2  A 1,2",
    "172.0.0.3:3  B 1,2,3,4"
  ],
  "tagId": "1",
  "dockerImageType": "0"
}

16.2.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Integer	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	String	否	部署请求结果
4	attachment	List	否	补充信息，比如：如果连接主机失败，表示连接失败的主机 IP

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": ""
}

失败：

{
    "code": 205015,
    "message": "Connect to host error",
    "data": "",
    "attachment": "172.0.0.2"
}

16.3 查询部署失败的错误信息

如果部署出现失败，调用此接口，返回每台主机部署的错误信息。

16.3.1 传输协议规范

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

16.3.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/deploy/host/list

16.3.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Integer	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	String	否	开关状态，0: 不进入可视化部署；1: 进入可视化部署。
3.1	id	Integer	否	主机编号
3.1	agencyId	String	否	主机所属机构编号
3.1	agencyName	String	否	主机所属机构名称
3.1	ip	String	否	主机 IP
3.1	sshUser	Integer	否	主机 SSH 免密登录账号，默认 root
3.1	sshPort	Integer	否	主机 SSH 登录端口，默认 22
3.1	rootDir	String	否	主机存放节点数据的目录，默认：/opt/fisco
3.1	dockerPort	String	否	主机 Docker daemon 监听端口，默认：3000
3.1	status	Integer	否	主机状态，0: 添加中，1: 初始化中，2: 初始化成功，3: 初始化失败
3.1	remark	Integer	否	部署失败时，主机的错误日志
3.1	createTime	Long	否	创建时间
3.1	modifyTime	Long	否	修改时间

2）出参示例

成功：

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "id": 19,
      "agencyId": 19,
      "agencyName": "AgencyA",
      "ip": "172.0.0.2",
      "sshUser": "root",
      "sshPort": 22,
      "rootDir": "/root/fisco",
      "dockerPort": 3000,
      "status": 2,
      "remark": "",
      "createTime": 1596959644000,
      "modifyTime": 1596959661000
    },
    .......
  ],
  "attachment": null
}

16.4 新增节点

添加一个新的节点到指定群组。服务器接收新增节点请求后，完成参数校验和数据库数据插入后，返回客户端请求结果，再异步完成节点新增操作。

16.4.1 传输协议规范

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

16.4.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	ip	String	否	部署新节点的主机 IP 地址
2	groupId	Integer	否	新节点所属的群组编号
3	agencyName	String	否	新主机所属的机构名称，可以是已有机构或新机构
4	dockerImageType	Integer	否	Docker 镜像拉取方式，0: 手动获取；1: 自动从 Docker Hub 拉取

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/deploy/node/add

{
  "ip": "172.0.0.4",
  "groupId": "1",
  "dockerImageType": "0",
  "agencyName": "AgencyNew"
}

16.4.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Integer	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	String	否	部署请求结果
4	attachment	List	否	补充信息，比如：如果连接主机失败，表示连接失败的主机 IP

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": ""
}

失败：

{
    "code": 205015,
    "message": "Connect to host error",
    "data": "",
    "attachment": "172.0.0.2"
}

16.5 启动节点

启动指定节点。

16.5.1 传输协议规范

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

16.5.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	nodeId	String	否	启动节点的节点编号

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/deploy/node/start

{
  "nodeId": "6aba77a7b81ddf71f5e5988c2ba96f51484b55d637286bf49babe48a34f935ee3866fc1a226b465b6bc9d716bfe8b349d82e80710b162e826c0cf91fb58e5099"
}

16.5.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Integer	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	String	否	启动命令执行结果

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": ""
}

16.6 停止节点

停止指定节点。

16.6.1 传输协议规范

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

16.6.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	nodeId	String	否	停止节点的节点编号

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/deploy/node/stop

{
  "nodeId": "6aba77a7b81ddf71f5e5988c2ba96f51484b55d637286bf49babe48a34f935ee3866fc1a226b465b6bc9d716bfe8b349d82e80710b162e826c0cf91fb58e5099"
}

16.6.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Integer	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	String	否	停止命令执行结果

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": ""
}

16.7 删除节点

删除指定节点。

16.7.1 传输协议规范

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

16.7.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	nodeId	String	否	停止节点的节点编号
2	deleteHost	Boolean	是	删除节点时，如果被删除节点是主机上最后一个节点，是否删除主机，true: 删除；false: 不删除；默认：false。
3	deleteAgency	Boolean	是	如果需要删除主机，在被删除主机机构最后一台主机，是否删除相应机构，true: 删除；false: 不删除；默认：false。

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/deploy/node/stop

{
  "nodeId": "6aba77a7b81ddf71f5e5988c2ba96f51484b55d637286bf49babe48a34f935ee3866fc1a226b465b6bc9d716bfe8b349d82e80710b162e826c0cf91fb58e5099",
  "deleteHost": "true",
  "deleteAgency": "false" 
}

16.7.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Integer	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	String	否	节点删除结果

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": ""
}

失败：

{
    "code": 205053,
    "message": "Node is running.",
    "data": ""
}

16.8 获取链信息

查询区块链信息，如果没有部署链，返回空；如果已经部署链，返回部署的链信息。

16.8.1 传输协议规范

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

16.8.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/deploy/chain/info

16.8.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Integer	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	String	否	链信息查询结果
3.1	id	Integer	否	链编号
3.1	chainName	String	否	链名称
3.1	chainDesc	String	否	链描述
3.1	version	String	否	底层的镜像版本
3.1	encryptType	Integer	否	加密方式，0: 非国密；1: 国密
3.1	chainStatus	Integer	否	链状态，具体状态查看备注信息
3.1	rootDir	String	否	节点主机存放节点数据的目录，默认：/opt/fisco
3.1	webaseSignAddr	String	否	WeBASE-Sign 服务的地址
3.1	runType	Integer	否	运行方式，1: 使用 Docker 运行
3.1	createTime	Long	否	创建时间
3.1	modifyTime	Long	否	修改时间

注：链状态

链状态编号	链状态
0	初始化中
1	部署中
2	部署失败
3	运行
4	重启中

2）出参示例

没有部署链：

{
    "code": 0,
    "message": "success",
    "data": ""
}

已经部署链：

{
  "code": 0,
  "message": "success",
  "data": {
    "id": 10,
    "chainName": "default_chain",
    "chainDesc": "default_chain",
    "version": "v2.5.0",
    "encryptType": 0,
    "chainStatus": 3,
    "rootDir": "/opt/fisco",
    "webaseSignAddr": "172.0.0.1:5004",
    "runType": 1,
    "createTime": 1596959644000,
    "modifyTime": 1596959700000
  },
  "attachment": null
}

16.9 重置链

重置已部署链，同时备份当前链数据。

16.9.1 传输协议规范

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

16.9.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/deploy/delete

16.9.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Integer	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	String	否	重置链结果

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": ""
}

16.10 查询服务器可视化部署选项配置

查询服务器的可视化部署的选项状态，判断是否进入可视化部署页面。

16.10.1 传输协议规范

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

16.10.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/deploy/type

16.10.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Integer	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	String	否	开关状态，0: 不进入可视化部署；1: 进入可视化部署。

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": "1"
}

17 其他接口

17.1 查询是否使用国密

获取WeBASE-Node-Manager是否使用国密版

17.1.1 传输协议规范

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

17.1.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	—	-	否	-

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/encrypt

17.1.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	code	Int	否	返回码，0：成功其它：失败
2	message	String	否	描述
3	data	Int	否	1: 国密，0：非国密

2）出参示例

成功：

{
    "code": 0,
    "message": "success",
    "data": 1 
}

17.2 查询WeBASE-Node-Manager的版本

获取WeBASE-Node-Manager服务的版本号

17.2.1 传输协议规范

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

17.2.2 请求参数

1）入参表

序号	输入参数	类型	可为空	备注
1	—	-	否	-

2）入参示例

http://localhost:5001/WeBASE-Node-Manager/version

17.2.3 返回参数

1）出参表

序号	输出参数	类型		备注
1	-	String	否	版本号

2）出参示例

成功：

v1.4.0

附录

2. Precompiled Service说明

对预编译合约接口的使用有疑惑，可以查看FISCO BCOS的PreCompiledService API说明

查看预编译合约的solidity接口代码，可以查看FISCO BCOS的web3sdk precompile模块，如crud/TableFactory.sol:

pragma solidity ^0.4.2;
contract TableFactory {
    function createTable(string tableName, string key, string valueField) public returns (int);
}

查看FISCO BCOS中实现的precompild合约列表、地址分配及源码：

地址	功能	源码(libprecompiled目录)
0x1000	系统参数管理	SystemConfigPrecompiled.cpp
0x1001	表工厂合约	TableFactoryPrecompiled.cpp
0x1002	CRUD合约	CRUDPrecompiled.cpp
0x1003	共识节点管理	ConsensusPrecompiled.cpp
0x1004	CNS功能	CNSPrecompiled.cpp
0x1005	存储表权限管理	AuthorityPrecompiled.cpp
0x1006	并行合约配置	ParallelConfigPrecompiled.cpp