Restrpc_server
November 18, 2022About 4 min
Restrpc_server
SDK类名：/common/RestrpcServer;
获取规则和任务
节点或i2node服务重启后获取规则和任务
SDK方法名：listRestRpcTasks;
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， | |||
| node_uuid | String | 节点、集群uuid； npsvr_uuid（当调用get_vp_ffo_时） | |||
| node_role | String | workstation, backup | |||
| node_type | String | node, cluster | |||
| cc_uuid | String | 控制机uuid |
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 | +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 |
底层推送日志接口，日志、状态等
底层主动推送的信息接收器，信息主要包含状态，日志等
SDK方法名：addRestRpcLog;
URL
/api/client/rest_rpc/log
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| method | String | collect_log, collect_statistics, collect_rman, collect_traffic, monitor, task_result, | |||
| cc_uuid | String | ||||
| node_uuid | String | ||||
| content | String | 与原有信息一致 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | Array |
上报结果
处理底层上报的结果
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 |
获取控制机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 |
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] 操作成功 |
云主机 - 创建结果
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方法名：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 | 控制机地址 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success |