整机备份
August 1, 2024About 9 min
整机备份
SDK类名：/fspBackupRule/fspBackupRule;
整机备份 - 列表
SDK方法名：listFspBackupRule；
URL
/vers/v3/fsp/backup_rule
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| page | Number | 页数 | 1 | ||
| limit | Number | 条数 | 1 | ||
| search_value | String | 模糊查询字段 | test | ||
| search_field | String | 模糊查询值 | rule_name | ||
| order_by | String | 排序方式 | rule_name | ||
| direction | String | 顺序（此处初始值代表：搜索类似规则名：test规则的所有规则并且按照降序排） | DESC | ||
| filter_by_biz_grp | Number | 根据业务组过滤开关：1 | 1 | ||
| where_args[rule_uuid] | String | 根据业务组过滤：业务组UUID | |||
| like_args[unit_name] | String | 模糊搜索：备份目标名称：存储单元（组） | |||
| status | String | 状态过滤： DISABLE：禁用； FINISH：完成； SCHEDULING：调度中； 总览跳转： DASH_DISABLE 禁用 DASH_ENABLE 启用 | |||
| node_name | String | 客户端过滤 | |||
| like_args[rule_name] | String | 模糊搜索：名称 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] success | |||
| info_list | Array | ||||
| rule_name | String | 规则名称 | @first | ||
| rule_uuid | String | 规则uuid | @uuid | ||
| unit_uuid | String | 备份目标uuid，存储单元（组）uuid | |||
| unit_name | String | 备份目标名称，存储单元（组）名称 | unit-@first | ||
| user_uuid | String | 所属用户名 | |||
| user_name | String | 所属用户uuid | user-@first | ||
| rule_type | String | 规则类型 整机 - "fsp" 等产品确定是否需要 | |||
| client_list_info | Array | 客户端详情列表 | |||
| node_uuid | String | 节点uuid | @pick(D1DBbC39-8D72-E671-6F84-7ce7d51bB61e, f2C5B05E-f73c-83bE-4D66-7AB8D9ed7AA9) | ||
| node_name | String | 节点名称 | client-node-@first | ||
| hostname | String | 节点主机名 | host-@first | ||
| can_del | Number | 删除权限 | 1 | ||
| can_up | Number | 更新权限 | 1 | ||
| can_op | Number | 操作权限 | 1 | ||
| is_biz_admin | Number | 是否为业务组管理员 | 1 | ||
| client_list | Array | 客户端列表 - 同新建时下发的 | |||
| node_uuiid | String | 节点uuid | |||
| bkup_schedule | Array | 备份计划列表 | |||
| sched_name | String | 备份计划名称 | |||
| total | Number | 规则总条数 | 24 |
整机备份 - 新建
SDK方法名：createFspBackupRule；
URL
/vers/v3/fsp/backup_rule
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_name | String | 基本参数 - 规则名称 | |||
| rule_type | Number | 基本参数 - 规则类型 0 - block 表示整机块设备 | |||
| biz_grp_list | Array | 基本参数 - 业务组 uuid列表 | |||
| timeout | Number | 基本参数 - 超时阈值（小时） | 1 | ||
| priority | Number | 基本参数 - 优先级：0~99999 | 1 | ||
| disable | Number | 基本参数 - 规则禁用 | 1 | ||
| client_list | Array | 备份源&备份目标 - 客户端列表 | |||
| node_uuid | String | 节点uuid | |||
| unit_uuid | String | 备份源&备份目标 - 备份目标 存储单元(组)uuid | |||
| tape_pool_uuid | String | 备份源&备份目标 - 磁带池uuid | |||
| replica_uuids | Array | 备份源&备份目标 - 备份集复制uuid | |||
| trans_mode | Number | 备份源&备份目标 - 传输链路： 0：仅TCP/IP； 1：仅LANFree； 2：LANFree优先； | 1 | ||
| wk_path | Array | 备份内容&参数 - 块设备列表 | |||
| path | String | PhysicalDrive0\ | |||
| name | String | PhysicalDrive0 | |||
| icon | String | folder | |||
| size | Number | 42949672960 | |||
| file | String | ||||
| attr | Number | 1 | |||
| leaf | String | ||||
| subNodes | Array | ||||
| nodeUuid | String | 0986CDE6-85C6-4D03-8D78-9DD5E367916D | |||
| showSize | String | 40.00 GB | |||
| disabled | String | ||||
| has_policy | String | ||||
| right_path | String | ||||
| is_show | String | ||||
| database_switch | Number | 备份内容&参数 - 启用数据库保护 开关 0-关 1-开 | 1 | ||
| database_type | Number | 备份内容&参数 - 数据库类型 0：oracle； 1：mysql；（预留 不支持） 2：mssql; 3: custom; | 1 | ||
| oracle_dbagent_param | Object | 备份内容&参数 - 数据库保护oracle参数 | |||
| username | String | 用户名 | |||
| password | String | 密码 | |||
| timeout | String | 超时时间 | |||
| port | String | 端口 | |||
| sql_plus_path | String | Oracle执行目录 | |||
| oracle_sid | String | SID | |||
| table_space | String | 表空间 | |||
| sqlserver_dbagent_param | Object | 备份内容&参数 - 数据库保护sqlserver参数 | |||
| timeout | String | 超时时间 | |||
| custom_dbagent_param | Object | 备份内容&参数 - 数据库保护自定义脚本参数 | |||
| pre_snapshot_script | String | 前置脚本 | |||
| post_snapshot_script | String | 后置脚本 | |||
| bkup_schedule | Array | 备份计划 - 执行计划 | |||
| sched_name | String | ||||
| backup_type | Number | 1 | |||
| retention | Number | 1 | |||
| start_window | Array | ||||
| wday | Number | 1 | |||
| from | String | ||||
| to | String | ||||
| bkup_window | Array | ||||
| wday | Number | 1 | |||
| from | String | ||||
| to | String | ||||
| bkup_one_time | Number | 1 | |||
| bkup_policy | Number | 1 | |||
| exclude_days | Array | ["2023-06-02"] | |||
| cron_policies | String | ||||
| effective_time_switch | Number | 备份计划 - 生效时间开关 0-关 1-开 | 1 | ||
| effective_time | Number | 备份计划 - 生效时间 | 1 | ||
| compress | Number | 高级设置 - 传输压缩： 1：极速； 2：普通； 3：快速； 4：均衡； | 1 | ||
| compress_switch | Number | 高级设置 - 传输压缩开关： 0：关； 1：开； | 0 | ||
| encrypt_switch | Number | 高级设置 - 传输加密开关： 0：关； 1：开； | 1 | ||
| encrypt | Number | 高级设置 - 传输加密： 1：AES； 2：SM4； | 1 | ||
| bk_file_crypt | Number | 高级设置 - 备端数据加密开关： 0：关； 1：开； | 1 | ||
| bk_crypt_type | Number | 高级设置 - 备端数据加密类型： 2：AES； 3：SM4； 4：RC5； | 1 | ||
| bk_crypt_key | String | 高级设置 - 备端数据加密秘钥 | |||
| band_width | String | 高级设置 - 带宽设置 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 |
整机备份 - 单个
SDK方法名：describeFspBackupRule；
URL
/vers/v3/fsp/backup_rule/:uuid([A-F0-9]+)
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| fspBackupRule | Object | ||||
| rule_name | String | ||||
| rule_uuid | String | ||||
| group_uuid | String | ||||
| random_str | String | ||||
| create_time | String | ||||
| rule_type | String | ||||
| biz_grp_list | Array | ||||
| timeout | String | ||||
| priority | Number | 1 | |||
| disable | Number | 1 | |||
| client_list | Array | ||||
| node_uuid | String | ||||
| unit_uuid | String | ||||
| tape_pool_uuid | String | ||||
| replica_uuids | Array | ||||
| trans_mode | Number | 1 | |||
| wk_path | Array | ||||
| path | String | PhysicalDrive0 | |||
| name | String | PhysicalDrive0 | |||
| icon | String | folder | |||
| size | Number | 42949672960 | |||
| file | String | ||||
| attr | Number | 1 | |||
| leaf | String | ||||
| subNodes | Array | ||||
| nodeUuid | String | 0986CDE6-85C6-4D03-8D78-9DD5E367916D | |||
| showSize | String | 40.00 GB | |||
| disabled | String | ||||
| has_policy | String | ||||
| right_path | String | ||||
| is_show | String | ||||
| database_switch | Number | 1 | |||
| database_type | Number | 1 | |||
| oracle_dbagent_param | Object | ||||
| oracle_sid | String | ||||
| sql_plus_path | String | ||||
| username | String | ||||
| password | String | ||||
| port | String | ||||
| table_space | String | ||||
| sqlserver_dbagent_param | Object | ||||
| custom_dbagent_param | Object | ||||
| pre_snapshot_script | String | ||||
| post_snapshot_script | String | ||||
| bkup_schedule | Array | ||||
| sched_name | String | ||||
| backup_type | Number | 1 | |||
| retention | Number | 1 | |||
| start_window | Array | ||||
| wday | Number | 1 | |||
| from | String | ||||
| to | String | ||||
| bkup_window | Array | ||||
| bkup_one_time | Number | 1 | |||
| bkup_policy | Number | 1 | |||
| exclude_days | Array | ["2023-06-02"] | |||
| cron_policies | String | ||||
| effective_time_switch | Number | 1 | |||
| effective_time | Number | 1 | |||
| compress | Number | 1 | |||
| compress_switch | Number | 0 | |||
| encrypt_switch | Number | 1 | |||
| encrypt | Number | 1 | |||
| bk_file_crypt | Number | 1 | |||
| bk_crypt_type | Number | 1 | |||
| bk_crypt_key | String | ||||
| band_width | String | ||||
| message | String | ||||
| code | Number | 0 |
整机备份 - 修改
SDK方法名：modifyFspBackupRule；
URL
/vers/v3/fsp/backup_rule/:uuid([A-F0-9]+)
Method
PUT
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_name | String | ||||
| rule_uuid | String | ||||
| random_str | String | ||||
| create_time | String | ||||
| rule_type | String | ||||
| biz_grp_list | Array | ||||
| timeout | Number | 1 | |||
| priority | Number | 1 | |||
| disable | Number | 1 | |||
| client_list | Array | ||||
| node_uuid | String | ||||
| unit_uuid | String | ||||
| tape_pool_uuid | String | ||||
| replica_uuids | Array | ||||
| trans_mode | Number | 1 | |||
| wk_path | Array | ||||
| path | String | PhysicalDrive0 | |||
| name | String | PhysicalDrive0 | |||
| icon | String | folder | |||
| size | Number | 42949672960 | |||
| file | String | ||||
| attr | Number | 1 | |||
| leaf | String | ||||
| subNodes | Array | ||||
| nodeUuid | String | 0986CDE6-85C6-4D03-8D78-9DD5E367916D | |||
| showSize | String | 40.00 GB | |||
| disabled | String | ||||
| has_policy | String | ||||
| right_path | String | ||||
| is_show | String | ||||
| database_switch | Number | 1 | |||
| database_type | Number | 1 | |||
| oracle_dbagent_param | Object | ||||
| oracle_sid | String | ||||
| sql_plus_path | String | ||||
| username | String | ||||
| password | String | ||||
| port | String | ||||
| table_space | String | ||||
| timeout | String | ||||
| sqlserver_dbagent_param | Object | ||||
| timeout | String | ||||
| custom_dbagent_param | Object | ||||
| pre_snapshot_script | String | ||||
| post_snapshot_script | String | ||||
| bkup_schedule | Array | ||||
| sched_name | String | ||||
| backup_type | Number | 1 | |||
| retention | Number | 1 | |||
| start_window | Array | ||||
| wday | Number | 1 | |||
| from | String | ||||
| to | String | ||||
| bkup_window | Array | ||||
| wday | Number | 1 | |||
| from | String | ||||
| to | String | ||||
| bkup_one_time | Number | 1 | |||
| bkup_policy | Number | 1 | |||
| exclude_days | Array | ["2023-06-02"] | |||
| cron_policies | String | ||||
| effective_time_switch | Number | 1 | |||
| effective_time | Number | 1 | |||
| compress | Number | 1 | |||
| compress_switch | Number | 0 | |||
| encrypt_switch | Number | 1 | |||
| encrypt | Number | 1 | |||
| bk_file_crypt | Number | 1 | |||
| bk_crypt_type | Number | 1 | |||
| bk_crypt_key | String | ||||
| band_width | String |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 |
整机备份 - 删除
SDK方法名：deleteFspBackupRule；
URL
/vers/v3/fsp/backup_rule
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_uuids | Array | ||||
| force | Number | 0 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 |
整机备份 - 操作
SDK方法名：operateFspBackupRule；
URL
/vers/v3/fsp/backup_rule/operate
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| operate | String | enable：启用； disable：禁用； manual_start：手动备份； clone：复制 | |||
| rule_uuids | Array | 已选择的，规则uuid | |||
| client_list | Array | 已选择的，客户端列表 | |||
| rule_uuid | String | 规则uuid | |||
| node_uuid | String | 客户端节点uuid | |||
| sched_name | String | 计划名称（手动备份必传） | |||
| new_rule_name | String | 复制出的新规则名称 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| data | Object | ||||
| code | Number | 11110001 | |||
| message | String | ||||
| fail_list | Array | ||||
| code | Number | 11110001 | |||
| message | String | [-1] 找不到节点 | |||
| rule_uuid | String | @uuid | |||
| rule_name | String | @name | |||
| node_uuid | String | ||||
| node_name | String | ||||
| hostname | String | ||||
| success_list | Array | ||||
| code | Number | 11110001 | |||
| message | String | [0] success | |||
| rule_uuid | String | @uuid | |||
| rule_name | String | @name | |||
| node_uuid | String | ||||
| node_name | String | ||||
| hostname | String | ||||
| ret | Number | 200 |
整机备份 - 状态
SDK方法名：listFspBackupRuleStatus；
URL
/vers/v3/fsp/backup_rule/status
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| rule_uuids | Array | 规则uuid列表 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| msg | String | ||||
| ret | Number | 200 | |||
| data | Object | ||||
| message | String | ||||
| code | Number | 0 | |||
| status | Object | ||||
| rule_uuid-node_uuid | Object | ||||
| status | String | ||||
| last_result | Object | ||||
| backup_type | String | ||||
| result | String | ||||
| end_time | String | ||||
| last_success_result | Object | ||||
| backup_type | String | ||||
| result | String | ||||
| end_time | String |
整机备份 - 获取节点设备列表
SDK方法名：listFspBackupDeviceInfo;
URL
/vers/v3/fsp/backup_rule/device_info
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| node_uuid | String | 节点uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| data | Object | ||||
| message | String | ||||
| code | Number | 0 | |||
| dev_list | Array | ||||
| name | String | fnrlu | |||
| size | Number | 7.997189767647315e15 | |||
| attr | String | 1 | |||
| leaf | Number | 0 | |||
| is_dir | Number | 1 | |||
| children | Array | ||||
| name | String | lvm1 | |||
| size | Number | 2.059209815596581e15 | |||
| has_policy | Number | 1 | |||
| node_uuid | String | ||||
| ret | Number | 200 | |||
| msg | String |