Active、数据库节点管理
November 23, 2021About 21 min
Active、数据库节点管理
active,stream,kafka节点建立 SDK类名:/resource/ActiveNode
-------未激活节点-----
URL
Method
Request
Response
未激活节点列表
SDK方法名:listInactiveNodes
URL
//active/node/inactive_list
Method
Request
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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 | 否 | 127.0.0.1 | ip地址 | |
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 | 否 | @guid | 节点uuid | |
log_dir | String | 否 | /var/i2data/log/ | 日志目录 | |
web_uuid | String | 否 | @guid | 底层需要参数 | |
phy_type | Number | | 2 | 操作系统类型 | |
status | String | | inactive | 类型状态 | |
激活
SDK方法名:activeNode
URL
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | 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 | | | 物理机类型 | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | 否 | 200 | | |
msg | String | 否 | | | |
data | Object | 否 | | | |
code | Number | 否 | 0 | | |
message | String | 否 | 操作成功 | | |
uuid | String | | @uuid | | |
节点状态
SDK方法名:listNodeStatus
URL
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
uuids | Array | 否 | ["@guid","@guid"] | | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | 否 | 200 | | |
msg | String | 否 | | | |
data | Object | 否 | | | |
code | Number | 否 | 0 | | |
message | String | 否 | | | |
info_list | Array | 否 | | | |
uuid | String | 否 | EF5863A9-BA50-4BE6-81B6-8E1C3A006327 | 节点uuid | |
status | String | 否 | ONLINE | 离线:OFFLINE | |
version | String | 否 | 7.2.0.32522 | 版本 | |
os | String | 否 | CentOS release 6.5 (Final) | 操作系统 | |
process_status | Object | 否 | | 进程状态 | |
iaback | String | 否 | on | 离线:off 备端节点 | |
iarelay | String | 否 | on | 离线:off 中继节点 | |
iawork | String | 否 | on | 离线:off 源端节点 | |
iatrack | String | 否 | off | 离线:off | |
iaconsume | String | | on | 消费节点 | |
iamask | String | | | 脱敏节点 | |
iascript | String | | | | |
---------机器节点-------
URL
Method
Request
Response
节点列表(搜索)
SDK方法名:listNodes
URL
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | 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 | 否 | | 数据库要搜索的值 | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | | 200 | | |
msg | String | | | | |
data | Object | | | | |
code | Number | | 0 | | |
message | String | | [0] 操作成功。 | | |
info_list | Array | | | | |
username | String | | admin | | |
user_uuid | String | | 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC | | |
node_uuid | String | | EF5863A9-BA50-4BE6-81B6-8E1C3A006327 | 节点uuid | |
web_uuid | String | | 00000000-0000-0000-0000-000000000000 | | |
node_name | String | | mask_node | 节点名称 | |
address | String | | 172.20.5.25 | ip 地址 | |
data_port | Number | | 26804 | 端口 | |
log_dir | String | | /u01/i2data/log/ | 日志缓存 | |
cache_dir | String | | /u01/i2data/cache/ | 缓存地址 | |
comment | Null | | | 备注 | |
node_type | String | | 11010000 | 节点类型 | |
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 | | |
total | Number | | 1 | | |
获取单个详细信息
SDK方法名:descriptNode
URL
//active/node/:uuid([A-F0-9-]+)
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
registered | Number | 否 | 1 | 是否为已注册节点 0:不是 1:是 | 0-1 |
uuid | String | 否 | 31424826-A97D-4085-81AE-FD64EC58B6CE1 | | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | 否 | 200 | | |
msg | String | 否 | | | |
data | Object | 否 | | | |
code | Number | 否 | 0 | | |
message | String | 否 | | | |
active_node | Object | 否 | | | |
node_name | String | 否 | @name | 节点名称 | |
node_uuid | String | 否 | @guid | 节点uuid | |
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
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
uuid | String | 否 | 41D1C1E8-60AE-4853-9694-5599560EEB0F | | |
last_time | Number | | | | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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 | 否 | [ | | |
0.460829496383667, | | | | | |
0.921658992767334, | | | | | |
0.46296295523643494, | | | | | |
0.9174311757087708 | | | | | |
] | CPU占用charts用 | | | | |
cpu_useage_info | Array | 否 | ["0.55","0.55"] | 右边实时CPU占用方框用 | |
memory_useage | Array | 否 | [ | | |
20.145530700683594, | | | | | |
20.145530700683594, | | | | | |
20.145530700683594, | | | | | |
20.145530700683594 | | | | | |
] | 内存占用charts用 | | | | |
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 | 否 | [ | | |
1741, | | | | | |
7052, | | | | | |
1848, | | | | | |
2021 | | | | | |
] | 网络发送数据charts用,2个用一个图 | | | | |
network_useage_netrecv | Array | 否 | [ | | |
1154, | | | | | |
5545, | | | | | |
1249, | | | | | |
1489 | | | | | |
] | 网络接收数据charts用,2个用一个图 | | | | |
time | Array | 否 | [1605175400,1605175450,1605175500] | ["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"] | |
process_status | Object | 否 | | 进程的返回信息 | |
iawork | String | 否 | ok | | |
iaback | String | 否 | ignore | | |
iarelay | String | 否 | bad | | |
iatrack | String | 否 | bad | | |
iaconsume | String | | bad | | |
修改节点
SDK方法名:modifyNode
URL
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
node_name | String | 否 | @name | 节点名 | |
address | String | 否 | 192.168.12.199 | 数据库ip | |
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 | 否 | 31424826-A97D-4085-81AE-FD64EC58B6CE1 | 节点uuid | |
registered | Number | 否 | 1 | | |
comment | String | 否 | string | 备注 | |
web_uuid | String | 否 | @guid | | |
port | Object | 否 | | 端口 | |
iarelay | String | 否 | 26806 | | |
iamask | String | 否 | 26808 | | |
iasync | String | | 26803 | | |
maintenance | Number | | 0 | 维护模式 | |
node_type | String | | 1111010000 | | |
phy_type | String | | 2 | 物理机类型 vm:2 | |
os_type | String | | 0 | 操作系统类型 linux:0 window:1 (未激活节点会提供此数据) | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | 否 | 200 | | |
msg | String | 否 | | | |
data | Object | 否 | | | |
code | Number | 否 | 0 | | |
message | String | 否 | 操作成功 | | |
uuid | String | | @uuid | | |
删除节点
SDK方法名:deleteNode
URL
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
uuids | Array | 否 | ["@guid","@guid"] | | |
force | Number | | 0 | | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
uuids | Array | | ["@guid"] | | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | | 200 | | |
msg | String | | | | |
data | Object | | | | |
code | Number | | 0 | | |
message | String | | 操作成功 | | |
维护模式切换
SDK方法名:switchMaintenance
URL
//active/node/maintenance
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
uuid | String | | bBae9dCA-f6cc-BA66-bF59-8DFc395eD094 | | |
switch | Number | | 0 | 维护模式0关,1开 | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | | 200 | | |
msg | String | | | | |
data | Object | | | | |
code | Number | | 0 | | |
message | String | | 操作成功 | | |
--------数据库节点------
URL
Method
Request
Response
数据库健康信息
SDK方法名:describeDbHealthInfo
URL
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
uuid | String | 否 | @guid | 数据库节点uuid | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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 | 否 | Date_Time Headroom 2019/05/16 17:14:14 11671.695902 | headroom 值 | |
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
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
page | Number | 否 | 1 | | |
limit | Number | 否 | 10 | | |
search_field | String | 否 | db_name | 用于搜索的键 db_name: 库节点名称 ip:数据库ip, server_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规则 |
---|
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 | | 172.20.5.26 | 节点ip | |
username | String | | admin | 用户名 | |
user_uuid | String | | 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC | 用户uuid | |
db_uuid | String | | 0792EC0B-B84A-FA60-1ED5-B33B0B1591F8 | 数据库节点uuid | |
db_name | String | | 123123123 | 数据库名称 | |
node_uuid | String | | B1A3F55A-027E-4B49-A4FA-D9ED9807ACBF | 节点uuid | |
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
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
db_name | String | 否 | @name | 数据库名 | |
node_uuid | String | 否 | 778553A7-9A06-4F05-AB40-8BD59F353D62 | 节点uuid | |
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 | 否 | 6C4AEF37-6496-6DCD-E085-DD640001E4EC | 数据库uuid | |
node_type | String | | 1110001000 | | |
db_mode | String | | normal | | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | 否 | 200 | | |
msg | String | 否 | | | |
data | Object | 否 | | | |
code | Number | 否 | 0 | | |
message | String | 否 | connect success | | |
数据库状态
SDK方法名:listDbStatus
URL
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
uuids | Array | 否 | @guid | | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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 | ONLINE, OFFLINE | |
version | String | 否 | 7.2.0.32522 | | |
uuid | String | | @guid | | |
新建数据库节点
SDK方法名:createDb
URL
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
db_uuid | String | 否 | @guid | 数据库节点的uuid,为空的话,则表明是创建,不为空则为修改 | |
db_name | String | 否 | @name | | |
node_uuid | String | 否 | @guid | | |
db_type | String | 否 | oracle | 数据库类型: oracle kafka mysql postgres vertica greenplum | |
file_open_type | String | 否 | 0 | normal:普通方式,DIRECT:DIRECT | |
deploy_mode | String | 否 | 0 | oracle:部署方式:single:单机 cluster:集群 | |
log_read_type | String | 否 | file | | |
config | Object | 否 | | | |
username | String | 否 | @name | oracle | |
password | String | 否 | | oracle | |
server_name | String | 否 | | oracle | |
port | Number | 否 | 1 | oracle | |
relay | Object | 否 | | oracle | |
enable | Number | 否 | 1 | 是否有中继节点 | |
relay_node_uuid | String | 否 | | 中继节点uuid | |
log_read | Object | 否 | | oracle | |
os_auth | Number | 否 | 1 | asm|asm_device: 是否os认证 1:认证 0:不认证 | |
asm_instance | String | 否 | | asm|asm_device: asm 实例 | |
asm_username | String | 否 | | asm|asm_device: ASM用户名 | |
asm_port | Number | 否 | 1 | asm|asm_device: asm 端口号 | |
asm_password | String | 否 | 12323131 | | |
filter_session | Number | 否 | 1 | 1:过滤 0:不过滤 | |
remote_file_agent | Object | 否 | | oracle:远程文件代理 | |
enable | Number | 否 | 1 | 是否启用 | |
port | Number | 否 | 1 | 端口 | |
compress | String | 否 | no | 压缩类型:no(不压缩) lzo,zip | |
db_list | Array | 否 | | oracle | |
ip | String | 否 | | | |
thread | String | 否 | | | |
disable | Number | 否 | 0 | | 0-1 |
producer_host | String | 否 | @ip | kafka: Producer 主机 | |
producer_port | Number | 否 | 1 | kafka: Producer 端口 | |
broker_server | Array | 否 | | kafka | qianbase | |
port | Number | 否 | 1 | | |
ip | String | 否 | @ip | 端口 | |
authentication | String | 否 | none | kafka: none,Kerberos,username 认证方式 | |
principal | String | 否 | | kafka | |
keytabfile | String | 否 | | kafka | |
kafka_auth_type | String | 否 | | none sasl_gssapi sasl_plain(用户名和密码) sasl_authentication(sasl 认证) | |
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_managment | Array | | | 用户管理(数据库goldendb,hana) | |
user | String | | | | |
passwd | String | | | | |
default_db | String | | | 默认数据库 | |
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 | | | | |
db_mode | String | 否 | | normal,cdb,pdb | |
cdb | String | 否 | @guid | | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
db_name | String | 否 | @name | 数据库名 | |
db_uuid | String | 否 | A0A0526D-6503-5C2A-E3D8-7D85813967F1 | 数据库uuid | |
db_type | String | 否 | oracle | 数据库类型 | |
node_uuid | String | 否 | 0596a77C-64Fd-cAf2-DB9c-cAaeBD56eD88 | 机器节点uuid | |
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 | | | 连接池最大连接数 | |
cdb | String | | @guid | | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | 否 | 200 | | |
msg | String | 否 | | | |
data | Object | 否 | | | |
code | Number | 否 | 0 | | |
message | String | 否 | operate success | | |
uuid | String | | @uuid | | |
表空间查询接口
SDK方法名:describeDbSpace
URL
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
uuid | String | 否 | A0A0526D-6503-5C2A-E3D8-7D85813967F1 | | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | 否 | 200 | | |
msg | String | 否 | | | |
data | Object | 否 | | | |
code | Number | 否 | 0 | | |
message | String | 否 | operate success | | |
删除数据库
SDK方法名:deleteDb
URL
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
uuids | Array | 否 | ["A0A0526D-6503-5C2A-E3D8-7D85813967F1"] | | |
force | Number | | 0 | 0不强制 1强制删除 | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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
Method
Request
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | 否 | 200 | | |
msg | String | 否 | | | |
data | Object | 否 | | | |
code | Number | 否 | 0 | | |
message | String | 否 | [0]操作成功。 | | |
获取单个数据库节点信息
SDK方法名:describeDb
URL
//active/db/:uuid([A-F0-9-]+)
Method
Request
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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方法名:checkDbLink
URL
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
uuid | String | | 6C4AEF37-6496-6DCD-E085-DD640001E4EC | 机器节点uuid | |
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 | | ["0","1"] | 只有在elasticsearch,oceanbase类型时传值,其余类型不传这个参数 elasticsearch 0对应HTTP,1对应HTTPS oceanbase 0对应Oracle,1对应MySQL | +1 |
sniff | Number | | ["0","1"] | 只有在elasticsearch类型时传值,其余类型不传这个参数 0对应否,1对应是 | +1 |
jsonver | Object | | | | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | | 200 | | |
msg | String | | | | |
data | Object | | | | 2 |
message | String | | | | |
code | Number | | 0 | | |
result | Array | | | | |
state | Number | | 0 | | |
id | String | | 0 | | |
重新生成
重新生成日志文件
URL
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
uuid | String | | | 33333-xxxxx-222222 | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
ret | Number | | 200 | | |
msg | String | | | | |
data | Object | | | | |
code | Number | | 0 | | |
message | String | | operate success | | |
刷新
URL
Method
Request
名称 | 类型 | 必选 | 初始值 | 简介 | Mock规则 |
---|
uuid | String | | xxxxxxxxx | 日志规则的uuid | |
Response
名称 | 类型 | 必选 | 初始值 | 简介 | 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 | | |