集群全量备份记录
获取集群正常完成的有效全量备份记录
接口URL
/api/v1/dms/br/backups?ClusterID=
请求方式
GET
Content-Type
application/json
认证方式
Bearer auth
请求Query参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| ClusterID | tidb-f91e1f860d360502 | Text | 是 | cluster id |
成功响应示例
{
"Data": {
"BackupTasks": [
{
"TaskID": "b-82959789",
"Type": 0,
"TriggerType": 1,
"Name": "tidb-test-fullbackup-0921",
"Status": 1,
"RestoredTS": {
"Time": "0001-01-01T00:00:00Z",
"Valid": false
},
"StartTime": "2023-09-21T16:16:56.19+08:00",
"EndTime": {
"Time": "2023-09-21T16:17:01.327+08:00",
"Valid": true
},
"ClusterID": "tidb-f91e1f860d360502",
"ClusterName": "haibo_test1",
"Destination": "s3://tem/br/tidb-test/0921?endpoint=http://172.16.6.62:9999&force-path-style=true",
"Size": "81.82kB",
"SizeByte": 83783,
"ErrMsg": "",
"PolicyID": "",
"PolicyName": "",
"Log": "[2023/09/21 16:17:01.287 +08:00] [INFO] [collector.go:77] [\"Full Backup success summary\"] [total-ranges=18] [ranges-succeed=18] [ranges-failed=0] [backup-checksum=23.318046ms] [backup-fast-checksum=8.030766ms] [backup-total-ranges=81] [backup-total-regions=81] [total-take=4.662090488s] [total-kv-size=295.7kB] [average-speed=63.43kB/s] [backup-data-size(after-compressed)=81.82kB] [Size=81821] [BackupTS=444408585956622345] [total-kv=1236]",
"AccessKeyID": "miniotem",
"SecretAccessKey": "miniotem",
"ExpireTime": {
"Time": "2023-09-28T16:16:56.193+08:00",
"Valid": true
}
},
{
"TaskID": "b-95659329",
"Type": 0,
"TriggerType": 1,
"Name": "tidb-test-fullbackup-0921",
"Status": 1,
"RestoredTS": {
"Time": "0001-01-01T00:00:00Z",
"Valid": false
},
"StartTime": "2023-09-21T17:09:20.599+08:00",
"EndTime": {
"Time": "2023-09-21T17:09:25.625+08:00",
"Valid": true
},
"ClusterID": "tidb-f91e1f860d360502",
"ClusterName": "haibo_test1",
"Destination": "s3://tem/br/tidb-test/0921toStop?endpoint=http://172.16.6.62:9999&force-path-style=true",
"Size": "81.82kB",
"SizeByte": 83783,
"ErrMsg": "",
"PolicyID": "",
"PolicyName": "",
"Log": "[2023/09/21 17:09:25.585 +08:00] [INFO] [collector.go:77] [\"Full Backup success summary\"] [total-ranges=18] [ranges-succeed=18] [ranges-failed=0] [backup-checksum=23.183573ms] [backup-fast-checksum=7.760161ms] [backup-total-regions=81] [backup-total-ranges=81] [total-take=4.650297744s] [backup-data-size(after-compressed)=81.82kB] [Size=81822] [BackupTS=444409410216263686] [total-kv=1236] [total-kv-size=295.7kB] [average-speed=63.59kB/s]",
"AccessKeyID": "miniotem",
"SecretAccessKey": "miniotem",
"ExpireTime": {
"Time": "2023-09-28T17:09:20.602+08:00",
"Valid": true
}
},
]
},
"Success": true
}
| 参数名 | 示例值 | 参数类型 | 参数描述 |
|---|---|---|---|
| code | - | String | |
| data.BackupTasks | - | Array | |
| data.BackupTasks.AccessKeyID | - | String | AccessKeyID，仅当存储是 s3 类型时会有 |
| data.BackupTasks.ClusterID | - | String | 集群 ID |
| data.BackupTasks.ClusterName | - | String | 集群名称 |
| data.BackupTasks.Destination | - | String | 备份目的地或者恢复来源 |
| data.BackupTasks.EndTime.time | - | String | 任务结束时间 |
| data.BackupTasks.EndTime.valid | - | Boolean | 任务结束时间有效标识 |
| data.BackupTasks.ErrMsg | - | String | |
| data.BackupTasks.ExpireTime.time | - | String | 备份文件过期时间 |
| data.BackupTasks.ExpireTime.valid | - | Boolean | 备份文件过期时间有效标识 |
| data.BackupTasks.Log | - | String | 任务日志 |
| data.BackupTasks.Name | - | String | 任务名 |
| data.BackupTasks.PolicyID | - | String | 备份策略 ID（如果有） |
| data.BackupTasks.PolicyName | - | String | 备份策略名称（如果有） |
| data.BackupTasks.RestoredTS.time | - | String | 恢复任务时间点（如果有） |
| data.BackupTasks.RestoredTS.valid | - | Boolean | 恢复任务时间点有效标识 |
| data.BackupTasks.SecretAccessKey | - | String | SecretAccessKey，仅当存储是 s3 类型时会有 |
| data.BackupTasks.Size | 10TB/100GB | String | 备份任务文件大小（如果有） |
| data.BackupTasks.StartTime | - | String | 任务启动时间 |
| data.BackupTasks.Status | - | Integer | 任务状态：0 运行 1 完成 2 异常 3 停止 |
| data.BackupTasks.TriggerType | - | Integer | 触发类型：0 自动，1 手动 |
| data.BackupTasks.Type | - | Integer | 任务类型：0 快照备份，1 日志备份，2 基于快照备份的恢复，3 基于日志备份 |
| message | - | String | |
| success | - | Boolean |