备份集
February 26, 2024About 19 min
备份集
SDK类名：/backupSet/BackupSet;
备份集管理 - 列表
SDK方法名：listBackupSet
URL
/backup_set
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| page | Number | 1 | |||
| limt | Number | 10 | |||
| where_args | Array | ||||
| wk_name | String | 源端备份服务器名称或者主机名 | |||
| src_type | String | 源类型（规则类型） | |||
| bk_name | String | 备端备份服务器名称或者主机名 | |||
| bk_rule_name | String | 备份规则名称 | |||
| bk_start_tm | String | 备份起始时间晚于 | |||
| bk_end_tm | String | 备份结束时间早于 | |||
| storage_unit_name | String | 存储单元名 | |||
| tname | String | 磁带名 | |||
| delete | String | 是否已删除备份集，0：关，1：已过期，2：已删除 | |||
| copy_id | String | 副本号 | |||
| bk_type | String | 备份类型：0-全备 1-增量 2-差异 | |||
| replica_task_sched_name | String | 备份计划名 | |||
| vp_uuid | String | 虚拟平台uuid | |||
| vm_id | String | 虚机id | |||
| instance_name | String | 实例名称 | |||
| db_name | String | 数据库名称 | |||
| backup_method | Number | 数据库备份类型： 0：物理备份 1：逻辑备份 | |||
| content_type | Number | 数据库备份粒度： 0：集群； 1：实例； 2：整库； 3：模式； 4：多表； （mysq、GaussDWS） | |||
| wk_uuid | String | 源客户端UUId | |||
| or_where_by_group | String | json格式 | |||
| stage | Array | 需要过滤的状态，不传分页参数时生效 | [0,1] | ||
| like_args | Array | ||||
| barcode | String | 根据条形码过滤 磁带-查看备份集 | |||
| show_all_copy | Number | 是否区分主副本，0：区分，1：不区分 | |||
| filter_log | Number | 是否过滤日志备份集： 0：否； 1：是； | 0 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 否 | 200 | ||
| msg | String | 否 | |||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 | |||
| info_list | Array | 2 | |||
| copy_sum | Number | 1 | |||
| user_uuid | String | 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC | |||
| backup_rule_name | Array | ["oracle-rac-data","oracle-rac-log"] | +1 | ||
| bk_set_id | Array | ["icbc-ora12c-sles12-r2_1714298447_72BFEFA3_0","icbc-ora12c-sles12-r2_1714296820_98CD5524_0"] | +1 | ||
| bk_rule_uuid | Array | ["61F978BA-C2A3-4A22-9336-FB9469C7C0AF","0E08AFA8-9787-4485-9256-A4DF9CBBFEEA"] | +1 | ||
| copy_id | Number | 0 | |||
| primary_copy | Number | 1 | |||
| created_at | Number | 1714298926 | +1 | ||
| ver | Array | ["20240426211959","20240425112318"] | +1 | ||
| raw_json | Object | ||||
| backup_key | String | ||||
| bk_end_tm | Number | 1714298926 | +1 | ||
| bk_files | Number | 18 | +1 | ||
| bk_host_addr | String | 10.1.65.63 | |||
| bk_host_name | String | icbc-backup1-kylinv10 | |||
| bk_node_name | String | baksvr63 | |||
| bk_path | Array | ["/pool0425/oracleFS1/666D8992-7EBC-4C11-AA05-00764AADEEE1/72BFEFA3-A550-469B-8847-5FDBC0BDD016/icbc-ora12c-sles12-r2_1714298447_72BFEFA3_0/C0/","/pool0425/oracleFS1/666D8992-7EBC-4C11-AA05-00764AADEEE1/98CD5524-C5CF-40CA-8FBF-1A59F7B2E68F/icbc-ora12c-sles12-r2_1714296820_98CD5524_0/C0/"] | +1 | ||
| bk_rule_name | Array | ["oracle-rac-data","oracle-rac-log"] | +1 | ||
| bk_rule_uuid | Array | ["61F978BA-C2A3-4A22-9336-FB9469C7C0AF","0E08AFA8-9787-4485-9256-A4DF9CBBFEEA"] | +1 | ||
| bk_set_id | Array | ["icbc-ora12c-sles12-r2_1714298447_72BFEFA3_0","icbc-ora12c-sles12-r2_1714296820_98CD5524_0"] | +1 | ||
| bk_set_size | Number | 0 | |||
| bk_size | Number | 208450617632 | +1 | ||
| bk_start_tm | Number | 1714298447 | +1 | ||
| bk_type | Number | 0 | |||
| bk_uuid | String | 2EFC948F-1CB5-41AF-9E31-8D93ECE0DF89 | |||
| bkup_policy | Number | 1 | |||
| blk_size | Number | 0 | |||
| compressed | Number | 0 | |||
| concurrent | Number | 4 | |||
| content_type | Number | 0 | +1 | ||
| copy_id | Number | 0 | |||
| data_source | Object | ||||
| vp | Object | ||||
| vm_id | String | 虚机ID | |||
| vm_name | String | 虚机名称 | |||
| disks | Array | 磁盘配置 | |||
| id | String | 磁盘ID | |||
| disk_name | String | 磁盘名称 | |||
| boot_index | Number | 磁盘引导顺序 | |||
| disk_type | String | 磁盘类型 | |||
| datastore_type | String | 存储格式 | |||
| nics | Array | 网卡配置 | |||
| network_id | String | 网卡ID | |||
| network_name | String | 网卡名称 | |||
| mac | String | MAC地址 | |||
| num_cpus | Number | cpu数 | |||
| memory_mb | Number | 内存大小(MB) | |||
| core_per_sock | Number | 核心数 | |||
| vp_uuid | String | 平台UUID | |||
| vp_type | Number | 平台类型 0：VMWARE， 1：HYPERV， 2：KVM， 3：I2DRP， 4：ClOUD， 5：OPENSTACK， 6：FF2VM， 7：CAS, 8：HUAWEI, 9：HWCLOUDSTACK 10：FUSIONCOMPUTE 11：WINSTACK 13：AIO 14：ALICLOUD 15：CLOUDOS 16：SCP 17：ZSTACKCLOUD | |||
| file_recovery | Number | 是否支持文件恢复 0：否； 1：是； | |||
| instant_recovery | Number | 是否支持瞬时恢复 0：否； 1：是； | |||
| details | String | ||||
| stor_encrypt | Number | 备份集加密类型 0：未加密； 1：AES； 2：SM4； 算法可扩展 | 0 | ||
| mssql | Object | ||||
| instance_name | String | 实例名称 | ins-@first | ||
| db_name | String | 数据库名称 | db-@first | ||
| logic_infos | Array | 2-4 | |||
| logic_name | String | 逻辑名称 | logic-@first | ||
| logic_path | String | 源路径 | /@word | ||
| db_file_path | String | ||||
| db_size | String | 数据库大小 | |||
| rt_time | String | 恢复时间点 | |||
| mysql | Object | ||||
| instance_name | String | 实例名称 | |||
| backup_method | Number | 备份类型： 0：物理备份； 1：逻辑备份； | 0-1 | ||
| content_type | Number | 备份粒度： 0：集群； 1：实例； 2：整库； 3：模式； 4：多表； （mysq、GaussDWS） | 0-4 | ||
| multiple_tables | Array | 表备份： | 2-4 | ||
| db_name | String | 所属库 | db@first | ||
| schemas | String | （mysql无用） | |||
| tables | Array | 数据表列表 | ["table@first","table@first"] | ||
| pgsql | Object | ||||
| instance_name | String | ||||
| backup_method | Number | ||||
| content_type | Number | ||||
| db_version | String | 数据库版本 | |||
| pg_recovery_tm | Number | unix时间戳，备份集有效恢复时间 | |||
| gaussdb_dws | Object | ||||
| db_version | String | 集群版本 | |||
| content_type | String | 备份恢复类型： 0：集群； 1：实例； 2：整库； 3：模式； 4：表； | |||
| multiple_tables | Array | 备份内容 | 1-3 | ||
| db_name | String | 库 | db@first | ||
| schemas | String | 模式 | schemas@first | ||
| tables | Array | 表 | ["table@first","table@first"] | ||
| obj_storage | Object | ||||
| wk_dir | Array | 备份目录 | |||
| type | Number | 对象存储类型 | |||
| bucket | String | 桶名称 | |||
| uuid | String | 对象存储UUID | |||
| format | Number | 存储格式：0：原始格式； 1：打包格式 | |||
| dst_os | Number | 备端操作系统 | |||
| depend | Array | ["icbc-ora12c-sles12-r2_1714288452_ED271FE2_0","icbc-ora12c-sles12-r2_1714293686_A8B57604_1"] | |||
| disk_pool_name | String | test | |||
| dst_os | Number | 0 | |||
| dst_storage_unit | Object | ||||
| storage_unit_group | Number | 0 | |||
| storage_unit_name | String | oracleUT1 | |||
| storage_unit_type | String | DISKPOOL | |||
| storage_unit_type_number | Number | 0 | |||
| storage_unit_uuid | String | 16360DBA-B600-4826-BE65-CAF972F09BAD | |||
| dst_storage_unit_group | Object | ||||
| storage_unit_name | String | ||||
| storage_unit_uuid | String | ||||
| expire_policy | Number | 0 | |||
| expire_tm | Number | 1714385326 | +1 | ||
| extend | Object | ||||
| reserved | String | ||||
| fileCrypt | Object | ||||
| key | String | ||||
| ukey_Info | String | NULL_UKEY_INFO | |||
| val | Number | 0 | |||
| format | Number | 1 | |||
| fragment_size | Number | 0 | |||
| full_job_uuid | Array | ["72BFEFA3-A550-469B-8847-5FDBC0BDD016","98CD5524-C5CF-40CA-8FBF-1A59F7B2E68F"] | +1 | ||
| i2node_ver | String | 9.0.2404242137 | |||
| index_server | String | 10.1.65.65 | |||
| job_uuid | Array | ["72BFEFA3-A550-469B-8847-5FDBC0BDD016","98CD5524-C5CF-40CA-8FBF-1A59F7B2E68F"] | +1 | ||
| media_info | String | ||||
| metadata_path | Array | ["/pool0425/oracleFS1/666D8992-7EBC-4C11-AA05-00764AADEEE1/72BFEFA3-A550-469B-8847-5FDBC0BDD016/icbc-ora12c-sles12-r2_1714298447_72BFEFA3_0/C0/","/pool0425/oracleFS1/666D8992-7EBC-4C11-AA05-00764AADEEE1/98CD5524-C5CF-40CA-8FBF-1A59F7B2E68F/icbc-ora12c-sles12-r2_1714296820_98CD5524_0/C0/"] | +1 | ||
| primary_copy | Number | 1 | |||
| retention | Number | 1 | |||
| sched_name | Array | ["RAC-DATA-FULL","RAC-LOG-FULL"] | +1 | ||
| src_instance | String | icbc2 | |||
| src_os | Number | 0 | |||
| src_type | Number | 3 | |||
| stage | Number | 4 | |||
| tape_library | String | ||||
| tape_name | Array | ||||
| tname | String | ||||
| tape_pool | String | ||||
| tape_sn | String | ||||
| task_uuid | Array | ["61F978BA-C2A3-4A22-9336-FB9469C7C0AF","0E08AFA8-9787-4485-9256-A4DF9CBBFEEA"] | +1 | ||
| ver | Array | ["20240426211959","20240425112318"] | +1 | ||
| wk_host_addr | String | 10.1.65.57 | |||
| wk_host_name | String | icbc-ora12c-sles12-r2 | |||
| wk_node_name | String | oracle-rac-n2 | |||
| wk_uuid | String | 666D8992-7EBC-4C11-AA05-00764AADEEE1 | |||
| expire_tm | Number | 1714385326 | +1 | ||
| bk_start_tm | Number | 1714298447 | +1 | ||
| bk_end_tm | Number | 1714298926 | +1 | ||
| bk_rule_name | Array | ["oracle-rac-data","oracle-rac-log"] | +1 | ||
| bk_size | Number | 208450617632 | +1 | ||
| wk_host_name | String | icbc-ora12c-sles12-r2 | |||
| wk_node_name | String | oracle-rac-n2 | |||
| bk_host_name | String | icbc-backup1-kylinv10 | |||
| bk_node_name | String | baksvr63 | |||
| storage_unit_name | String | oracleUT1 | |||
| src_type | Number | 3 | |||
| bk_set_uuid | Array | ["EFF7BA74-3DD6-49D9-B056-DE64F813187B","E91E827B-BE77-4CF6-98D0-999019EC4C0F"] | +1 | ||
| bk_type | Number | 0 | |||
| task_type | Number | 0 | |||
| wk_uuid | String | 666D8992-7EBC-4C11-AA05-00764AADEEE1 | |||
| next_copy_id | Number | 0 | |||
| stage | Number | 4 | |||
| tname | Null | ||||
| barcode | String | ||||
| storage_unit_uuid | String | 16360DBA-B600-4826-BE65-CAF972F09BAD | |||
| delete | Number | 0 | |||
| deleted_at | Number | 0 | |||
| src_instance | String | icbc2 | |||
| task_uuid | Array | ["61F978BA-C2A3-4A22-9336-FB9469C7C0AF","0E08AFA8-9787-4485-9256-A4DF9CBBFEEA"] | +1 | ||
| storage_unit_group_name | String | ||||
| storage_unit_group_uuid | String | ||||
| sched_name | Array | ["RAC-DATA-FULL","RAC-LOG-FULL"] | +1 | ||
| group_name | Null | ||||
| depend | Array | ["icbc-ora12c-sles12-r2_1714288452_ED271FE2_0","icbc-ora12c-sles12-r2_1714293686_A8B57604_1"] | |||
| bk_uuid | String | 2EFC948F-1CB5-41AF-9E31-8D93ECE0DF89 | |||
| bk_node_del | Number | 0 | |||
| wk_node_del | Number | 0 | |||
| storage_unit_del | Number | 0 | |||
| storage_unit_group_del | Number | 0 | |||
| bk_set_size | Number | 0 | |||
| storage_unit_type | Number | 3 | |||
| is_biz_admin | Number | 1 | |||
| can_del | Number | 1 | |||
| can_op | Number | 1 | |||
| can_up | Number | 1 | |||
| os_type | Number | 1 | |||
| instance_name | String | 备份数据库实例名称 | |||
| db_name | String | 备份数据库名称 | |||
| backup_method | Number | 备份类型： 0：物理备份 1：逻辑备份 | |||
| content_type | Number | 备份粒度： 0：集群； 1：实例； 2：整库； 3：模式； 4：多表； （mysq、GaussDWS） | |||
| tape_pool_name | String | 磁带池名称 | |||
| disk_pool_name | String | 磁盘池名称 | |||
| total | Number | 2 | |||
| data_sum | Number | 208608952736 |
备份集管理 - 获取列表查询候选信息
SDK方法名：listQueryArgsBackupSet
URL
/backup_set/query_args
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| search_field | String | 搜索字段名（仅限可以条件查询的） | |||
| search_value | String | 搜索内容 | |||
| delete | Number | 是否为已删除菜单，0：否，1：是 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | String | ||||
| msg | String | ||||
| data | Object | ||||
| code | String | ||||
| total | String | ||||
| info_list | Array | 对应模糊搜索结果（根据系统设置分页） |
备份集管理 - 操作
SDK方法名：operateBackupSet；
URL
/backup_set/operate
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| bk_set_list | Array | 备份集uuid数组 | |||
| bk_set_uuid | String | 备份集uuid | |||
| expire_tm | String | 过期时间（延长期限操作） | |||
| operate | String | extend：延长期限 expire：立即过期 set_primary：设为主副本 | extend | ||
| force | Number | 是否强制过期，0：关，1：开 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | ||||
| msg | String | ||||
| data | Object | ||||
| success_list | Array | ||||
| code | String | ||||
| messgae | String | ||||
| bk_set_id | String | ||||
| copy_id | String | ||||
| fail_list | Array | ||||
| code | String | ||||
| message | String | ||||
| bk_set_id | String | ||||
| copy_id | String | ||||
| all_list | Array | ||||
| code | String | ||||
| message | String | ||||
| bk_set_id | String | ||||
| copy_id | String |
备份集管理 - 手动删除
SDK方法名：deleteDbBackupSet
URL
/backup_set
Method
DELETE
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| uuids | Array | 备份集uuid列表 | |||
| force | String | 是否强制删除，0：否，1：是 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | ||||
| msg | String | ||||
| data | Object | ||||
| success_list | Array | ||||
| code | String | ||||
| messgae | String | ||||
| bk_set_id | String | ||||
| copy_id | String | ||||
| fail_list | Array | ||||
| code | String | ||||
| message | String | ||||
| bk_set_id | String | ||||
| copy_id | String | ||||
| all_list | Array | ||||
| code | String | ||||
| message | String | ||||
| bk_set_id | String | ||||
| copy_id | String |
备份集管理 - 手动强制清理
SDK方法名：manualForceDeleteDbBackupSet
URL
/backup_set/force_delete
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| uuids | Array | 备份集uuid列表 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | ||||
| msg | String | ||||
| data | Object | ||||
| success_list | Array | ||||
| code | String | ||||
| messgae | String | ||||
| bk_set_id | String | ||||
| copy_id | String | ||||
| fail_list | Array | ||||
| code | String | ||||
| message | String | ||||
| bk_set_id | String | ||||
| copy_id | String | ||||
| all_list | Array | ||||
| code | String | ||||
| message | String | ||||
| bk_set_id | String | ||||
| copy_id | String |
备份集管理 - 标记删除（内部程序调用）
SDK方法名：deleteBackupSet
URL
/backup_set/delete
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| bk_set_list | Array | 备份集id数组 | |||
| bk_set_id | String | 备份集id | |||
| bk_rule_uuid | String | 备份集规则uuid | |||
| copy_id | String | 副本id | |||
| delete_from_db | Number | 是否直接从库内删除，0：否，1：是 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | ||||
| msg | String | ||||
| data | Object | ||||
| success_list | Array | ||||
| code | String | ||||
| messgae | String | ||||
| bk_set_id | String | ||||
| copy_id | String | ||||
| fail_list | Array | ||||
| code | String | ||||
| message | String | ||||
| bk_set_id | String | ||||
| copy_id | String | ||||
| all_list | Array | ||||
| code | String | ||||
| message | String | ||||
| bk_set_id | String | ||||
| copy_id | String |
备份集复制 - 提交复制规则
SDK方法名：createBackupSetRepRule
URL
/backup_set/rule
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| bk_set_uuids | Array | 备份集uuid数组 | |||
| unit_uuid | String | 存储单元uuid | |||
| tape_pool_uuid | String | 磁带池uuid | |||
| retention_level | String | 保留等级 | |||
| start_time | Number | 启动时间戳 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| all_list | Array | ||||
| code | String | ||||
| message | String | ||||
| bk_set_id | String | ||||
| fail_list | String | ||||
| success_list | String |
备份集管理 - 单个
SDK方法名：describeBackupSet；
URL
/backup_set/single
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| bk_set_uuid | String | 备份集uuid | |||
| bk_set_id | String | 备份集id（bk_set_uuid空时，必传） |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | [0] 操作成功。 | |||
| backup_set | Object | ||||
| bk_set_id | String | i2bbdev_1719369205_F22BD3CA_0 | |||
| bk_rule_uuid | String | 961C9E98-2E76-4139-890A-F5EDAEF1B9B8 | |||
| copy_id | Number | 0 | |||
| primary_copy | Number | 1 | |||
| created_at | Number | 1719370015 | |||
| ver | String | 961C9E98-2E76-4139-890A-F5EDAEF1B9B8 - 1719368627 | |||
| expire_tm | Number | 1719974158 | |||
| bk_start_tm | Number | 1719369237 | |||
| bk_end_tm | Number | 0 | |||
| bk_rule_name | String | 备份规则名 | 1453磁带bak | ||
| bk_size | Number | 备份大小 | 70496278 | ||
| wk_host_name | String | 客户端主机名 | |||
| wk_node_name | String | 客户端名称 | 135.37-i2bb | ||
| bk_host_name | String | 服务器主机名 | |||
| bk_node_name | String | 服务器名称 | |||
| storage_unit_name | String | 磁带带库12 | |||
| src_type | Number | 源数据类型， 1: file， 2: vp(虚拟机) 3: oracle 4：HDFS 5：HIVE 21: oracle rac 22: GaussDB(HCS) 23: PostgreSQL 24: OceanBase 25: PolarDB 26: S3 27: FusionCompute 28: GaussDB(DWS) 29：mssql 30：ffo(整机) 31. mysql 32. dm | 4 | ||
| bk_set_uuid | String | 0EB9CC93-6225-4CBB-8059-BCBFA8D91866 | |||
| bk_type | Number | 备份策略中的备份类型： 0全备；1增量；2差异；3：预留；4：日志 | 0 | ||
| task_type | Number | 任务类型： 0：备份； 1：恢复； | 0 | ||
| wk_uuid | String | A7830B7D-084E-48A1-A153-69F17CA6EB16 | |||
| next_copy_id | Number | 0 | |||
| stage | Number | 状态 | 4 | ||
| tname | Null | ||||
| barcode | String | /var/i2data/bakmetadata/A7830B7D-084E-48A1-A153-69F17CA6EB16/F22BD3CA-5D11-472B-96CF-1F8B41402A88/i2bbdev_1719369205_F22BD3CA_0/C0 | |||
| storage_unit_uuid | String | 614F317A-E3A6-407C-8D03-A7F23CFD081E | |||
| delete | Number | 0 | |||
| deleted_at | Number | 0 | |||
| src_instance | Null | ||||
| content_type | Null | ||||
| task_uuid | String | F22BD3CA-5D11-472B-96CF-1F8B41402A88 | |||
| storage_unit_group_name | String | ||||
| storage_unit_group_uuid | String | ||||
| sched_name | String | ds | |||
| group_name | Null | 业务组名 | |||
| depend | Null | ||||
| bk_uuid | String | 73FA2775-A5CA-47A8-A8AA-C871DBAB9C83 | |||
| bk_node_del | Number | 0 | |||
| wk_node_del | Number | 0 | |||
| storage_unit_del | Number | 0 | |||
| storage_unit_group_del | Number | 0 | |||
| bk_set_size | Number | 70496278 | |||
| storage_unit_type | Number | 2 | |||
| protocol_version | Number | 2 | |||
| storage_bk_path | Null | 存储介质 | |||
| work_dir_list | Null | 客户端保护对象 | |||
| expire_policy | Number | 备份集删除策略 | 0 | ||
| bk_host_addr | String | 客户端地址 | 10.1.132.136 | ||
| wk_host_addr | String | 服务器地址 | 10.1.135.37 | ||
| bk_chain_id | String | F22BD3CA-5D11-472B-96CF-1F8B41402A88 | |||
| biz_grp_name | Array | ||||
| biz_grp_list | Array | ||||
| is_biz_admin | Number | 1 | |||
| can_del | Number | 1 | |||
| can_op | Number | 1 | |||
| can_up | Number | 1 | |||
| can_view | Number | 1 | |||
| bk_files | String | 备份文件数 |
备份集管理 - 已删除备份集 单个
SDK方法名：describeDeletedBackupSet
URL
/backup_set/single_deleted
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| bk_set_uuid | String | 备份集uuid |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | String | ||||
| msg | String | ||||
| data | Object | ||||
| backup_set | Object |
备份集管理 - 查看副本
SDK方法名：describeBackupSetCopy
URL
/backup_set/copy_list
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| bk_set_uuid | String | 备份集uuid | |||
| page | Number | 1 | |||
| limt | Number | 10 | |||
| search_field | String | ||||
| search_value | String |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | String | ||||
| msg | String | ||||
| data | Object | ||||
| code | String | ||||
| message | String | ||||
| info_list | Array | ||||
| xxx | Object |
备份集复制 - 列表
SDK方法名：listBackupSetRule
URL
/backup_set/rule
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| page | Number | 1 | |||
| limt | Number | 10 | |||
| search_field | String | primary_copy | |||
| search_value | String | 0：非主副本 1：主副本 | 1 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | String | ||||
| msg | String | ||||
| data | Object | ||||
| code | String | ||||
| total | String | ||||
| info_list | Array | 10 |
备份集管理 - 验证
SDK方法名：validateBackupSet
URL
/backup_set/verify
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| bk_set_uuids | Array | 备份集uuid | |||
| mode | String | 63 简单验证 64 详细验证 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | String | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | String | 0 | |||
| message | String |
备份集管理 - 过期当前主副本 & 更新最小副本号备份集为主副本（内部程序调用）
SDK方法名：resetPrimaryBackupSet；
URL
/backup_set/reset_primary
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| bk_set_id | String | 备份集id | |||
| bk_rule_uuid | String | 备份规则uuid | |||
| expire_tm | Number | 过期时间时间戳（如果不传则不更新） |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | ||||
| msg | String | ||||
| data | Object | ||||
| code | String | 0：成功，其他：失败 | |||
| message | String | ||||
| prev_bk_set_id | String | 前主副本备份集id | |||
| prev_copy_id | String | 前主副本副本id | |||
| prev_bk_rule_uuid | String | 前主副本备份规则uuid | |||
| next_bk_set_id | String | 新主副本备份集id | |||
| next_copy_id | String | 新主副本副本id | |||
| next_bk_set_uuid | String | 新主副本备份规则uuid |
备份集管理 - 查看备份链
SDK方法名：listBackupChain
URL
/backup_set/backup_chain
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| bk_set_uuid | String | 是 | 备份集uuid | ||
| backup_chain_policy | Number | 恢复时使用 1: 策略1 2: 策略2 3: 策略3 4: 策略4 | |||
| bk_server_uuid | String | 策略4时需要下发，备份服务器uuid | |||
| bk_server_addr | String | 策略4时需要下发，备份服务器地址 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | String | 200 | |||
| msg | String | ||||
| data | Object | ||||
| info_list | Array | 格式同备份集列表 | |||
| total | String |
备份集管理 - 演练
SDK方法名：drillBackupSet
URL
/backup_set/drill
Method
POST
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| vp_uuid | String | 演练平台uuid | |||
| drill_list | Array | ||||
| bk_set_uuid | String | 备份集uuid | |||
| orch_vm_name | String | 演练虚机名称 | |||
| scripts_type | Number | 脚本验证的方式： 0：ping验证； 1：tcp端口验证； 2：脚本验证方式 | |||
| scripts | String | 验证内容 | |||
| new_flavor_id | String | 云平台演练 - 规格ID | |||
| new_network_id | String | 云平台演练 - 网络ID | |||
| new_network_name | String | 云平台演练 - 网络名称 | |||
| cpu | Number | cpu数量 | |||
| core_per_sock | Number | cpu核心数 | |||
| mem_mb | Number | 内存 | |||
| auto_drill | Number | 自动演练： 0：否； 1：是； | 0 |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | String | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | String | 0 | |||
| message | String |
获取（存在备份集的）实例客户端列表
SDK方法名：listSrcClient;
src_type必传，其余参数参照创建规则时默认获取所有备份集所传递的过滤参数
URL
/backup_set/list_src_client
Method
GET
Request
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| where_args[src_type] | Number | 是 | 源数据类型： 4：mssql； 9：mysql； 23：PostgreSQL； 28：GaussDWS； |
Response
| 名称 | 类型 | 必选 | 简介 | Mock初始值 | Mock规则 |
|---|---|---|---|---|---|
| ret | Number | 200 | |||
| msg | String | ||||
| data | Object | ||||
| code | Number | 0 | |||
| message | String | ||||
| list | Array | 2-4 | |||
| node_uuid | String | 客户端节点UUID | @uuid | ||
| node_name | String | 客户端节点名称 | node-@first | ||
| gauss_db_version | String | gaussdws集群版本 | |||
| instance_list | Array | 实例列表 | 3 | ||
| instance_name | String | ins-@first | |||
| db_list | Array | 数据库列表 | ['zxcv', 'qwer'] |