统一监控平台

SDK类名：/upmonitor/UpMonitor;

1. 产品名称：英方统一监控管理平台
2. 总控制机：监控管理平台
3. 子控制机：数据管理平台

--总览---

URL

Method

GET

Request

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

Response

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

Dashborad-虚拟化概览

SDK方法名：upMonitorVpRuleStat;

URL

/up_monitor/vp_overall

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
up_uuids	String		不传返回全部

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] success
vp_stat	Object
code	Number			0
message	String			[0] success
vm_total	Number			2576
vm_protected	Number			41
all_total_num	Number			1232
all_trans_data_num	String			44.93 TB
all_success_num	Number			1179
all_failed_num	Number			48
all_cancel_num	Number			3
all_skip_num	Number			2
all_unread_err_num	Number			38
total_num	Number			1100
trans_data_num	String			16.86 TB
success_num	Number			517
failed_num	Number			33
cancel_num	Number			0
skip_num	Number			0
unread_err_num	Number			33
trans_data_num_raw	Number			18536649359811
all_trans_data_num_raw	Number			49397221345194
vp_platforms	Array				10
vp_uuid	Array			["5A4A299D-E53A-4EEC-9C9A-B9464E463BA3","AF322833-503B-4947-A362-5DA6D5A15153","1CA9B94C-451D-4A64-B2E6-EF9A7C8662B5","86D2C9E2-B914-4E0F-BC96-F9F30CDF772D","2E7BF5E1-BB68-4A9B-AB04-46EC8F51216D","9EC8751D-1E38-4A41-B5E5-1DCD8ADD5837","3F96BCDD-53E9-498C-8C38-D0A71DCCE1F6","225BE131-33A2-4D5E-955B-27DA985DB61D","EF6B45F3-7EFC-4718-842E-1E072C084A22","535FEAA4-3F4D-4B20-9022-A0BA90D72BA3"]	+1
vp_name	Array			["web-esxi","myOwn","编译VC","61.5","cas","76.118","77.108","Hyper-v","50.255-vc","79.81-vc"]	+1
vm_total	Number			58	+1
vm_protected	Number			0	+1
rule_stat	Object
VP_BK	Object
week	Array				7
success_num	Number			0
failed_num	Number			0
cancel_num	Number			0
skip_num	Number			0
total_num	Number			0
trans_data_num	String			0 Bytes
unread_err_num	Number			0
time	Array			["05-24","05-25","05-26","05-27","05-28","05-29","05-30"]	+1
trans_data_num_raw	Number			0
month	Array				30
success_num	Number			0
failed_num	Number			0
cancel_num	Number			0
skip_num	Number			0
total_num	Number			0
trans_data_num	String			0 Bytes
unread_err_num	Number			0
time	Array			["05-01","05-02","05-03","05-04","05-05","05-06","05-07","05-08","05-09","05-10","05-11","05-12","05-13","05-14","05-15","05-16","05-17","05-18","05-19","05-20","05-21","05-22","05-23","05-24","05-25","05-26","05-27","05-28","05-29","05-30"]	+1
trans_data_num_raw	Number			0
year	Array				12
success_num	Number			0
failed_num	Number			0
cancel_num	Number			0
skip_num	Number			0
total_num	Number			0
trans_data_num	String			0 Bytes
unread_err_num	Number			0
time	Array			["2023-06","2023-07","2023-08","2023-09","2023-10","2023-11","2023-12","2024-01","2024-02","2024-03","2024-04","2024-05"]	+1
trans_data_num_raw	Number			0

Dashboard-总览（系统概览）

SDK方法名：upMonitorOverall

URL

/up_monitor/overall

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
up_uuids	Array		平台接入 uuid 不传统计所有

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] 操作成功。
up	Object
ONLINE	Number			3
OFFLINE	Number			0
status_overall	Object
code	Number			1010001144
message	String			[0] 操作成功。
info_list	Object
code	Number			0
message	String			[0] 操作成功。
sys_uptime	Object
time_start	Number			4948473.523569338
time_now	Number			3434110813
db_node_status	Object
online	Number			0
warn	Number			0
abnormal	Number			0
unknown	Number			0
maintain	Number			0
node_status	Object		节点状态
online	Number			34
maintain	Number			0
excpt	Number			19
unknown	Number			0
real_time_rule_status	Array		实时复制		5
name	Array			["replication","maintain","mirror","stop","unknown"]	+1
sum	Number			5	+1
description	Object
rep	Number		复制规则	5	+1
db_rule_status	Array				6
name	Array			["dump","track","stop","unknown","error","maintenance"]	+1
sum	Number			0
description	Object
oracle	Number			0
mysql	Number			0
kafka	Number			0
tidb	Number			0
sqlserver	Number			0
postgresql	Number			0
db2	Number			0
qianbase	Number			0
oceanbase	Number			0
dm	Number			0
informix	Number			0
mongodb	Number			0
redis	Number			0
mask	Number			0
offline	Number			0
ha_rule_status	Array				6
name	Array			["run","maintain","switch","warn","stop","unknown"]	+1
sum	Number			2	+1
description	Object
ha	Number			2	+1
copy_management_status	Array				6
name	Array			["wait","maintain","replication","finish","stop","unknown"]	+1
sum	Number			9	+1
description	Object
compl_rep	Number			8	+1
snapshot_task	Number			1	+1
scheduled_rule_status	Array		定时		7
name	Array			["backing_up","replication","maintain","wait","finish","stop","unknown"]	+1
sum	Number			2	+1
description	Object
backup	Number		定时备份（应用保护）	0	+1
ffo	Number		整机备份	0	+1
cloud_backup	Number			0
vp_backup	Number		虚机备份	2	+1
vp_rep	Number			0	+1
vp_move	Number			0	+1
scheduled_rule_state	Object
success	Object
1	Number			636
2	Number			626
3	Number			580
4	Number			477
5	Number			478
6	Number			652
7	Number			268
EXCEPTION	Number			436
fail	Object
1	Number			2
2	Number			1
3	Number			3
4	Number			2
5	Number			3
6	Number			3
7	Number			1
EXCEPTION	Number			1
jump	Object
1	Number			0
2	Number			0
3	Number			0
4	Number			0
5	Number			0
6	Number			0
EXCEPTION	Number			4
cancel	Object
1	Number			0
2	Number			0
3	Number			0
4	Number			0
5	Number			0
6	Number			0
EXCEPTION	Number			3
time	Array			["05-30","05-29","05-28","05-27","05-26","05-25","05-24"]
schedule_server_status	Object
nodes	Array
status	String			OFFLINE
ip	String
running_time	Null
pid	Null
mem_used	Null
process_name	Null
overall_resource	Object
code	Number			0
message	String			[0] 操作成功。
info_list	Object
node	Object
total	Number			53
online	Number			34
maintain	Number			0
offline	Number			19
windows	Number			19
linux	Number			34
db	Object
total	Number			0
online	Number			0
warn	Number			0
abnormal	Number			0
unknown	Number			0
oracle	Number			0
mysql	Number			0
sqlserver	Number			0
kafka	Number			0
maintain	Number			0
vir_plat	Object		虚拟平台
total	Number			11
online	Number			11
maintain	Number			0
offline	Number			0
hyperv	Number			1
vmware	Number			8
drp	Number			1
cas	Number			1
fusion	Number			0
scp	Number			0
winstack	Number			0
aio	Number			0
cloud_plat	Object		云平台
total	Number			0
online	Number			0
maintain	Number			0
offline	Number			0
huawei	Number			0
openstack	Number			0
hwcstack	Number			0
ecloud	Number			0
hcso	Number			0
cluster	Object
total	Number			1
online	Number			1
maintain	Number			0
mscluster	Number			0
rac	Number			1
vcs	Number			0
dto_host	Object
total	Number			4
online	Number			3
maintain	Number			0
offline	Number			1
windows	Number			1
linux	Number			3
storage_pool	Object
total	Number			6
online	Number			6
offline	Number			0
copy_volume	Object
total	Number			3
online	Number			0
mounted	Number			0
abnormal	Number			0
offline	Number			3
dedupe_pool	Object
total	Number			0
online	Number			0
offline	Number			0
active_node	Object
idle	Number			0
approaching_end_licenses	Array		临近过期的许可		2
username	String			admin
user_uuid	String			1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
sn	Array			["20-5610719102914267880-0010","20-5625569828966500053-0019"]	+1
lic_uuid	Array			["CBC1DA53-2985-4874-8297-6D45EB6E05B3","6DF16179-C843-40A3-AC72-0094F7DB9870"]	+1
create_time	Number			1710835894	+1
inst_date	Number			1745078400	+1
group_sn	Array			["20-5610719102914267880","20-5625569828966500053"]	+1
notify_stage	Null
last_alert	Null
type	String			2
ctrl_type	String			STD
state	String			1
show_label	Array			["正式版Backup9","1"]	+1
hardware	Array			["1568CA8A211A4EB6AFC5BB80522F79023E7B76E0945FEC986BC702777694241CA8ED723FF7D11C568F88DAA59A70F77C;191D0A000F13E3369BC971B6D762F20292DC5EDD64D9C52167C14841102B2FA97A92925ED4627AB8FB05CACD242BB4BA","8E8A701C43A6F4B8E38196BE99756002A067D1B40CED4065401A8F02D3BCF1E239A41AABE59B6A03E504FEFF786BX202"]	+1
company	String			I2SOFT
expire	Array			["2025-04-20","2025-05-30"]	+1
act_period	Array			["2024-05-03","2024-06-13"]	+1
feature	Array			["active","container_cls"]	+1
db_num	Array			["3",null]	+1
mysql_num	Array			["4",null]	+1
db_num_used	Array			[0,null]	+1
postgresql_num_used	Array			[0,null]	+1
kafka_num_used	Array			[0,null]	+1
mysql_num_used	Array			[0,null]	+1
dm_num_used	Array			[0,null]	+1
gaussdb_num_used	Array			[0,null]	+1
hive_num_used	Array			[0,null]	+1
hbase_num_used	Array			[0,null]	+1
kudu_num_used	Array			[0,null]	+1
hana_num_used	Array			[0,null]	+1
sqlserver_num_used	Array			[0,null]	+1
db2_num_used	Array			[0,null]	+1
oceanbase_num_used	Array			[0,null]	+1
goldendb_num_used	Array			[0,null]	+1
qianbase_num_used	Array			[0,null]	+1
tidb_num_used	Array			[0,null]	+1
tdsql_num_used	Array			[0,null]	+1
hotdb_num_used	Array			[0,null]	+1
mongodb_num_used	Array			[0,null]	+1
informix_num_used	Array			[0,null]	+1
xtpdb_num_used	Array			[0,null]	+1
teradata_num_used	Array			[0,null]	+1
antdb_num_used	Array			[0,null]	+1
mdb_num_used	Array			[0,null]	+1
elasticsearch_num_used	Array			[0,null]	+1
redis_num_used	Array			[0,null]	+1
hudi_num_used	Array			[0,null]	+1
hdfs_num_used	Array			[0,null]	+1
starrocks_num_used	Array			[0,null]	+1
sundb_num_used	Array			[0,null]	+1
argodb_num_used	Array			[0,null]	+1
sequoiadb_num_used	Array			[0,null]	+1
mogdb_num_used	Array			[0,null]	+1
lightdb_num_used	Array			[0,null]	+1
gbase_num_used	Array			[0,null]	+1
vertica_num_used	Array			[0,null]	+1
clickhouse_num_used	Array			[0,null]	+1
kingbase_num_used	Array			[0,null]	+1
vastbase_num_used	Array			[0,null]	+1
shentong_num_used	Array			[0,null]	+1
phy_num_used	Number			0
vm_num_used	Array			[0,null]	+1
up_uuid	Array			["470AF1C2-A1BB-44EB-B2B6-5B65B048B308","8B7A0192-8ACD-4E3E-86B3-0410BBC29C86"]	+1
phy_num	String			100
storage_pool_stat	Object		存储池统计
num	Number			6
used	Number			13733922232832
free	Number			10945508103680
size	Number			24801288650752
up_event_stat	Object		事件记录
latest_day	Object
success	Number		成功	357
cancel	Number		取消	0
skip	Number		跳过	0
fail	Number		失败	3
latest_week	Object
success	Number			10842
cancel	Number			0
skip	Number			0
fail	Number			42
latest_month	Object		最近一个月
success	Number			64341
cancel	Number			9
skip	Number			0
fail	Number			1128

---- 平台监控 ----

URL

Method

GET

Request

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

Response

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

平台监控-概览概要

SDK方法名：listUpMonitorPlatSummary;

URL

/up_monitor/plat_summary

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
filter_by_biz_grp	Number		【可选】1：开启分组过滤模式：其效果为将where_args 内所有以 _uuid 结尾的 key 的元素 value 当作 业务组的 grp_uuid，并替换 value 为业务组中成员uuid列表；此字段只在部分模块生效，详细列表见【业务分组】模块；	1
where_args[up_uuid]	String
search_field	String		up_name 根据名称查询
search_value	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] success
info_list	Array
up_name	String		平台名称	plat1
node	Object		节点状态
ONLINE	Number		在线	98
OFFLINE	Number		离线	2
rule	Object		规则状态
RUN	Number		允许	98
STOP	Number		停止	2
EXCPT	Number		异常	4
statistics	Object		任务执行
day	Object		近一天
success	Number		成功	99
failed	Number		失败	10
week	Object		近一周
success	Number		成功	99
failed	Number		失败	10
month	Object		近一月
success	Number		成功	99
failed	Number		失败	10
storage_usage	Object		存储使用
used	Number		已用容量	12324344545
free	Number		可用容量	12324344545
warn	Object		告警信息
day	Number		近一天	18
week	Number		近一周	18
month	Number		近一月	18
expiration_date	String		许可到期时间	2024-03-19

平台监控 - 事件记录

SDK方法名：listStatistics

参数可能更新不及时，有差异时，以统计报表下的事件统计为准：https://apiref.info2soft.com/repository/editor?id=18&mod=211&itf=208

URL

/up_monitor/statistics

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
up_uuids	Array	否	不传返回全部平台
page	Number	否	默认为1, 符合条件范围的当前页数	1
name	String	否	搜索过滤字段, 名称
limit	Number	否	默认为系统参数设置数量, 每页数量	10
start	Number	否	时间戳，非必填, 查询开始时间
end	Number	否	时间戳，非必填, 查询结束时间
status	String	否	可选，用是否已读过滤，0：未读；1：已读；
type	String	否	OVERVIEW - 概览, bak_bk - 应用保护-备份, bak_rc - 应用保护-恢复, cmp_all - 比较任务与同步, ffo - 整机保护, sys_cdm - 整机CDM, rule - 文件复制, vp - 虚拟化管理, ha - 应用高可用, sys_cloud - 云容灾, bb - 大数据备份, dto - DTO管理, cdm_remote_rep - 远程复制, timing_work - 定时任务， vm_clone - 虚机克隆（备份中心）， bak_bk9 - 备份规则（9.x）， bak_rc9 - 恢复任务（9.x）,
sub_type	Number	否	bak_bk - 应用保护-备份, bak_rc - 应用保护-还原, cmp_all - 比较任务与同步, ffo - 整机保护, sys_cdm - 整机CDM, rule - 文件复制, vp - 虚拟化支持, sys_cloud - 云容灾, bb - 大数据备份, DB2 - 应用保护-DB2备份, MSSQL - 应用保护-MSSQL备份, MySQL - 应用保护-MySQL备份, GaussDB - 应用保护-Gauss DB备份, GaussDB100T - 应用保护-Gauss DB100T备份, Informix - 应用保护-Informix备份, DM 应用保护-DM备份, block - 应用保护-块备份, file - 应用保护-文件备份, Oracle - 应用保护-Oracle备份, GoldenDB - 应用保护-GoldenDB备份, AIX - 应用保护-AIX备份, cmp - 比较与同步-文件比较与同步, cmp_nas - 比较与同步-NAS比较与同步, ffo_bk - 整机保护-整机备份, ffo_rc - 整机保护-整机恢复, ffo_or - 整机保护-整机迁移, sys_cdm_bk - 整机CDM-整机复制, sys_cdm_rc - 整机CDM-整机恢复, cdm_or - CDM-自动演练, cdm_take_over - CDM-接管, cdm_drill - CDM-演练, cdm_ffo_mount CDM-挂接任务, cdm_remote_rep CDM-远程复制, rule_rc - 文件复制-恢复, rule_rep - 文件复制-复制, vp_bk - 虚拟化支持-虚机备份, vp_mv - 虚拟化支持-虚机迁移, vp_rc - 虚拟化支持-虚机恢复, vp_pt - 虚拟化支持-虚机复制, vp_or - 虚拟化支持-虚机演练, ha - 应用高可用, ha_switch - 应用高可用-高可用, sys_cloud_bk - 云容灾-整机复制, bb_bk - 大数据备份-备份, bb_rc - 大数据备份-恢复, dto - DTO管理, dto_bk - DTO管理-本地到对象存储, dto_rc - DTO管理-对象存储到本地, dto_cmp - DTO管理-文件比较与同步, zfs_pool - 存储池, zfs_volume - 复制卷或副本卷, zfs_filesystem - 文件类型, zfs_obj - 仅复制所选对象, 其他： timing_work：（所有定时作业任务） tape_arch：磁带归档任务； tape_rc：磁带到本地（磁带恢复）； tape_cp：磁带到磁带（磁带复制）； sys_cdm_bk：整机复制： sys_cdm_rc：整机恢复； cdm_or：自动演练； cdm_take_over：接管； cdm_drill；演练； cdm_ffo_mount：挂接任务； sys_bk：整机副本；（备份中心） rec_cp：应用容灾；（备份中心） rec_or：容灾演练；（备份中心） rec_failover：容灾接管；（备份中心） rec_failback：容灾回切；（备份中心） fir_copy：一级副本；（备份中心） sec_copy：二级副本；（备份中心） vp_failover（备份中心 - 接管） vp_faileback（备份中心 - 回切） ffo_failover（备份中心 - 接管） ffo_failback（备份中心 - 回切） mach_clone（备份中心 - 虚机克隆） bak_bk9 - 备份规则（9.x）， bak_rc9 - 恢复任务（9.x）, GaussDB HCS（9.x）,
duration_operator	String		>, =, <, >=, <=
duration	Number		耗时 单位 hour
uuid	String	否	可选，用任务uuid过滤
group_uuid	String	否	可选，用任务组uuid过滤，比如 vp nas 等有 group_uuid 的模块
wk_uuid	String	否	工作机uuid、源平台uuid，查看平台未读错误数时用此字段过滤
bk_uuid	String	否	备机uuid
other_uuid	String	否	同步机uuid、目标平台uuid
result	Number	否	可选，用任务结果过滤： 0：成功； 1：取消； 2：跳过； 3：备份失败
time_used_rate	Number	否	执行时间过滤 0:不到50% 1:超过50% 2:超过100%
obj_name	String	否	可选，根据节点或虚机名称获取统计时才传
time_consuming	Number	否	0关1开，传1，返回当前条件查询出来的任务的总耗时时间 time_consuming
sys_name	String		应用系统名称
protect_name	String		受保护对象名称

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	是		200
msg	String	是
data	Object	是
code	Number	是		0
message	String	是
list	Array	是			9
id	String	是		6
name	Array	是	名称	['FFO_RC','FFO_BK','BAK_RC','MIRROR','CMP','NAS_CMP', 'CDP_RC', 'COOPY_RC', 'COOPY_SNAP_RC']	+1
uuid	String	是	相关规则任务的UUID	4E2609C0-71DA-F693-43A4-EB92C4C42C95
detail	String	是	原始jSON串，含义参考： 事件记录 - 详情	{ "bkup_window": "00:00-00:00", "create_time": "2019-12-11 20:04:11", "data_writed_num": "762", "dir_failed_num": "--", "dup_rate": "00.00%", "end_time": "2019-12-11 20:04:11", "file_skiped_num": 0, "name": "1", "policy": 3, "project_failed_num": "", "result": 0, "space_occu": "12288", "src_size": "0", "src_type": "MySQL", "stage": 0, "start_time": "2019-12-11 20:04:10", "sync_obj_num": 0, "time_used_rate": "", "tran_rate": "802.00", "trans_data_num": "802", "type": "I2BAK_BK", "used_time": "1", "uuid": "4E2609C0-71DA-F693-43A4-EB92C4C42C95", "timing_type": 0, "version_time": "", "cdm_rc_target": "" }
result	String	是	运行结果	0
start_time	String	是	开始时间	2019-12-11 20:04:10
end_time	String	是	结束时间	2019-12-11 20:04:11
type	Array	是	类型： VP_BK - 虚机备份, VP_RC - 虚机恢复, VP_MV - 虚机迁移, VP_PT - 虚机复制, VP_OR - 虚机演练, BAK_BK - 定时备份, BAK_RC - 定时还原, BB_BK - 大数据备份, BB_RC - 大数据恢复, FFO_BK - 整机备份, FFO_RC - 整机恢复, FFO_OR - 整机迁移, SYS_CLOUD_BK - 整机复制, SYS_CDM_BK - 整机复制, SYS_CDM_RC - 整机恢复, CDM_OR - 自动演练, CDM_TAKE_OVER - 接管, CDM_DRILL - 演练, CDM_FFO_MOUNT - 挂接, CDM_REMOTE_REP - 远程复制, MIRROR - 文件复制, CDP_RC - CDP恢复, COOPY_RC - 即时恢复, COOPY_SNAP_RC - 快照恢复, CMP - 比较与同步, NAS_CMP - NAS比较与同步, HA_SWITCH - 高可用, DTO_BK - 本地到对象存储, DTO_RC - 对象存储到本地, DTO_CMP - 文件比较与同步, TAPE_ARCH - 磁带归档, TAPE_RC - 磁带到本地, TAPE_CP - 磁带到磁带, BAK_BK9 - 备份规则, BAK_RC9 - 恢复任务,	['FFO_RC','FFO_BK','BAK_RC','MIRROR','CMP','NAS_CMP', 'CDP_RC', 'COOPY_RC', 'COOPY_SNAP_RC','HA_SWITCH','SYS_CLOUD_BK']	+1
status	String	是	0 - 成功 非零 - 失败	0
create_time	String	是	创建时间	1576066341
time_used_rate	String	是	备份时间占用率	0
user_uuid	String	是	用户UUID	1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
wk_uuid	String	是	工作机UUID
bk_uuid	String	是	灾备机UUID
other_uuid	String	是	其他UUID
time_consuming	Number	否	单位秒，返回当前条件查询出来的任务的总耗时时间，只有入参有 time_consuming=1，才会返回这个字段
sys_name	String	否	应用系统名称
protect_name	String	否	受保护对象名称（工作机名称、源虚机vm_name）
wk_name	String	是	工作机名称
bk_name	String	是	灾备机名称
storage	String	否	存储
host_name	String		（恢复规则）目标客户端：<客户端名称>/<恢复时的hostname>
bk_set_info	String		（恢复规则）恢复涉及的备份集：<备份集ID1_copyid>, <备份集ID2_copyid>
rule_version	String		规则版本
up_uuid	String		平台uuid
up_name	String		平台名称
total	Number	是		5

平台监控 - 事件记录下载

SDK方法名：downloadStatistics;

URL

/up_monitor/statistics/download

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
page	Number	否	默认为1, 符合条件范围的当前页数	1
name	String	否	搜索过滤字段, 名称
limit	Number	否	默认为系统参数设置数量, 每页数量	10
start	Number	否	时间戳，非必填, 查询开始时间
end	Number	否	时间戳，非必填, 查询结束时间
status	String	否	可选，用是否已读过滤，0：未读；1：已读；
type	String	否	可选，总的未读数量框子点进去就传数组，用任务类型过滤， 'I2BAK_BK'：定时备份， 'I2BAK_RC'：定时备份-还原， 'I2VP_BK'： 备份规则， 'I2VP_RC'：恢复规则， 'I2VP_MV'：迁移规则， 'I2VP_PT'：复制规则， 'I2VP_OR'：虚机演练规则， 'I2FFO_BK'：全服备份， 'I2VP'：虚机相关所有记录， 'I2TAPE_ARCH'：磁带归档； 'I2TAPE_RC'：磁带到本地（磁带恢复）； 'I2TAPE_CP'：磁带到磁带（磁带复制）；
src_type	Number	否	源类型，VP不用传这个
uuid	String	否	可选，用任务uuid过滤
group_uuid	String	否	可选，用任务组uuid过滤，比如 vp nas 等有 group_uuid 的模块
wk_uuid	String	否	工作机uuid、源平台uuid，查看平台未读错误数时用此字段过滤
bk_uuid	String	否	备机uuid
other_uuid	String	否	同步机uuid、目标平台uuid
result	Number	否	可选，用任务结果过滤，0：成功；1：备份取消；2：跳过；3：备份失败
statistics_start	Number	否	报表生成时间
statistics_end	Number	否	报表生成时间
obj_name	String	否	可选，根据节点或虚机名称获取统计时才传
time_consuming	Number	否	0关1开，传1，返回当前条件查询出来的任务的总耗时时间 time_consuming
suffix	String		后缀名	.csv

Response

名称	类型	必选	简介	Mock初始值	Mock规则
time_consuming	Number	否	单位秒，返回当前条件查询出来的任务的总耗时时间，只有入参有 time_consuming=1，才会返回这个字段	1319083
list	Array	否			2
total	Number	否		2
code	Number	否		0
message	String	否
result	Array	否	运行结果	['SUCCEED','FAILED']	+1
detail	Array	否		['{"bkup_window":"00:00-00:00","create_time":"2018-06-05 18:09:28","data_writed_num":"3.88KB","dir_failed_num":"Not_Valid","dup_rate":"00.00%","end_time":"2018-06-05 18:09:28","file_skiped_num":0,"name":"YXNkZmFzZGY=","policy":3,"project_failed_num":"Not_Valid","result":"SUCCEED","space_occu":"20.00KB","src_size":"110.00bytes","src_type":0,"stage":0,"start_time":"2018-06-05 18:09:27","sync_obj_num":5,"trans_data_num":"4.04KB","type":"I2BAK_BK","uuid":"546EA90D-B4BC-5523-3840-1F24C69BEA78"}','{"bkup_window":"00:00-00:00","create_time":"2018-06-05 18:09:35","data_writed_num":"3.88KB","dir_failed_num":"Not_Valid","dup_rate":"00.00%","end_time":"2018-06-05 18:09:35","file_skiped_num":0,"name":"YXNkZmFzZGY=","policy":3,"project_failed_num":"Not_Valid","result":"SUCCEED","space_occu":"20.00KB","src_size":"110.00bytes","src_type":0,"stage":0,"start_time":"2018-06-05 18:09:35","sync_obj_num":5,"trans_data_num":"4.04KB","type":"I2BAK_BK","uuid":"546EA90D-B4BC-5523-3840-1F24C69BEA78"}']	+1
start_time	Array	否	开始时间	['2018-06-05 18:09:27','2018-06-05 18:09:35']	+1
id	Array	否		['1','2']	+1
end_time	Array	否	结束时间	['2018-06-05 18:09:28','2018-06-05 18:09:35']	+1
uuid	Array	否	相关规则任务的UUID	['546EA90D-B4BC-5523-3840-1F24C69BEA78','546EA90D-B4BC-5523-3840-1F24C69BEA78']	+1
name	Array	否	名称	['YXNkZmFzZGY=','YXNkZmFzZGY=']	+1
msg	String	否
ret	Number	否		200
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功
download_url	String	否		E:\ctrlcenter\wwwroot\default\public\download\xxx.zip
file_name	String	否		xxx.zip

平台监控 - 规则监控

SDK方法名：listUpMonitorRules;

URL

/up_monitor/rules

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
type	Number		0- 文件复制 1- 应用备份 2- 整机备份 3- 虚机备份
search_field	String		name 名称 wk_node_name-工作节点名称 bk_node_name-备份节点名称 vm_name-虚机名称 vp_name-虚拟平台
search_value	String
up_uuid	String		平台uuid

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number			200
msg	String
data	Object
code	Number			0
message	String			[0] success
info_list	Array
rule_name	String		名称
vp_name	String		虚拟平台
vm_name	String		虚机名称
status	String		状态
wk_data_type	String		源类型
wk_node_name	String		工作机
bk_node_name	String		灾备机
last_result	String		上次执行
last_success_result	String		上次成功执行
latency	String		复制延迟
username	String		所有者

平台监控-操作日志

SDK方法名：listOpLog;

URL

/up_monitor/op_log

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
up_uuds	Array	否	平台uuid，不传即不过滤平台
page	Number	是		1
limit	Number	是		10
start	Number	否	unix时间戳，可选，不传就是全部	1546272000
end	Number	否	unix时间戳，可选，不传就是全部，Eg: 1508833953	1548950400
op_type	String		操作（事件）类型	delete_nodes
level	Number		日志级别： 所有：0； 信息：1; 错误：2； 关键：3; 警告：4；	0
description	String		关键字	delete_nodes
address	String		操作ip（模糊搜索）	''
username	String		操作者	''
download	Boolean		导出时传 true
suffix	String		导出后缀.log, .et, .csv	.txt

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否	@mock=200	200
msg	String	否	@mock=
data	Object	否
code	Number	否	@mock=0	0
message	String	否	@mock=[0] success	[0] success
total	Number	否	@mock=29	29
count	Number	否	@mock=2	2
info_list	Array	否			2
up_uuid	String	是	对应up uuid
user_name	Array	否	@mock=$order('admin','admin'), 操作者用户名	['admin','admin']	+1
description	Array	否	@mock=$order('edit_node{"name":"666","uuid":"99113A1F-9162-61E4-B4FB-AFA54845A27F"}','create_node{"name":"666"}'), 详情	['edit_node{"name":"666","uuid":"99113A1F-9162-61E4-B4FB-AFA54845A27F"}','create_node{"name":"666"}']	+1
op_time	Array	否	@mock=$order('1508984237','1508992987'), 操作时间	['1508984237','1508992987']	+1
type	Array	否	@mock=$order('0','0'), 默认0	['0','0']	+1
end_time	Array	否	@mock=$order('1508984237','1508992987'), 结束时间	['1508984237','1508992987']	+1
result	Array	否	@mock=$order('10011112','10011120'), 结果码，0是成功	['10011112','10011120']	+1
id	Array	否	@mock=$order('603','612'), 主键	['603','612']	+1
address	Array	否	@mock=$order('192.168.74.25','192.168.74.25'), 操作者所在ip	['192.168.74.25','192.168.74.25']	+1
start_time	Array	否	@mock=$order('1508984232','1508992986'), 开始时间	['1508984232','1508992986']	+1
user_uuid	Array	否	@mock=$order('1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC','1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC'), 操作者用户名uuid	['1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC','1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC']	+1
failure_reason	Array	否	@mock=$order('[10011112] node.not_connected','[10011120] node.group_id_invalid'), 失败原因	['[10011112] node.not_connected','[10011120] node.group_id_invalid']	+1
op_type	String		操作（事件）类型	delete_nodes
level	Number		日志级别： 所有：0； 信息：1; 错误：2； 关键：3; 警告：4；	0
service	String		模块名称	Node
original_description	String		原始描述，导出再导入时需要用到
original_failure_reason	String		原始的failure_reason

平台监控 - 用户信息

SDK方法名：listUser

URL

/up_monitor/user

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
limit	Number	是		10
page	Number	是		1
up_uuids	Array		不传即过滤全部
like_args[username]	String		模糊查询 用户
like_args[email]	String		模糊查询 邮箱，但做了脱敏处理 意义不大
like_args[mobile]	String		模糊查询 手机，但做了脱敏处理 意义不大

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否
info_list	Array	否			5
id	String	否		2
up_uuid	String	是	平台uuid
user_uuid	String	否		1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC
username	String	否		admin
email	String	否
mobile	String	否
active	String	否		1
first_name	String	否		Admin
last_name	String	否		default
address	String	否
comment	String	否
company	String	否
create_time	String	否		1539835353
builtin	String	否		1
roles	Array	否
id	String	否		3
user_id	String	否		2
role_id	String	否		3
name	String	否		admin
is_system	String	否		1
allow_new_user	String	否		1
display_name	String	否	名称，多个角色，建议逗号拼接或者tag展示	Business Administrator
description	String	否		Admin User
dynamic_perms	String	否		0
total	Number	否		5
track_login_attempts	Boolean		是否限制登录失败次数	false

平台监控 - 用户导出

SDK方法名：exportUsers;

正常情况下响应二进制流，当出错时返回code结果；

统计导出时（for_import入参为0），每一行内容与列表页面显示内容相同；

导入导出时（for_import入参为1），每一行内容为一个规则的全量信息（不支持修改）；

URL

/up_monitor/user/export

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
suffix	String	是	csv, xlsx	csv
sub_type	String		文件复制： 普通复制规则：0； 集群复制规则：1； ASM复制规则：2； 文件恢复： 即时恢复：0； cdp恢复：1； 快照恢复：2； 整机保护、CDM（备份）： 整机备份：3； CDM复制：8； 业务迁移：1； 整机保护、CDM（恢复）： 整机恢复：不传，默认为整机恢复； CDM恢复：9； dto对象存储：0； dto比较同步：2； // 以下为资源 b	0
uuids	Array		选中的uuid，默认为[]导出所有	[]
where_args	Object
timing_type	String		普通定时任务：0； 集群定时任务：1；
raw_uuid	String		比较与同步主任务uuid
for_import	Number		0：统计导出；（默认值） 1：全字段导出（为了导入的）	0

Response

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

--- 平台接入 ---

URL

Method

GET

Request

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

Response

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

子平台 - 认证

SDK方法名：authUpMonitor

URL

/up_monitor/auth

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
ip	String	否	子平台接口ip	172.20.2.70
port	String	否	子平台接口port	58086
access_key	String	否	能绑定子平台用户的一个密钥	oishvmn5YPHJcEDaIjtwd0R9Ug7BN1fk
secret_key	String	否	签名key，RSA加密	fkLiyqsG3P1AzB5jWtYbZa7TU8RN9wSVhe6EldOo

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] success
up_uuid	String	否	子平台cc_uuid

子平台 - 获取子平台token

SDK方法名：describeUpMonitorToken

URL

/up_monitor/token

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
up_uuid	String	否	uuid	CE753C48-96F9-6C38-C3DE-A25E7405D03F

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否
token	String	否		aa95663edea9f799049a50d706250767a0a5d06b
sso_token	String	否		c145aa4873972b19gWmhnGvfGbprR3xF1j1NJoDHKCFrYyMuzuE2vH8QMvIRa4kivVvNjbyEYtBUfBs0zdAKaJSAP6Mf8YJa8cbFA5L0NJcO45O51kbdBuVhImL_PLBPg9myD9TEvHNdCIQEtG1LSTjbktW_hngowTei7w
refresh_token	String	否		5f77393082397d90v5z_Qp7ArjrZCA_E6mrZnHNaQay3-TWnNyEsd1o41jDbxYEp45EPkrp_OlivpeoHYqiihmLjuGvk9CPk3sZRyU7_kj5AAsVu199paV-yWi8k-Q6qoMK7lU9i_VRh5Zxl6lB45eTESnXWeGBjMDWxnw

子平台 - 新建

SDK方法名：createUpMonitor

URL

/up_monitor

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
up_name	String	否	名称	就这个控制机
up_uuid	String	否	子平台cc_uuid	CE753C48-96F9-6C38-C3DE-A25E7405D03F
ip	String	否	子平台接口ip	172.20.2.70
port	String	否	子平台接口port	58086
access_key	String	否	能绑定子平台用户的一个密钥	oishvmn5YPHJcEDaIjtwd0R9Ug7BN1fk
secret_key	String	否	签名key，RSA加密	fkLiyqsG3P1AzB5jWtYbZa7TU8RN9wSVhe6EldOo
comment	String	否	备注	备注xxx
biz_grp_list	Array	否	业务分组

Response

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

子平台 - 修改

SDK方法名：modifyUpMonitor

URL

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

Method

PUT

Request

名称	类型	必选	简介	Mock初始值	Mock规则
up_name	String	否		就这个控制机
access_key	String	否		oishvmn5YPHJcEDaIjtwd0R9Ug7BN1fk
secret_key	String	否		fkLiyqsG3P1AzB5jWtYbZa7TU8RN9wSVhe6EldOo
ip	String	否		172.20.2.70
port	String	否		58086
comment	String	否		备注xxx
biz_grp_list	Array	否
random_str	String	否		11111111-1111-1111-1111-111111111111

Response

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

子平台 - 获取列表

SDK方法名：listUpMonitor

URL

/up_monitor

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
limit	Number	否	可选，不传就是全部	10
page	Number	否	可选，不传就是全部	1
filter_by_biz_grp	Number		【可选】1：开启分组过滤模式：其效果为将where_args 内所有以 _uuid 结尾的 key 的元素 value 当作 业务组的 grp_uuid，并替换 value 为业务组中成员uuid列表；此字段只在部分模块生效，详细列表见【业务分组】模块；	1
where_args[up_uuid]	String
search_field	String		up_name 根据名称查询
search_value	String

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功。
info_list	Array	否
username	String	否		admin
up_name	String	否		就这个控制机
up_uuid	String	否		CE753C48-96F9-6C38-C3DE-A25E7405D03F
ip	String	否		192.168.72.70
port	String	否		58086
comment	String	否		备注xxx
update_time	Number	否		1553849308
status	String	否		ONLINE
dashboard	Object	否
overall	Object	否
code	Number	否		0
message	String	否		[0] success
node_num	Number	否		21
rep_num	Number	否		12
ha_num	Number	否		2
node	Object	否
UNKNOWN	Number	否		17
OFFLINE	Number	否		0
ONLINE	Number	否		4
rep	Object	否
UNKNOWN	Number	否		4
FINISH	Number	否		0
STOP	Number	否		3
REPLICATION	Number	否		4
MIRROR	Number	否		0
EXCEPTION	Number	否		0
STALE	Number	否		1
SWITCH	Number	否		0
WAIT	Number	否		0
EXECUTING	Number	否		0
IDLE	Number	否		0
DEAD	Number	否		0
ha	Object	否
master_status	Object	否
HA_UNKNOWN	Number	否		0
HA_STOP	Number	否		0
HA_START	Number	否		0
HA_RUN	Number	否		2
HA_MIRROR	Number	否		0
HA_READY	Number	否		0
HA_WARN	Number	否		0
HA_FAIL	Number	否		0
master_role	Object	否
HA_UNKNOWN	Number	否		0
HA_UNJOIN	Number	否		0
HA_MASTER	Number	否		2
HA_SLAVE	Number	否		0
HA_PREOVER	Number	否		0
HA_POSTOVER	Number	否		0
HA_PREBACK	Number	否		0
HA_POSTBACK	Number	否		0
HA_SWITCH	Number	否		0
vp_vm	Object	否
code	Number	否		0
message	String	否		[0] success
vm_protected	Number	否		0
vm_total	Number	否		0
vp_rule	Object	否
code	Number	否		0
message	String	否		[0] success
all_total_num	Number	否		167
all_trans_data_num	String	否		45.31 GB
all_success_num	Number	否		32
all_unread_err_num	Number	否		135
total_num	Number	否		94
trans_data_num	String	否		35.76 GB
success_num	Number	否		25
unread_err_num	Number	否		69
total	Number	否		1

子平台 - 获取单个

SDK方法名：describeUpMonitor

URL

/up_monitor/: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
up_monitor	Object	否
up_name	String	否		test
up_uuid	String	否		93AF0C9F-14C8-41A2-31CB-AAA0F65193FA
up_type	Number	否		0
ip	String	否		192.168.72.70
port	String	否		58086
access_key	String	否	假值	123123
secret_key	String	否	假值	123123
comment	String	否		test
biz_grp_list	Array	否		['93AF0C9F-14C8-41A2-31CB-AAA0F65193FA']
random_str	String	否		93AF0C9F-14C8-41A2-31CB-AAA0F65193FA
create_time	Number	否		0
update_time	Number	否		0
user_uuid	String	否
username	String	否
status	String	否	ONLINE / OFFLINE
node_info	Object	否
drivers_info	Object	否	内容为 监控 - 磁盘信息 的data（URL为/monitor/drivers_info/:uuid）
phy_info	Object	否	内容为 监控 - 当前硬件信息 的data（URL为/monitor/phy_info/:uuid）
chart_data	Object	否	内容为 监控 - 图表数据 的data（URL为/monitor/chart_data/:uuid）
dashboard	Object	否
overall	Object	否	内容为 Dashboard 接口返回的data（URL为 /dashboard/overall）
vp_vm	Object	否	内容为 Dashboard 接口返回的data（URL为 /dashboard/vp_vm）除了info_list图表数据
vp_rule	Object	否	内容为 Dashboard 接口返回的data（URL为 /dashboard/vp_rule）除了info_list图表数据

子平台 - 操作

SDK方法名：refreshUpMonitor

URL

/up_monitor/operate

Method

POST

Request

名称	类型	必选	简介	Mock初始值	Mock规则
up_uuids	Array	否		["CE753C48-96F9-6C38-C3DE-A25E7405D03F"]
operate	String	否	refresh	refresh

Response

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

子平台 - 状态

SDK方法名：listUpMonitorStatus；

URL

/up_monitor/status

Method

GET

Request

名称	类型	必选	简介	Mock初始值	Mock规则
up_uuids	Array	否		["CE753C48-96F9-6C38-C3DE-A25E7405D03F"]

Response

名称	类型	必选	简介	Mock初始值	Mock规则
ret	Number	否		200
msg	String	否
data	Object	否
code	Number	否		0
message	String	否		[0] 操作成功
status	Array	否
up_uuid	String	否		9c420cF9-8EA2-2b5F-cDB4-A5680bC3E9D2
status	String	否		ONLINE
node_info	Object	否	和获取单个/列表的一样
dashboard	Object	否	和获取单个/列表的一样
update_time	Number	否

子平台 - 删除

SDK方法名：deleteUpMonitor；

URL

/up_monitor

Method

DELETE

Request

名称	类型	必选	简介	Mock初始值	Mock规则
up_uuids	Array	否		["CE753C48-96F9-6C38-C3DE-A25E7405D03F"]

Response

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