底层Client调用接口
February 26, 2024About 24 min
底层Client调用接口
SDK类名：/common/Client;
获取配置信息
节点或i2node服务重启后获取节点规则和任务等配置信息
URL
/api/client/configurations
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| method | String | 是 | 方法名如下： get_rules, get_fsp_tasks, get_tasks, get_ffo_backup_task, get_vp_ffo, get_ha_rules, get_ha_by_uuid, get_pool_rules, get_pool_by_uuid, get_cmp_task, get_nas_rule, get_mount_task(挂载任务), get_snapshot_task(存储CDM-快照任务) reload_cloudbackup_tasks(工作机sdatad重启后重新下发云备份规则)； get_remote_rep：远程复制； get_ffo_task；（获取整机备份、整机迁移，文件类型 - 从get_rules当中拆分出来的） get_nodes；（获取节点） get_tapes：获取磁带库； get_backup_sets 获取备份集 get_storage_unit： 获取存储单元； get_retention_polices：获取全局保留期限设置 get_backup_rules：获取新备份规则； get_recovery_rules：获取新恢复任务； get_replica_task: 获取备份集复制策略 get_jobs：获取任务监控； get_tape_media: 获取磁带介质； get_bk_set_discovery_rules（获取备份集发现规则） get_import_backup_sets（获取待导入的备份集） get_vpmanagers: 获取vpmanager(管理服务器) get_vp_backup_rules：获取虚机备份规则； get_vp_recovery_rules：获取虚机恢复规则； | ||
| node_uuid | String | 节点、集群uuid； npsvr_uuid（当调用get_vp_ffo_和get_vpmanagers时） replica_task_uuid(当调用get_replica_task获取单个策略时) | |||
| node_role | String | workstation（默认值）, backup | |||
| node_type | String | node（默认值）, cluster | |||
| cc_uuid | String | 否 | 控制机uuid | ||
| page | Number | 页数 | 1 | ||
| limit | Number | 每页条数 | 10 | ||
| backup_set_type | Number | （get_backup_set）查询条件 类型 0（默认）: 过期备份集； 1：（备份时）查询某个备份规则的最后一次备份集（增量或全量） 2：（恢复时）查询某个备份规则的到恢复点之前的备份集（全量+增量+差异） 3：（恢复时）条件查询获取单个备份集 4：获取备份集下一个copy_id 5：获取已删除备份集， 6，（Oracle恢复时）查询某个备份计划的备份集（全量+增量+差异） 7：获取备份规则状态不属于无效或者过期备份集（过期时间的判断根据下面bk_expire_tm_before和bk_expire_tm_after组合判断） 8：查询符合 wk_uuid、 src_instance的 , 小于等于bk_start_tm的, 备份内容为content_type且备份集类型为全量的所有Oracle备份链 9：获取失效备份集 | |||
| bk_start_tm | Number | （备份集查询条件）备份开始时间包含此时间戳或者更早 | |||
| bk_rule_uuid | String | （备份集查询条件）备份计划规则uuid | |||
| bk_set_id | String | （备份集查询条件）备份集id | |||
| copy_id | Number | （备份集查询条件）副本id | |||
| wk_uuid | String | （备份集查询条件）客户端uuid | |||
| bk_type | String | （备份集查询条件）备份类型 | |||
| storage_unit_uuid | String | （备份集查询条件）存储单元uuid | |||
| bk_search_start_tm | Number | 备份集查询条件=6 oracle还原检索的开始时间 （ 整库/PDBs/CDB$ROOT） | unit时间戳 | ||
| bk_search_end_tm | Number | 备份集查询条件=6 oracle还原检索的结束时间 | unit时间戳 | ||
| src_instance | String | 备份集查询条件=6 oracle数据库实例名 用于多规则恢复 | 数据库实例名 | ||
| slot_barcode | String | 【可选】获取磁带介质或根据磁带过滤备份集时可传 磁带条形码 | |||
| bk_expire_tm_before | Number | 备份集查询条件=7 备份集过期时间需要大于此时间戳 | |||
| bk_expire_tm_after | Number | 备份集查询条件=7 备份集过期时间需要小于此时间戳 | |||
| exclude_bk_type | Number | 需要过滤的备份类型 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success | |||
| total | Number | 总条数 | |||
| info_list | Array | 2 | |||
| task_uuid | Array | ["8F00633E-41B7-DE58-8C7F-ED18000A2C5B","C223AC6F-A333-5BEA-C8FA-33C1E1A12D9F"] | +1 | ||
| task_name | Array | ["dGVzdA==","dGVzdDI="] | +1 | ||
| user_uuid | String | 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC | |||
| status | Number | 1 | +1 | ||
| compress | Number | 0 | |||
| secret_key | String | ||||
| wk_ip | String | 192.168.7.250 | |||
| bk_ip | String | 192.168.7.250 | |||
| encrypt | Number | 0 | |||
| rep_dir | Array | ["Szpc","SzpcdGltaW5nLXRlc3Rc"] | +1 | ||
| one_time | Array | ["2020_08_21_15_32_27","2022_08_26_00_00_00"] | +1 | ||
| backup_policy | Number | 2 | +1 | ||
| policies | String | 0 | |||
| bkup_window | String | 00:00,23:59 | |||
| snapshot_limit | Number | 2 | |||
| timeout | Number | 0 | |||
| src_type | Number | 1 | |||
| dst_type | Number | 1 | |||
| task_type | Number | 0 | |||
| task_port | String | 26832 | |||
| wk_uuid | String | 65E3E4A5-D089-8B6A-25F3-096F6997E3F0 | |||
| bk_uuid | String | 65E3E4A5-D089-8B6A-25F3-096F6997E3F0 | |||
| rep_path | String | SzpcaTIuY3J0 | |||
| del_policy | Number | 0 | |||
| snap_type | Number | 0 | |||
| file_check_dir | String | ||||
| file_check_open | Number | 0 | |||
| open_type | Number | 0 | |||
| syncattr | Number | 1 | |||
| sync_flag | Number | 0 | |||
| blk_size | Number | 32768 | |||
| bkupMode | Number | 0 | |||
| rep_uuid | Null | ||||
| rc_point | Null | ||||
| blk_recovery_style | Number | 0 | |||
| rawfile | String | ||||
| info_list(get_nodes/get_vpmanager) | Array | ||||
| node_uuid | String | 节点uuid vpmanager uuid | |||
| node_name | String | 节点名称(base64) | |||
| node_type | String | 0：普通节点 2：rac集群节点 3：大数据备机 4：vpmanager节点 | |||
| proxy_switch | Number | 代理开关: 0：关； 1：开； | |||
| config_addr | String | 管理地址 vpmanager ip | |||
| config_port | String | 否 | 管理端口 vpmanager port | ||
| data_addr | String | 数据地址 | |||
| cc_ip | String | 控制机ip | |||
| mem_limit | Number | 内存使用上限 | |||
| 10240 | Number | 磁盘使用上限 | |||
| disk_free_space_limit | Number | 磁盘剩余空间阈值 | |||
| log_dir | String | 日志目录 | |||
| keep_log_days | Number | 日志保留时长（天） | |||
| rep_path | String | 复制目录（base64） | |||
| cache_dir | String | 缓存路径（base64） | |||
| user_uuid | String | 用户uuid | |||
| cc_type | String | 控制机类型： STD | |||
| security_check | Number | 安全检查开关： 0：关； 1：开 | |||
| maintenance | Number | 维护模式开关 | |||
| monitor_switch | Number | 监控开关： 0：关； 1：开 | |||
| os_user | String | 验证用户（base64） vpmanager user | |||
| os_passwd | String | 加密后的密码 vpmanager password | |||
| ctrl_access_key | String | 节点ak | |||
| ctrl_secret_key | String | 节点sk（AES） | |||
| cc_address | String | 控制机地址 | |||
| alarm_switch | Number | 告警开关 | |||
| cpu_threshold | Number | cpu使用率阈值 | |||
| memory_threshold | Number | 内存使用率阈值 | |||
| monitor_process | Array | 监控进程 | [ "sdatad", "srepd" ] | ||
| snmp_switch | Number | snmp开关 | |||
| im_enable | Number | 备端安全开关 | |||
| im_passwd | String | 备端安全卸载密码 | |||
| config | String | 节点配置加密串 | |||
| info_list(get_backup_sets) | Array | 具体格式参见 底层定义的备份集格式： https://apiref.info2soft.com/organization/repository/editor?id=21&mod=461&itf=5494 | |||
| xxx | Object | ||||
| info_list(get_retention_polices) | Array | ||||
| level | Number | 保留期限等级（0~99） | |||
| type | String | 策略/单位： day：天； week：周； month：月； year：年； unlimited：永久保留； now：立即过期； | |||
| value | Number | 数值 | |||
| info_list(get_storage_unit) | Array | ||||
| fragment_size | Number | 0 | |||
| storage_path | String | /testunit/ | |||
| auto_expand | Number | 0 | |||
| rootfs | Number | 1 | |||
| storage_unit_name | String | test2 | |||
| storage_unit_uuid | String | 2590566F-7F55-42D1-9F0A-968294234B3D | |||
| storage_unit_type | String | DISK | |||
| backup_node_uuid | String | FFDF4562-C690-467B-803E-1DFCF1222417 | |||
| storage_pool | String | ||||
| storage_vol | String | ||||
| hight_peak_level | Number | 90 | |||
| low_peak_level | Number | 75 | |||
| max_thread_num | Number | 10 | |||
| info_list(get_tapes) | Array | ||||
| node_uuid | String | 节点uuid | |||
| config_addr | String | 管理地址 | |||
| library_uuid | String | 磁带库uuid | |||
| library_name | String | 磁带库name | |||
| library_info | Array | 磁带列表 | |||
| library_sn | String | 序列号 | |||
| library_vendor | String | 厂商 | |||
| library_product | String | 型号 | |||
| library_revision | String | 版本 | |||
| drive_num | String | 驱动器数 | |||
| slot_num | String | 槽数 | |||
| info_list(get_replica_task) | Array | 参考rpc链接：https://apiref.info2soft.com/organization/repository/editor?id=21&mod=461&itf=5599 | |||
| info_list(get_tape_media) | Array | 参考链接：https://apiref.info2soft.com/organization/repository/editor?id=34&mod=486&itf=5742 |
往控制台推送记录信息
注意： http rest
底层主动推送的变化信息接口
URL
/api/client/records
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| method | String | 是 | task_result （暂未实现） upload_backup_sets 上传备份集 | ||
| cc_uuid | String | 是 | |||
| content | String | 是 | 与原有信息一致 具体参数根据method不同有不同的定义 已经存在的都是做了base64encode （可以找个时间点把所有method的base64去掉） | ||
| node_uuid | String | 节点uuid | |||
| content（upload_backup_sets） | Object | 上传备份集时格式， content（upload_backup_sets）需要替换成content | |||
| backup_sets | Array | sets数据中单个对象定义参考底层自己定义的格式： https://apiref.info2soft.com/organization/repository/editor?id=21&mod=461&itf=5494 | |||
| xxx | Object |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | Array |
获取节点、规则和任务
节点或i2node服务重启后获取规则和任务
新接口：https://apiref.info2soft.com/repository/editor?id=18&mod=160&itf=5510
URL
/api/client/rest_rpc/task_list
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| method | String | 方法名如下： get_rules, get_fsp_tasks, get_tasks, get_ffo_backup_task, get_vp_ffo, get_ha_rules, get_ha_by_uuid, get_pool_rules, get_pool_by_uuid, get_cmp_task, get_nas_rule, get_mount_task(挂载任务), get_snapshot_task(存储CDM-快照任务) reload_cloudbackup_tasks(工作机sdatad重启后重新下发云备份规则)； get_remote_rep：远程复制； get_ffo_task；（获取整机备份、整机迁移，文件类型 - 从get_rules当中拆分出来的） get_nodes；（获取节点） get_dedupe_storages（重删池）； get_fingerprint_domains（获取指纹域）； | |||
| node_uuid | String | 节点、集群uuid； npsvr_uuid（当调用get_vp_ffo_时） | |||
| node_role | String | workstation（默认值）, backup | |||
| node_type | String | node（默认值）, cluster | |||
| cc_uuid | String | 控制机uuid | |||
| page | Number | 页数 | 1 | ||
| limit | Number | 每页条数 | 10 | ||
| filters | Array | 需要增加参数过滤的（参数不统一，每种方法各自设置） | |||
| from | Number | get_jobs过滤时间，unix timestamp。 不传，默认为系统设置的监控保留天数，未设置默认7天 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success | |||
| info_list | Array | 2 | |||
| task_uuid | Array | ["8F00633E-41B7-DE58-8C7F-ED18000A2C5B","C223AC6F-A333-5BEA-C8FA-33C1E1A12D9F"] | +1 | ||
| task_name | Array | ["dGVzdA==","dGVzdDI="] | +1 | ||
| user_uuid | String | 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC | |||
| status | Number | -1：未知； 0：完成； 1：停止； | 1 | +1 | |
| compress | Number | 0 | |||
| secret_key | String | ||||
| wk_ip | String | 192.168.7.250 | |||
| bk_ip | String | 192.168.7.250 | |||
| encrypt | Number | 0 | |||
| rep_dir | Array | ["Szpc","SzpcdGltaW5nLXRlc3Rc"] | +1 | ||
| one_time | Array | ["2020_08_21_15_32_27","2022_08_26_00_00_00"] | +1 | ||
| backup_policy | Number | 2 | +1 | ||
| policies | String | 0 | |||
| bkup_window | String | 00:00,23:59 | |||
| snapshot_limit | Number | 2 | |||
| timeout | Number | 0 | |||
| src_type | Number | 1 | |||
| dst_type | Number | 1 | |||
| task_type | Number | 0 | |||
| task_port | String | 26832 | |||
| wk_uuid | String | 65E3E4A5-D089-8B6A-25F3-096F6997E3F0 | |||
| bk_uuid | String | 65E3E4A5-D089-8B6A-25F3-096F6997E3F0 | |||
| rep_path | String | SzpcaTIuY3J0 | |||
| del_policy | Number | 0 | |||
| snap_type | Number | 0 | |||
| file_check_dir | String | ||||
| file_check_open | Number | 0 | |||
| open_type | Number | 0 | |||
| syncattr | Number | 1 | |||
| sync_flag | Number | 0 | |||
| blk_size | Number | 32768 | |||
| bkupMode | Number | 0 | |||
| rep_uuid | Null | ||||
| rc_point | Null | ||||
| blk_recovery_style | Number | 0 | |||
| rawfile | String | ||||
| info_list(get_nodes) | Array | ||||
| node_uuid | String | 节点uuid | |||
| node_name | String | 节点名称(base64) | |||
| proxy_switch | Number | 代理开关: 0：关； 1：开； | |||
| config_addr | String | 管理地址 | |||
| data_addr | String | 数据地址 | |||
| cc_ip | String | 控制机ip | |||
| mem_limit | Number | 内存使用上限 | |||
| 10240 | Number | 磁盘使用上限 | |||
| disk_free_space_limit | Number | 磁盘剩余空间阈值 | |||
| log_dir | String | 日志目录 | |||
| keep_log_days | Number | 日志保留时长（天） | |||
| rep_path | String | 复制目录（base64） | |||
| cache_dir | String | 缓存路径（base64） | |||
| user_uuid | String | 用户uuid | |||
| cc_type | String | 控制机类型： STD | |||
| security_check | Number | 安全检查开关： 0：关； 1：开 | |||
| maintenance | Number | 维护模式开关 | |||
| monitor_switch | Number | 监控开关： 0：关； 1：开 | |||
| os_user | String | 验证用户（base64） | |||
| ctrl_access_key | String | 节点ak | |||
| ctrl_secret_key | String | 节点sk（AES） | |||
| cc_address | String | 控制机地址 | |||
| alarm_switch | Number | 告警开关 | |||
| cpu_threshold | Number | cpu使用率阈值 | |||
| memory_threshold | Number | 内存使用率阈值 | |||
| monitor_process | Array | 监控进程 | [ "sdatad", "srepd" ] | ||
| snmp_switch | Number | snmp开关 | |||
| im_enable | Number | 备端安全开关 | |||
| im_passwd | String | 备端安全卸载密码 | |||
| config | String | 节点配置加密串 | |||
| total | Number | 总条数 |
获取控制机IP或节点代理开关
获取控制机ip或节点代理开关
SDK方法名：listRestRpcCcip;
URL
/api/client/rest_rpc/cc_ip
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| method | String | 方法名： get_ccip, get_node_mode | |||
| uuid | String | 当method为'get_node_mode'时必传，表示节点uuid | |||
| cc_uuid | String | 控制机uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success | |||
| cc_ip | String | get_ccip | 192.168.7.250 | ||
| ips | Array | get_ccip | ["192.168.7.250","172.16.75.1","172.16.174.1"] | ||
| proxy_switch | Number | get_node_mode | 0 |
推送信息，日志、状态等
注意： 已经切换为Websocket协议；参数定义未变（和http rest接口一致）
底层主动推送的信息接收器，信息主要包含状态，日志，流量等等
URL
/wss://ip:port/ws/?token=xxxx
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| 0 | String | 调用的方法method： collect_log, collect_statistics, collect_rman, collect_traffic, monitor, task_result | |||
| 1 | String | cc_uuid | |||
| 2 | Object | 与原有信息一致（base64） | |||
| node | String | ||||
| rep | Array | ||||
| ha | Array | ||||
| backup_sets | Array | collect_traffic方法备份集状态上传 | |||
| 参考备份集状态上报 | String | https://apiref.info2soft.com/repository/editor?id=21&mod=463&itf=5619 | |||
| task_jobs | Array | 上传规则任务列表 参考任务格式：https://apiref.info2soft.com/organization/repository/editor?id=21&mod=461&itf=5622 | |||
| 参考“数据格式定义 - 任务信息” | String | ||||
| 3 | String | node_uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | Array |
推送信息，日志、状态等（rest_rpc方式）
注意： 已经切换为Websocket协议；参数定义未变（和http rest接口一致）
底层主动推送的信息接收器，信息主要包含状态，日志，流量等等
URL
/api/client/rest_rpc/log
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| method | String | collect_log, collect_statistics, collect_rman, collect_traffic, monitor, task_result, upload_backup_sets | |||
| cc_uuid | String | ||||
| content | Object | 与原有信息一致（base64） | |||
| node | String | ||||
| rep | Array | ||||
| ha | Array | ||||
| backup_sets | Array | collect_traffic方法备份集状态上传 | |||
| 参考备份集状态上报 | String | https://apiref.info2soft.com/repository/editor?id=21&mod=463&itf=5619 | |||
| task_jobs | Array | 上传规则任务列表 参考任务格式：https://apiref.info2soft.com/organization/repository/editor?id=21&mod=461&itf=5622 | |||
| 参考“数据格式定义 - 任务信息” | String | ||||
| node_uuid | String |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | Array |
磁带信息更新
SDK方法名：updateTapeMedia;
URL
/api/client/rest_rpc/tape_media
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| slot_barcode | String | 是 | |||
| slot_flag | String | 是 | |||
| pool_name | String | 是 | |||
| last_write | String | ||||
| move_times | Number | ||||
| slot_expiretime | String | ||||
| slot_index | Number | ||||
| slot_mtype | String | ||||
| slot_tapename | String | ||||
| slot_tapesequence | String | ||||
| status | Number | ||||
| write_protected | Number |
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方法名：registerNodeFromNode;
URL
/api/client/rest_rpc/node
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| node_name | String | 节点名称 | |||
| os_type | Number | 节点系统类型： 0-LINUX 1-WINDOWS | |||
| os_user | String | 节点用户名 | |||
| i2id | String | 节点认证码，即客户端ID | |||
| config_addr | String | 节点管理地址 | |||
| root | String | 节点安装根目录 | |||
| mem_limit | String | 内存使用上限 | |||
| disk_limit | String | 磁盘使用上限 | |||
| disk_free_space_limit | String | 磁盘剩余空间阈值 | |||
| cc_ip | String | 控制机地址 | |||
| log_path | String | 日志目录 | |||
| cache_path | String | 数据缓存目录 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success |
同步修改从类型节点
SDK方法名：updateSlaveNode;
URL
/api/client/update_slave_node
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| config | String | 否 | aes加密的配置信息 | ||
| cc_uuid | String | 控制机uuid | |||
| aes_key | String | 控制机rsa加密的aes密钥 | |||
| aes_iv | String | 控制机rsa加密的aes偏移量 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | [0] 操作成功。 |
上报结果
底层处理结果上报，如注册安装
SDK方法名：addRestRpcresult;
URL
/api/client/rest_rpc/result
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| type | String | 目前固定result，以后可能加别的功能 | result | ||
| code | Number | 0表示成功 | |||
| ip | String | 节点IP | |||
| cc_uuid | String | 控制机uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success |
备端数据保护日志上传
URL
/api/client/upload_guard_data_log
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| cc_uuid | String | 控制机uuid | |||
| node_uuid | String | 节点uuid | |||
| data | Object | ||||
| records | Array | ||||
| decision | Number | 1：允许； 2：拒绝； | 1 | ||
| subject | String | 操作进程路径 | |||
| read_count | Number | 读次数 | |||
| write_count | Number | 写次数 | |||
| object_count | Number | 被操作数量 | 0 | ||
| object_records | Array | 被操作记录 | |||
| object | String | 被操作文件路径 | |||
| read_count | Number | 读次数 | 0 | ||
| write_count | Number | 写次数 | 0 | ||
| create_time | Number | 创建时间，时间戳 | 0 | ||
| last_time | Number | 上次获取records时间，时间戳 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String |
-----HA----
URL
/-----HA----
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Ha动态节点切换后上报接口
HA 动态节点切换后通知接口
SDK方法名：addRestRpcHa;
URL
/api/client/rest_rpc/ha
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_uuid | String | 高可用规则uuid | |||
| failed_node_uuid | String | 原主节点uuid | |||
| new_node_uuid | String | 新主节点uuid | |||
| cc_uuid | String | 控制机uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功 |
服务器池更新底层传上来的中心节点IP
服务器池更新底层传上来的中心节点IP
SDK方法名：addRestRpcCluster;
URL
/api/client/rest_rpc/cluster
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| cluster_uuid | String | 高可用服务器池uuid | |||
| center_node_ip | String | 新中心节点IP |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功 |
-------比较同步---------
URL
/-------比较同步---------
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
复制/NAS规则，创建比较结果
SDK方法名：createCompareResult;
URL
/api/client/create_compare_result
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| uuid | String | 复制规则/nas规则 的uuid | 65DA3916-AF53-CE70-0B47-A142414AA140 | ||
| result_uuid | String | 比较结果uuid | 25DA3916-AF13-CE70-0B47-B142414AA142 | ||
| result_type | String | 规则类型： rep：文件复制、CFS； nas：NAS同步规则； | rep | ||
| result | Object | 比较结果 | |||
| code | String | 任务执行结果code | 0 | ||
| time | String | 任务时间信息(start_time.'-'.end_time) | 10 | ||
| files | String | 总文件数量 | 100 | ||
| bytes | String | 总文件大小 | 1111111 | ||
| missing | String | 缺失文件数量 | 2 | ||
| diff | String | 不同文件数量 | 48 | ||
| equal | String | 相同文件数量 | 50 | ||
| erro | String | 同步出错文件数量 | |||
| cc_uuid | String | 控制机uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 |
上传比较与同步执行差异详情
SDK方法名：uploadCompareDiffDetail
URL
/api/client/upload_diff_detail
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| files | Array | 否 | 可选，文件列表 | ||
| missing_files | Array | 否 | 可选，缺失文件列表 | ["file"] | 2 |
| diff_files | Array | 否 | 可选，不同文件数列表 | ||
| uuid | String | 否 | 必填，实际执行任务uuid（可能是子任务） | ||
| cc_uuid | String | 控制机uuid | |||
| is_new | Number | 是否新建（清除旧数据）： 0：否； 1：是； | 0 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 |
上传比较与同步任务执行结果
SDK方法名：collectCompareResult；
原来底层是调用的/compare/collect_result，compare控制器接收到以后，再跳转到client，也就是说原来这个接口并没有用到（现在？）
URL
/api/client/collect_compare_result
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| code | String | 否 | 任务执行结果code | ||
| time | String | 否 | 任务起始时间戳：时间-结束时间 | 1632453814-1632453816 | |
| files | String | 否 | 总文件数量 | ||
| bytes | String | 否 | 总文件大小 | ||
| missing | String | 否 | 缺失文件数量 | ||
| diff | String | 否 | 不同文件数量 | ||
| equal | String | 否 | 相同文件数量 | ||
| erro | String | 否 | 同步出错文件数量 | ||
| task_uuid | String | 否 | 比较任务uuid | ||
| cc_uuid | String | 控制机uuid | |||
| send_bytes | String | 已传输数据量 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | |||
| uuid | String | 周期任务，由控制机生成的子任务的uuid |
-----虚拟化------
URL
/-----虚拟化------
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
云主机 - 创建结果
SDK方法名：modifyEcs
URL
/api/client/rest_rpc/cloud_ecs
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| restored_uuid | String | ||||
| ecs_id | String | ||||
| code | Number | 是 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String |
获取所有虚拟平台
SDK方法名：getVirtualPlatforms;
URL
/api/client/get_virtual_platforms
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| npsvr_uuid | String | 是 | npsvr的uuid | ||
| cc_uuid | String | 控制机uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | [0] 操作成功。 | ||
| virtualPlatforms | Array | 否 | 2 | ||
| uuid | String | 否 | 414A7725-50AE-DCED-3F3C-9D8FC06CCB27 |
获取指定虚拟平台上的所有规则
SDK方法名：getVirtualPlatformRules;
URL
/api/client/get_virtual_platform_rules
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| vp_uuids | Array | 否 | 一个或者多个虚拟平台。 | ["3C334EF3"] | 2 |
| config_addr | Array | 控制台地址，用来获取文件恢复规则 | |||
| String | |||||
| cc_uuid | String | 控制机uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | 否 | |||
| code | Number | 否 | 0 | ||
| message | String | 否 | [0] 操作成功。 | ||
| rules | Array | 否 | |||
| uuid | String | 否 | 414A7725-50AE-DCED-3F3C-9D8FC06CCB27 |
获取备份集演练策略（暂时废弃）
SDK方法名：describeVpDrillPolicy;
URL
/api/client/vp_drill_policy
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| node_uuid | String | 传策略的uuid，不传获取所有 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| info_list | Object | 策略列表 | |||
| policy_name | String | 名称 | |||
| vp_uuid | String | 虚拟平台uuid | |||
| bkup_window | Array | 演练时间窗口 | |||
| wday | String | 周几0~6 | 0 | ||
| from | String | 开始时间 | 00:00 | ||
| to | String | 结束时间 | 03:59 | ||
| total | String | 总数量 |
-------dto--------
URL
/-------dto--------
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
获取所有对象存储
SDK方法名：getDtoStorageList;
URL
/api/client/get_dto_storage_list
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| cc_uuid | String | 控制机uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 | |||
| dto_storages | Array | ||||
| id | Number | 数据库唯一主键id | 1 | ||
| sto_uuid | String | 存储uuid | |||
| sto_name | String | 存储名称 | |||
| sto_type | Number | 存储类型 | 0 | ||
| address | String | ||||
| access_key | String | RSA加密 | |||
| secret_key | String | RSA加密 | |||
| part_size | Number | 0 | |||
| comment | String | ||||
| random_str | String | ||||
| user_uuid | String | ||||
| username | String | ||||
| create_time | Number | 0 | |||
| user | String | ||||
| pwd | String | RSA加密 | |||
| remote_path | String |
---active---
URL
/---active---
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
获取数据库同步规则（返回rpc下发的格式）
SDK方法名：getAllActiveRules
URL
/api/client/get_active_rules
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| cc_uuid | String | ||||
| rule_uuids | Array |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
------HDFS------
URL
/------HDFS------
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
HDFS差异比较结果上传
SDK方法名：uploadHdfsCompareResult;
URL
/api/client/upload_hdfs_compare_result
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| policy_uuid | String | 规则uuid | |||
| session_uuid | String | 比较结果uuid（当次历史比较uuid） | |||
| statistical_result | Object | 当次历史比较，汇总结果 | |||
| start_time | String | 开始时间 | |||
| end_time | String | 结束时间 | |||
| comparison_count | String | 总对比数量 | |||
| difference_count | String | 差异数量 | |||
| comparison_results | Array | 当次历史比较结果 | |||
| diff_name | String | 差异名称 | |||
| diff_name_type | String | 类型： FILE：文件； DIRECTORY：目录； NORMAL_TBL：普通标； PART_TBL：分区表； | |||
| result | String | 差异类型： SAME：相同； DIFFERENT：不同； | |||
| existence_state | String | 存在状态： LESS：仅源端存在； ALL_EXIST：均存在； SURPLUS：仅目标端存在； | |||
| comparison_detail_results | Array | 当次历史比较结果详情 | |||
| diff_name | String | 差异名称（唯一项对应comparison_results中） | |||
| comparison_term | String | 对比项 | |||
| source | String | 源端差异信息 | |||
| destination | String | 目标端差异信息 | |||
| cc_uuid | String | 控制机uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 |
------ CFS ------
URL
/------HDFS------
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
CFS - 机头迁移
SDK方法名：cfsNodeMove;
URL
/api/client/cfs_node_move
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| cfs_uuid | String | CFS集群uuid | |||
| fs_id | String | 文件系统id | |||
| src_server_id | String | 源机头id | |||
| dst_server_id | String | 目标机头id |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 |
CFS - 机头迁移前停止规则
SDK方法名：cfsStopRule；
URL
/api/client/cfs_stop_rule
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| cfs_uuid | String | ||||
| fs_id | String | ||||
| src_server_id | String | ||||
| dst_server_id | String |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 |
磁带组名 - 列表
SDK方法名：listSlotTapeName；
URL
/api/client/rest_rpc/slot_tapename
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| data | Object | ||||
| message | String | ||||
| code | Number | 0 | |||
| info_list | Array | ||||
| ret | Number | 200 |