数据库节点

active,stream 节点 SDK类名：/resource/ActiveNode

-------未激活机器节点-----

URL

/未激活节点

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则

未激活机器节点列表

SDK方法名：listInactiveNodes

URL

/active/node/inactive_list

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
total	Number	否	总数	20
message	String	否
info_list	Array	否	列表		5
node_name	String	否	节点名称	@name
address	String	否	ip地址	127.0.0.1
data_port	String	否	端口号	26804
version	String	否	版本	7.2.0.32472
os	String	否	操作系统	centos6.5
cache_dir	String	否	缓存目录	/var/i2data/cache/
ipctoken	String	否		@guid
registered	Boolean	否	是否被注册过	false
node_uuid	String	否	节点uuid	@guid
log_dir	String	否	日志目录	/var/i2data/log/
web_uuid	String	否	底层需要参数	@guid
phy_type	Number		操作系统类型	2
status	String		类型状态	inactive

激活机器节点

SDK方法名：activeNode

URL

/active/node

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
address	String	否	ip 地址	@ip
node_name	String	否	节点名	@name
data_port	String	否	数据端口	26804
cache_dir	String	否	数据缓存目录	/var/i2data/cache/
ipctoken	String	否		@guid
log_dir	String	否	日志目录	/var/i2data/log/
registered	Number	否	是否已注册过，1：已注册 0：未注册，已注册则表明要修改，否则为激活		0-1
comment	String	否	备注	string
web_uuid	String	否	底层需要的参数	@guid
node_type	String		1110001000
port	Object	否	节点类型
iarelay	String	否
iamsk	String	否
iasync	String
maintenance	Number		维护模式	0
phy_type	String		物理机类型
biz_grp_list	Array		分组的uuid
cluster_switch	Number		（机器节点集群）关闭：0，开启：1
node_uuids	String		（机器节点集群）包含机器节点uuid列表
node_cluster_type	String		是否可以被关联到集群，0：普通，1：集群

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		操作成功
uuid	String			@uuid

机器节点状态

SDK方法名：listNodeStatus

URL

/active/node/status

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuids	Array	否		["@guid","@guid"]

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否
info_list	Array	否
uuid	String	否	节点uuid	EF5863A9-BA50-4BE6-81B6-8E1C3A006327
status	String	否	离线：OFFLINE	ONLINE
version	String	否	版本	7.2.0.32522
os	String	否	操作系统	CentOS release 6.5 (Final)
process_status	Object	否	进程状态
iaback	String	否	离线：off 备端节点	on
iarelay	String	否	离线：off 中继节点	on
iawork	String	否	离线:off 源端节点	on
iatrack	String	否	离线:off	off
iaconsume	String		消费节点	on
iamask	String		脱敏节点
iascript	String

---------机器节点-------

URL

/机器节点

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则

机器节点列表(搜索)

SDK方法名：listNodes

URL

/active/node

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number	否	请求的页，默认为第一页	1
limit	Number	否	每页请求数量，默认为10	10
nodetype	String	否	获取指定类型（源端、备端）的节点，为空是表示不分类型	@pick{"name","source","backup"]}
search_field	String	否	字段名
order_by	String	否	排序方式 desc asc
sort	String	否		@pick{'name',address}
search_value	String	否	数据库要搜索的值
where_args	Array		条件过滤node_cluster_type=1 belongs_node = 0	["node_cluster_type"=1]

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
info_list	Array				10
username	String			admin
user_uuid	String			1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
node_uuid	String		节点uuid	EF5863A9-BA50-4BE6-81B6-8E1C3A006327
web_uuid	String			00000000-0000-0000-0000-000000000000
node_name	String		节点名称	mask_node
address	String		ip 地址	172.20.5.25
data_port	Number		端口	26804
log_dir	String		日志缓存	/u01/i2data/log/
cache_dir	String		缓存地址	/u01/i2data/cache/
comment	Null		备注
node_type	String		节点类型	1101
ipctoken	String		底层传上的值	A5426C57-A27A-4941-A731-F56902D00BBD
sample_interval	String		采样间隔	2
phy_type	String		物理类型	2
create_time	Number		创建时间	1587956895
port	String		端口类型	{"iawork":"","iatrack":"","iaback":"","iarelay":"","iamask":"","iaload":"","iamsg":"","sqlserver":"","iagauss":""}
is_biz_admin	Number			1
can_del	Number		操作的权限	1
can_op	Number			1
can_up	Number			1
biz_grp_list	Array
cluster_switch	Number		非机器节点集群：0，集群：1	@natural(0,1)
cluster_uuid	String		从属集群uuid
total	Number			1

机器节点详细信息

SDK方法名：descriptNode

URL

/active/node/:uuid([A-F0-9-]+)

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
registered	Number	否	是否为已注册节点 0：不是 1：是	1	0-1
uuid	String	否		31424826-A97D-4085-81AE-FD64EC58B6CE1

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否
active_node	Object	否
node_name	String	否	节点名称	@name
node_uuid	String	否	节点uuid	@guid
address	String	否	数据库ip	@ip
data_port	String	否	端口号	26804
os_type	String	否		centos6.5
cache_dir	String	否	缓存目录	/var/i2data/cache/
log_dir	String	否	日志目录	/var/i2data/log/
ipctoken	String	否	底层需要的值	D1AD0D6D-5622-41DA-BA47-8AACA6A5854E
node_type	String	否	节点类型	10000111
port	Object	否	端口号
iawork	String	否
iaback	String	否
iarelay	String	否
iatrack	String	否
iamask	String	否
iaload	String	否
iamsg	String	否		6666
iagauss	String	否		567
sqlserver	String	否		888
reg	Number	否		1
web_uuid	String		底层需要	@guid

状态信息

SDK方法名：descriptNodeDebugInfo

URL

/active/node/debug_info

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuid	String	否		41D1C1E8-60AE-4853-9694-5599560EEB0F
last_time	Number

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0]操作成功
debug_node	Array	否	tab2调试信息用
conn_bk	String	否	链接信息	链接信息bk
conn_wk	String	否		链接信息wk
thd_bk	String	否	线程信息
thd_wk	String	否
conf_bk	String	否	配置信息
conf_wk	String	否
obj_bk	String	否	对象信息
obj_wk	String	否
relay_db	String	否	中继信息	中继信息db
relay_tok	Boolean	否	false	false
cpu_useage	Array	否	CPU占用charts用	[ 0.460829496383667, 0.921658992767334, 0.46296295523643494, 0.9174311757087708 ]
cpu_useage_info	Array	否	右边实时CPU占用方框用	["0.55","0.55"]
memory_useage	Array	否	内存占用charts用	[ 20.145530700683594, 20.145530700683594, 20.145530700683594, 20.145530700683594 ]
memory_useage_info	Array	否	暂时废弃，没有用		1-10
network_useage_info	Array	否	右边实时输入输出方框用	[{name:"total", recv: "2087", send: "1300"},{name:"eth3", recv: "1087", send: "300"},{name:"eth4", recv: "10", send: "400"}]
network_useage_netsend	Array	否	网络发送数据charts用，2个用一个图	[ 1741, 7052, 1848, 2021 ]
network_useage_netrecv	Array	否	网络接收数据charts用，2个用一个图	[ 1154, 5545, 1249, 1489 ]
time	Array	否	["2018/11/09 10:40:06","2018/11/10 10:41:06","2018/11/11 10:42:06","2018/11/12 10:43:06","2018/11/13 10:44:06","2018/11/14 10:45:06","2018/11/15 10:46:06"]	[1605175400,1605175450,1605175500]
process_status	Object	否	进程的返回信息
iawork	String	否		ok
iaback	String	否		ignore
iarelay	String	否		bad
iatrack	String	否		bad
iaconsume	String			bad

修改机器节点

SDK方法名：modifyNode

URL

/active/node

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
node_name	String	否	机器节点名	@name
address	String	否	机器节点IP	192.168.12.199
iptoken	String	否	底层所需值	780B4F1B-6FB9-46C4-98AC-02A8DF4A1C76
data_port	String	否	数据端口，所有节点的端口默认都由该端口递增获得，您也可以通过点击下方节点按钮后面的修改图标来自定义节点端口	26804
cache_dir	String	否	缓存目录	/var/i2data/cache/
log_dir	String	否	日志目录	/var/i2data/log/
node_uuid	String	否	节点uuid	31424826-A97D-4085-81AE-FD64EC58B6CE1
registered	Number	否		1
comment	String	否	备注	string
web_uuid	String	否		@guid
port	Object	否	端口，7.1.75+ 忽略该选项
iarelay	String	否		26806
iamask	String	否		26808
iasync	String			26803
maintenance	Number		维护模式	0
node_type	String		每一位对应一种库（端口）类型 7.1.75+， 对应节点类型 "1111", 从左到右，源端节点、备端节点、中继、脱敏	1111010000
phy_type	String		物理机类型 vm:2	2
os_type	String		操作系统类型 linux:0 window:1 （未激活节点会提供此数据）	0
biz_grp_list	Array		分组uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		操作成功
uuid	String			@uuid

删除机器节点

SDK方法名：deleteNode

URL

/active/node

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuids	Array	否		["@guid","@guid"]
force	Number			0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		2
message	String	否		Delete success
success_list	Array
message	String			uu
node_uuid	String			yy
node_name	String			gg
code	String			0
fail_list	Array
message	String			yy
node_uuid	String			yy
node_name	String			tt
code	String			0

机器节点升级

SDK方法名：upgradeNode

URL

/active/node/upgrade

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuids	Array			["@guid"]

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			操作成功

机器节点-维护模式切换

SDK方法名：switchMaintenance

URL

/active/node/maintenance

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuid	String			bBae9dCA-f6cc-BA66-bF59-8DFc395eD094
maintenance_switch	Number		维护模式0关，1开	0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			操作成功

--------库节点------

URL

/库节点

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则

获取字符集

getCharset

URL

/active/db/charset

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	String
msg	String
data	Object		字符集
charset	Array			['AL16UTF16', 'AL24UTFFSS', 'AL32UTF8', 'AR8ADOS710', 'AR8ADOS710T', 'AR8ADOS720', 'AR8ADOS720T', 'AR8APTEC715', 'AR8APTEC715T', 'AR8ARABICMAC', 'AR8ARABICMACS', 'AR8ARABICMACT', 'AR8ASMO708PLUS', 'AR8ASMO8X', 'AR8EBCDIC420S', 'AR8EBCDICX', 'AR8HPARABIC8T', 'AR8ISO8859P6', 'AR8MSWIN1256', 'AR8MUSSAD768', 'AR8MUSSAD768T', 'AR8NAFITHA711', 'AR8NAFITHA711T', 'AR8NAFITHA721', 'AR8NAFITHA721T', 'AR8SAKHR706', 'AR8SAKHR707', 'AR8SAKHR707T', 'AR8XBASIC', 'AZ8ISO8859P9E', 'BG8MSWIN', 'BG8PC437S', 'BLT8CP921', 'BLT8EBCDIC1112', 'BLT8EBCDIC1112S', 'BLT8ISO8859P13', 'BLT8MSWIN1257', 'BLT8PC775', 'BN8BSCII', 'CDN8PC863', 'CE8BS2000', 'CEL8ISO8859P14', 'CH7DEC', 'CL8BS2000', 'CL8EBCDIC1025', 'CL8EBCDIC1025C', 'CL8EBCDIC1025R', 'CL8EBCDIC1025S', 'CL8EBCDIC1025X', 'CL8EBCDIC1158', 'CL8EBCDIC1158R', 'CL8ISO8859P5', 'CL8ISOIR111', 'CL8KOI8R', 'CL8KOI8U', 'CL8MACCYRILLIC', 'CL8MACCYRILLICS', 'CL8MSWIN1251', 'D7DEC', 'D7SIEMENS9780X', 'D8BS2000', 'D8EBCDIC1141', 'D8EBCDIC273', 'DK7SIEMENS9780X', 'DK8BS2000', 'DK8EBCDIC1142', 'DK8EBCDIC277', 'E7DEC', 'E7SIEMENS9780X', 'E8BS2000', 'EE8BS2000', 'EE8EBCDIC870', 'EE8EBCDIC870C', 'EE8EBCDIC870S', 'EE8ISO8859P2', 'EE8MACCE', 'EE8MACCES', 'EE8MACCROATIAN', 'EE8MACCROATIANS', 'EE8MSWIN1250', 'EE8PC852', 'EEC8EUROASCI', 'EEC8EUROPA3', 'EL8DEC', 'EL8EBCDIC423R', 'EL8EBCDIC875', 'EL8EBCDIC875R', 'EL8EBCDIC875S', 'EL8GCOS7', 'EL8ISO8859P7', 'EL8MACGREEK', 'EL8MACGREEKS', 'EL8MSWIN1253', 'EL8PC437S', 'EL8PC737', 'EL8PC851', 'EL8PC869', 'ET8MSWIN923', 'F7DEC', 'F7SIEMENS9780X', 'F8BS2000', 'F8EBCDIC1147', 'F8EBCDIC297', 'HU8ABMOD', 'HU8CWI2', 'I7DEC', 'I7SIEMENS9780X', 'I8EBCDIC1144', 'I8EBCDIC280', 'IN8ISCII', 'IS8MACICELANDIC', 'IS8MACICELANDICS', 'IS8PC861', 'IW7IS960', 'IW8EBCDIC1086', 'IW8EBCDIC424', 'IW8EBCDIC424S', 'IW8ISO8859P8', 'IW8MACHEBREW', 'IW8MACHEBREWS', 'IW8MSWIN1255', 'IW8PC1507', 'JA16DBCS', 'JA16DBCSFIXED', 'JA16EBCDIC930', 'JA16EUC', 'JA16EUCFIXED', 'JA16EUCTILDE', 'JA16EUCYEN', 'JA16MACSJIS', 'JA16SJIS', 'JA16SJISFIXED', 'JA16SJISTILDE', 'JA16SJISYEN', 'JA16VMS', 'KO16DBCS', 'KO16DBCSFIXED', 'KO16KSC5601', 'KO16KSC5601FIXED', 'KO16KSCCS', 'KO16MSWIN949', 'LA8ISO6937', 'LA8PASSPORT', 'LT8MSWIN921', 'LT8PC772', 'LT8PC774', 'LV8PC1117', 'LV8PC8LR', 'LV8RST104090', 'N7SIEMENS9780X', 'N8PC865', 'NDK7DEC', 'NE8ISO8859P10', 'NEE8ISO8859P4', 'NL7DEC', 'RU8BESTA', 'RU8PC855', 'RU8PC866', 'S7DEC', 'S7SIEMENS9780X', 'S8BS2000', 'S8EBCDIC1143', 'S8EBCDIC278', 'SE8ISO8859P3', 'SF7ASCII', 'SF7DEC', 'TH8MACTHAI', 'TH8MACTHAIS', 'TH8TISASCII', 'TH8TISEBCDIC', 'TH8TISEBCDICS', 'TR7DEC', 'TR8DEC', 'TR8EBCDIC1026', 'TR8EBCDIC1026S', 'TR8MACTURKISH', 'TR8MACTURKISHS', 'TR8MSWIN1254', 'TR8PC857', 'US7ASCII', 'US8BS2000', 'US8ICL', 'US8PC437', 'UTF8', 'UTFE', 'VN8MSWIN1258', 'VN8VN3', 'WE8BS2000', 'WE8BS2000E', 'WE8BS2000L5', 'WE8DEC', 'WE8DG', 'WE8EBCDIC1047', 'WE8EBCDIC1047E', 'WE8EBCDIC1140', 'WE8EBCDIC1140C', 'WE8EBCDIC1145', 'WE8EBCDIC1146', 'WE8EBCDIC1148', 'WE8EBCDIC1148C', 'WE8EBCDIC284', 'WE8EBCDIC285', 'WE8EBCDIC37', 'WE8EBCDIC37C', 'WE8EBCDIC500', 'WE8EBCDIC500C', 'WE8EBCDIC871', 'WE8EBCDIC924', 'WE8GCOS7', 'WE8HP', 'WE8ICL', 'WE8ISO8859P1', 'WE8ISO8859P15', 'WE8ISO8859P9', 'WE8ISOICLUK', 'WE8MACROMAN8', 'WE8MACROMAN8S', 'WE8MSWIN1252', 'WE8NCR4970', 'WE8NEXTSTEP', 'WE8PC850', 'WE8PC858', 'WE8PC860', 'WE8ROMAN8', 'YUG7ASCII', 'ZHS16CGB231280', 'ZHS16CGB231280FIXED', 'ZHS16DBCS', 'ZHS16DBCSFIXED', 'ZHS16GBK', 'ZHS16GBKFIXED', 'ZHS16MACCGB231280', 'ZHS32GB18030', 'ZHT16BIG5', 'ZHT16BIG5FIXED', 'ZHT16CCDC', 'ZHT16DBCS', 'ZHT16DBCSFIXED', 'ZHT16DBT', 'ZHT16HKSCS', 'ZHT16HKSCS31', 'ZHT16MSWIN950', 'ZHT32EUC', 'ZHT32EUCFIXED', 'ZHT32SOPS', 'ZHT32TRIS', 'ZHT32TRISFIXED']

库节点 - 维护模式切换

SDK方法名：switchDbMaintenance

URL

/active/db/maintenance

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuid	String			bBae9dCA-f6cc-BA66-bF59-8DFc395eD094
maintenance_switch	Number		维护模式0关，1开	0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			操作成功

数据库健康信息(已废弃)

SDK方法名：describeDbHealthInfo

URL

/active/db/health_info

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuid	String	否	数据库节点uuid	@guid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
info	Object	否
connect	String	否	连接状态	127.0.0.1 connect ok
tablespace	String	否	表空间占用
asm_disk	String	否	asm 磁盘占用
headroom	String	否	headroom 值	Date_Time Headroom 2019/05/16 17:14:14 11671.695902
lock_db	String	否	锁定表
gragh	Array	否	锁定信息
cloud	Array	否
spend	String	否		1000
txn	Array	否
scn_time	String	否
irp	String	否
urp	String	否
drp	String	否
qmi	String	否
txn	String	否
log_thd	Array	否
id	String	否
scn_time	String	否

库节点列表

SDK方法名：listDbs

URL

/active/db

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number	否		1
limit	Number	否		10
search_field	String	否	用于搜索的键 db_name: 库节点名称 ip:数据库ip, server_name:服务名 /数据库名	db_name
search_value	String	否	用于搜索的值
role	String	否	数据库节点的角色： 源端节点1； 备端节点：2 ，不传默认为全部
direction	String			''
db_type	String		数据库类型： oracle kafka mysql postgres vertica greenplum
ip	String		数据库IP
port	String		数据库端口
service_name	String		数据库名或服务名

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
info_list	Array
node_name	String		节点名称	node26
node_type	String		节点类型	00010000
node_ip	String		节点ip	172.20.5.26
username	String		用户名	admin
user_uuid	String		用户uuid	1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
db_uuid	String		数据库节点uuid	0792EC0B-B84A-FA60-1ED5-B33B0B1591F8
db_name	String		数据库名称	123123123
node_uuid	String		节点uuid	B1A3F55A-027E-4B49-A4FA-D9ED9807ACBF
db_type	String		节点类型	sqlserver
deploy_mode	String		单机模式	single
log_read_type	String		日志读取方式	file
file_open_type	String		文件打开方式	normal
db_encryed	Number			1
db_mode	String			normal
is_biz_admin	Number		操作权限	1
can_del	Number			1
can_op	Number			1
can_up	Number			1
uuid	String			@guid
total	Number			9

测试数据库连接

SDK方法名：checkDbLink

URL

/active/db/db_check1

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
db_name	String	否	数据库名	@name
node_uuid	String	否	节点uuid	778553A7-9A06-4F05-AB40-8BD59F353D62
db_type	String	否	数据库类型	oracle
file_open_type	String	否	文件打开方式	DIRECT
deploy_mode	String	否	部署方式	single
log_read_type	String	否	日志读取方式	file
config	Object	否
username	String	否	用户名	@name
password	String	否	密码	i2
server_name	String	否	服务名	orcl
port	Number	否		1521
log_read	Object	否
os_auth	Number	否		1
asm_instance	String	否
asm_username	String	否
asm_port	Number	否		1521
asm_password	String	否		12323131
filter_session	Number	否		1
relay	Object	否	中继节点
enable	Number	否		1
relay_node_uuid	String	否
remote_file_agent	Object	否	远程文件代理
enable	Number	否		1
port	Number	否		1
compress	String	否		none
db_list	Array	否	多个ip配置放此处
ip	String	否		@ip
thread	String	否		1
disable	String	否		1
broker_server	Array	否	kafka配置
ip	String	否		@ip
port	Number	否		8080
charset	String		字符
kafka_auth_type	String			none
kerberos_keytab_path	String
kerberos_principal	String
kerberos_service_name	String		kafka
kudu_impala	Object		kudu 连接模式
impala_server_ip	String			@ip
impala_server_port	String			21050
impala_auth_type	String
default_database	String
impala_client_keytab_path	String
impala_client_krb_principal	String
impala_server_krbhost_fqdn	String
impala_server_krbrealm	String
impala_server_krbservice_name	String
db_schema	String			oracle
db_uuid	String	否	数据库uuid	6C4AEF37-6496-6DCD-E085-DD640001E4EC
node_type	String			1110001000
db_mode	String			normal

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		connect success

测试数据库连接（格式统一）

SDK方法名：checkDbLink

URL

/active/db/db_check

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuid	String		机器节点uuid	6C4AEF37-6496-6DCD-E085-DD640001E4EC
type	String			oracle
conf	Array				4
id	Array		数据库标识	[1,2,3,4]	+1
name	Array		数据库实例名，数据库名、数据库服务名 ... ...	["kfk","oracle","kfk","kudu"]	+1
ip	String			172.20.5.116
port	String			1521
auth	Array			["none","pass","kerberos"]	+1
pass	Object
user	Array			["i2","i2",null,null]	+1
pass	Array			["i2","i2",null,null]	+1
kerberos	Object
principal	Array			["",null,"",""]	+1
keytab	Array			["",null,"",""]	+1
impala	Object
ip	Array			["",null,null,""]	+1
port	Array			["",null,null,""]	+1
name	Array			["",null,null,""]	+1
auth	Array			["kerberos",null,null,"kerberos"]	+1
kerberos	Object
realm	Array			["",null,null,""]	+1
name	Array			["",null,null,""]	+1
host	Array			["",null,null,""]	+1
principal	Array			["",null,null,""]	+1
keytab	Array			["",null,null,""]	+1
model	Number		只有在elasticsearch,oceanbase类型时传值，其余类型不传这个参数 elasticsearch 0对应HTTP，1对应HTTPS oceanbase 0对应Oracle，1对应MySQL	["0","1"]	+1
sniff	Number		只有在elasticsearch类型时传值，其余类型不传这个参数 0对应否，1对应是	["0","1"]	+1
jsonver	Object

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object				2
message	String
code	Number			0
result	Array
state	Number			0
id	String			0

库节点状态

SDK方法名：listDbStatus

URL

/active/db/status

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuids	Array	否		@guid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否
status	Array	否			2
db_uuid	String	否		0792EC0B-B84A-FA60-1ED5-B33B0B1591F8
status	String	否	ONLINE, OFFLINE	ONLINE
version	String	否		7.2.0.32522
uuid	String			@guid

库节点 - 新建（旧版本已废弃）

SDK方法名：createDb

URL

/active/db(old_version)

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
db_uuid	String	否	数据库节点的uuid,为空的话，则表明是创建，不为空则为修改	@guid
db_name	String	否		@name
node_uuid	String	否		@guid
db_type	String	否	数据库类型： oracle kafka mysql postgres vertica greenplum	oracle
file_open_type	String	否	normal:普通方式，DIRECT：DIRECT	0
deploy_mode	String	否	oracle：部署方式：single:单机 cluster:集群	0
log_read_type	String	否		file
config	Object	否
username	String	否	oracle	@name
password	String	否	oracle
server_name	String	否	oracle
port	Number	否	oracle	1
relay	Object	否	oracle
enable	Number	否	是否有中继节点	1
relay_node_uuid	String	否	中继节点uuid
log_read	Object	否	oracle
os_auth	Number	否	asm|asm_device: 是否os认证 1：认证 0：不认证	1
asm_instance	String	否	asm|asm_device: asm 实例
asm_username	String	否	asm|asm_device: ASM用户名
asm_port	Number	否	asm|asm_device: asm 端口号	1
asm_password	String	否		12323131
filter_session	Number	否	1:过滤 0：不过滤	1
remote_file_agent	Object	否	oracle:远程文件代理
enable	Number	否	是否启用	1
port	Number	否	端口	1
compress	String	否	压缩类型：no（不压缩） lzo，zip	no
db_list	Array	否	oracle
ip	String	否
thread	String	否
disable	Number	否		0	0-1
producer_host	String	否	kafka: Producer 主机	@ip
producer_port	Number	否	kafka: Producer 端口	1
broker_server	Array	否	kafka | qianbase（已废弃）
port	Number	否		1
ip	String	否	端口	@ip
authentication	String	否	kafka: none,Kerberos,username 认证方式	none
principal	String	否	kafka
keytabfile	String	否	kafka
kafka_auth_type	String	否	none sasl_gssapi sasl_plain(用户名和密码) sasl_authentication(sasl 认证) ssl
kerberos_keytab_path	String	否	principal
kerberos_principal	String	否	keytab路径
kerberos_service_name	String	否	kafka 服务名
sasl_plain_user	String	否	用户名
sasl_plain_pass	String	否	密码
sqlserver	Object	否	已废弃
ip	String	否
port	Number	否
usr	String	否
pwd	String	否
db	String	否
dacport	String	否
user_management	Array		用户管理（除Oracle之外都适用）
user	String		用户名
passwd	String		密码
default_db	String		默认数据库
certificate	String		（qianbasextp）用户口令证书路径
cred_uuid	String		凭据uuid
cred_login	Number		凭据开启与否
db_ip	String
model	Number
sniff	String
role	Array		source,target
source	Number		0: 不选中	0
target	Number		1：选中	1
login_url	String		登陆url
conn_pool_max	Number
instance_name	String		数据库实例名（暂时只有informix存在此值）
database_name	String		数据库名（暂时只有informix存在此值）
jks	String		ssl 格式认证书认证
kerberos_keytab_auth	String		kerberos 添加用户
user_oceanbase	String		管理用户（oceanbase）
db2_run_system	String		DB2运行系统：下拉列表 有俩值：LUW， AS400
ssl_switch	Number		MySQL：ssl开关，0关1开	0
db_mode	String	否	normal,cdb,pdb
cdb	String	否		@guid
biz_grp_list	Array
maintenance	String		开启维护模式：1 关闭维护模式：0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		operate success
uuid	String			@uuid

库节点-新建 （格式统一7.1.75+）

SDK方法名：createDbUnified

URL

/active/db

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
db_uuid	String	否	数据库节点的uuid,为空的话，则表明是创建，不为空则为修改	@guid
db_name	String	否		@name
node_uuid	String	否		@guid
db_type	String	否	数据库类型： oracle kafka mysql postgres vertica greenplum	oracle
password	String	否	oracle
file_open_type	String	否	normal:普通方式，DIRECT：DIRECT	0
deploy_mode	String	否	oracle：部署方式：single:单机 cluster:集群	0
log_read_type	String	否		file
config	Object	否
auth	String		登录认证方式，默认pass方式 none：无 pass：密码 kerberos：kerberos认证 oauth: oauth认证 ca：qianbase xtp证书认证
relay	Object	否	oracle
enable	Number	否	是否有中继节点	1
relay_node_uuid	String	否	中继节点uuid
log_read	Object	否	oracle
os_auth	Number	否	asm|asm_device: 是否os认证 1：认证 0：不认证	1
asm_instance	String	否	asm|asm_device: asm 实例
asm_username	String	否	asm|asm_device: ASM用户名
asm_port	Number	否	asm|asm_device: asm 端口号	1
asm_password	String	否		12323131
filter_session	Number	否	1:过滤 0：不过滤	1
remote_file_agent	Object	否	oracle:远程文件代理
enable	Number	否	是否启用	1
port	Number	否	端口	1
compress	String	否	压缩类型：no（不压缩） lzo，zip	no
db_list	Array	否	oracle
ip	String	否
thread	String	否	（Oracle）线程号
disable	Number	否	（Oracle）禁用与否，1：禁用，0：启用	0	0-1
port	String		端口
http_port	String		（starrocks）数据端口
user_management	Array		用户管理（除Oracle之外都适用）
user	String		用户名
passwd	String		密码
default_db	String		默认数据库
cred_uuid	String		凭据uuid
cred_login	Number		凭据开启与否
url	String		（oauth认证）登录url
auth_uuid	String		（认证uuid，不下发则为创建）
model	Number
sniff	String
role	Array		source,target
source	Number		0: 不选中	0
target	Number		1：选中	1
transport	Object
auth	String		ssl或者gmssl
ssl_mode	String		(qianbasextp)disable/require/verify-full
certificate	String		认证文件路径
replication_num	String		（starrocks）副本数
db_mode	String	否	normal,cdb,pdb
cdb	String	否		@guid
biz_grp_list	Array
maintenance	String		开启维护模式：1 关闭维护模式：0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		operate success
uuid	String			@uuid

库节点 - 修改

SDK方法名：modifyDb

URL

/active/db/:uuid([A-F0-9-]+)

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
db_name	String	否	数据库名	@name
db_uuid	String	否	数据库uuid	A0A0526D-6503-5C2A-E3D8-7D85813967F1
db_type	String	否	数据库类型	oracle
node_uuid	String	否	机器节点uuid	0596a77C-64Fd-cAf2-DB9c-cAaeBD56eD88
file_open_type	String	否	文件打开方式	0
deploy_mode	String	否		0
log_read_type	String	否	日志读取方式	file
random_str	String	否
config	Object	否
username	String	否	用户名	@name
password	String	否	密码
server_name	String	否	服务名
port	Number	否	端口	1
log_read	Object	否	asm 实例
os_auth	Number	否		1
asm_instance	String	否
asm_username	String	否
asm_port	Number	否		1
asm_password	String	否		12323131
filter_session	Number	否	会话过滤	1
relay	Object	否	中继
enable	Number	否		1
relay_node_uuid	String	否
remote_file_agent	Object	否	远程文件代理
enable	Number	否		1
port	Number	否		1
compress	String	否		no
db_list	Array	否	集群/多ip
ip	String	否
thread	String	否
broker_server	Array	否	kafka
ip	String	否		@ip
port	Number	否		1
conn_pool_max	Number		连接池最大连接数
instance_name	String		数据库实例名（暂时只有informix存在此值）
database_name	String		数据库名（暂时只有informix存在此值）
cdb	String			@guid
maintenance	String		开启维护模式：1 关闭维护模式：0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		operate success
uuid	String			@uuid

表空间查询接口

SDK方法名：describeDbSpace

URL

/active/db/space_query

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuid	String	否		A0A0526D-6503-5C2A-E3D8-7D85813967F1

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		operate success

删除库节点

SDK方法名：deleteDb

URL

/active/db

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuids	Array	否		["A0A0526D-6503-5C2A-E3D8-7D85813967F1"]
force	Number		0不强制 1强制删除	0

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		-1
message	String	否		Delete success
success_list	Array
code	Number			0
message	String
db_name	String			@name
db_uuid	String			@uuid
fail_list	Array
code	Number			-1
message	String
db_uuid	String			@uuid
db_name	String			@name

批量导入

SDK方法名：batchCreateDbs

URL

/active/db/batch

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0]操作成功。

单个库节点信息

SDK方法名：describeDb

URL

/active/db/:uuid([A-F0-9-]+)

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] success
active_db	Object	否
username	String	否		admin
id	String	否		4
create_time	String	否		1560328411
db_uuid	String	否		3E2EBF85-7261-3FA2-9A6C-23AC0C2174E8
random_str	String	否		1B826A2D-7373-C3A7-0695-ADB854EC08BA
user_uuid	String	否		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
db_name	String	否		db31
node_uuid	String	否		3E2EBF85-8261-3FA2-9A6C-23AC0C2174E8
db_type	String	否		oracle
file_open_type	String	否		normal
deploy_mode	String	否		single
log_read_type	String	否		asm
config	Object	否
username	String	否		root
password	String	否		xxxxxx
server_name	String	否		server1
port	Number	否		1
log_read	Object	否
os_auth	Number	否		1
asm_instance	String	否
asm_username	String	否
asm_port	Number	否		1
asm_password	String	否		12323131
filter_session	Number	否		1
relay	Object	否
enable	Number	否		1
relay_nodeuuid	String	否
remote_file_agent	Object	否
enable	Number	否		1
port	Number	否		1
compress	String	否		none
db_list	Array	否
ip	String	否
thread	String	否
broker_server	Array	否
ip	String	否		8.8.4.4
port	Number	否		1
kafka_auth_type	String			sasl_plain
db_mode	String	否		pdb
cdb	String	否		@uuid
uuid	String			@uuid

重新生成

SDK方法名：rebuildActiveNode;

URL

/active/node/rebuild

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuid	String		33333-xxxxx-222222

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			operate success

刷新

SDK方法名：refresgActiveNode;

URL

/active/node/refresh

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuid	String		日志规则的uuid	xxxxxxxxx

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			operate success
log_name	String			2021-4-13_4-44-33.zip

机器节点 - 重启进程

SDK方法名：restartAllProcess

URL

/active/node/process_restart

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
uuid	String		机器节点uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	String
msg	String
data	Object
code	String
message	String

库节点 - 身份认证信息

SDK方法名：获取对应数据库节点的认证信息getActiveDbAuthInfo

URL

/active/db/auth_info

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
db_uuid	String		数据库uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	String
msg	String
info_list	Object
auth_uuid	String		认证信息uuid
auth_name	String		用户名
auth_pass	String		密码
auth_type	String		认证类型：none pass kerberos ssl oauth ca
auth_default_name	String		默认数据库名、其他默认值名
update_time	Number		更新时间
user_uuid	String
db_uuid	String
enable	Number		启用
cred_enable	Number		凭据启用
cred_uuid	String		凭据uuid