数据库节点

SDK类名：/resource/ActiveNode

库节点列表

SDK方法名：listDbs

URL

/vers/v3/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

/vers/v3/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
info	Array
ip	String		ip
port	String		端口
user	String		用户
code	String		错误码
message	String		信息

数据库节点 - 状态

SDK方法名：listDbStatus

URL

/vers/v3/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
set	Array		IP连接状态（74及以前节点版本不支持）
user	String		用户名
ip	String		IP
port	String		端口
state	String		IP连接状态，NORMAL，ERROR（只要有用户可以连接即为正常）
msg	String		错误原因

数据库节点 - 新建

SDK方法名：createDbUnified

URL

/vers/v3/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）副本数
zookeeper	Object		zookeeper配置
set	Array
ip	String		地址
port	String		端口
zk_node	String		zNode
pdserver	Array		pd servers
ip	String
port	String
manual_ocp_conf	Number		集群管理信息获取方式，自动查询OCP：0，手动输入：1
ocp_server	Array		（OceanBase）手动配置OCP集群管理信息
ip	String		IP
rpcport	String		RPC端口
sqlport	String		SQL端口
db_mode	String	否	normal,cdb,pdb
cdb	String	否		@guid
biz_grp_list	Array
maintenance	String		开启维护模式：1 关闭维护模式：0
comment	String		备注

Response

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

数据库节点 - 修改

SDK方法名：modifyDb

URL

/vers/v3/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存在此值）
password	String	否
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

/vers/v3/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

/vers/v3/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

/vers/v3/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方法名：switchDbMaintenance

URL

/vers/v3/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方法名：describeDb

URL

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

Method

GET

Request

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

Response

名称	类型	必选	简介	Mock初始值	Mock规则
db_name	String	否		Shirley Hernandez
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方法名：getActiveDbAuthInfo

URL

/vers/v3/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

数据库节点 - 批量新建

SDK方法名：batchCreateSqlserverDbs

URL

/vers/v3/active/db/db_batch

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
bind_lic_list	Array
db_list	String		数据库信息json字符串
db_type	String		数据库类型
node_uuid	String		机器节点
prefix	String		前缀
role	String		角色

Response

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

数据库节点 - 获取字符集

SDK方法名：getCharset;

URL

/vers/v3/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']