备份恢复任务列表
接口URL
/api/v1/dms/br/tasks
请求方式
POST
Content-Type
application/json
认证方式
Bearer auth
请求Body参数
{
"CurrentPage": 1,
"PageSize": 10,
"Status": [
1,
3
],
"Type": [
0
],
"ClusterName": "shb_test1"
}
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| CurrentPage | 1 | Integer | 是 | - |
| PageSize | 10 | Integer | 是 | - |
| Status | 1 | Array | 是 | 0: 运行中，1：已完成，2：异常，3：停止 |
| Type | 0 | Array | 是 | 0: 全量备份，1：日志备份，2：基于文件恢复，3：基于时间恢复 |
| ClusterName | shb_test1 | String | 是 | 集群名称，可不写全 |
成功响应示例
{
"Data": {
"CurrentPage": 1,
"PageSize": 10,
"Total": 2,
"Pages": 1,
"Data": [
{
"TaskID": "b-47602108",
"Type": 0,
"TriggerType": 1,
"Name": "fbin1116",
"Status": 1,
"RestoredTS": {
"Time": "0001-01-01T00:00:00Z",
"Valid": false
},
"StartTime": "2023-11-16T18:42:37.756+08:00",
"EndTime": {
"Time": "2023-11-16T18:42:46.259+08:00",
"Valid": true
},
"ClusterID": "tidb-d1590298fecd3afe",
"ClusterName": "shb_test1",
"Destination": "s3://tem/br/shb_test1_1116?endpoint=http://minio.pingcap.net:9000&force-path-style=true",
"Size": "85.27kB",
"SizeByte": 87316,
"ErrMsg": "",
"PolicyID": "",
"PolicyName": "",
"Log": "[2023/11/16 18:42:39.853 +08:00] [WARN] [backup.go:301] [\"setting `--ratelimit` and `--concurrency` at the same time, ignoring `--concurrency`: `--ratelimit` forces sequential (i.e. concurrency = 1) backup\"] [ratelimit=134.2MB/s] [concurrency-specified=4] [2023/11/16 18:42:46.210 +08:00] [INFO] [collector.go:77] [\"Full Backup success summary\"] [total-ranges=19] [ranges-succeed=19] [ranges-failed=0] [backup-checksum=22.916187ms] [backup-fast-checksum=8.053545ms] [backup-total-ranges=82] [backup-total-regions=82] [total-take=6.35984831s] [total-kv-size=308.3kB] [average-speed=48.47kB/s] [backup-data-size(after-compressed)=85.27kB] [Size=85266] [BackupTS=445679235509780482] [total-kv=1277]",
"AccessKeyID": "minioadmin",
"SecretAccessKey": "minioadmin",
"RateLimit": 128,
"Concurrency": 4,
"LogFile": "",
"ExpireTime": {
"Time": "0001-01-01T00:00:00Z",
"Valid": false
}
},
{
"TaskID": "b-07085762",
"Type": 0,
"TriggerType": 1,
"Name": "selenium_backupmrwyja",
"Status": 1,
"RestoredTS": {
"Time": "0001-01-01T00:00:00Z",
"Valid": false
},
"StartTime": "2023-11-14T14:20:31.219+08:00",
"EndTime": {
"Time": "2023-11-14T14:20:52.289+08:00",
"Valid": true
},
"ClusterID": "tidb-d1590298fecd3afe",
"ClusterName": "shb_test1",
"Destination": "s3://tem/br/frontend-mrwyja?endpoint=http://minio.pingcap.net:9000&force-path-style=true",
"Size": "85.26kB",
"SizeByte": 87306,
"ErrMsg": "",
"PolicyID": "",
"PolicyName": "",
"Log": "[2023/11/14 14:20:31.498 +08:00] [WARN] [backup.go:301] [\"setting `--ratelimit` and `--concurrency` at the same time, ignoring `--concurrency`: `--ratelimit` forces sequential (i.e. concurrency = 1) backup\"] [ratelimit=1.075TB/s] [concurrency-specified=16] [2023/11/14 14:20:52.240 +08:00] [INFO] [collector.go:77] [\"Full Backup success summary\"] [total-ranges=19] [ranges-succeed=19] [ranges-failed=0] [backup-checksum=23.164814ms] [backup-fast-checksum=8.093044ms] [backup-total-ranges=82] [backup-total-regions=82] [total-take=20.745091947s] [BackupTS=445629814183034882] [total-kv=1277] [total-kv-size=308.3kB] [average-speed=14.86kB/s] [backup-data-size(after-compressed)=85.26kB] [Size=85263]",
"AccessKeyID": "minioadmin",
"SecretAccessKey": "minioadmin",
"RateLimit": 1024768,
"Concurrency": 16,
"LogFile": "/tmp/backup.log",
"ExpireTime": {
"Time": "0001-01-01T00:00:00Z",
"Valid": false
}
}
]
},
"Success": true
}
| 参数名 | 示例值 | 参数类型 | 参数描述 |
|---|---|---|---|
| Data | - | Object | - |
| Data.CurrentPage | 0 | Integer | - |
| Data.PageSize | 10 | Integer | - |
| Data.Total | 4 | Integer | - |
| Data.Pages | 1 | Integer | - |
| Data.Data | - | Array | - |
| Data.Data.TaskID | b-60249842 | String | 任务 ID |
| Data.Data.Type | 0 | Integer | 任务类型：0 快照备份，1 日志备份，2 基于快照备份的恢复，3 基于日志备份 |
| Data.Data.TriggerType | 1 | Integer | 触发类型：0 自动，1 手动 |
| Data.Data.Name | tidb-test-fullbackup-0921 | String | 任务名称 |
| Data.Data.Status | 1 | Integer | 任务状态：0 运行 1 完成 2 异常 3 停止 |
| Data.Data.RestoredTS | - | Object | - |
| Data.Data.RestoredTS.Time | 0001-01-01T00:00:00Z | String | 恢复任务时间点（如果有） |
| Data.Data.RestoredTS.Valid | false | Boolean | 恢复任务时间点有效标识 |
| Data.Data.StartTime | 2023-09-21T17:17:50.962+08:00 | String | 任务开始时间 |
| Data.Data.EndTime | - | Object | - |
| Data.Data.EndTime.Time | 2023-09-21T17:17:56.027+08:00 | String | 任务结束时间（如果有） |
| Data.Data.EndTime.Valid | true | Boolean | 任务结束时间有效标识 |
| Data.Data.ClusterID | tidb-f91e1f860d360502 | String | 集群 ID |
| Data.Data.ClusterName | haibo_test1 | String | 集群名称 |
| Data.Data.Destination | s3://tem/br/tidb-test/ 0921toStop3?endpoint= http://172.16.6.62:9999& force-path-style=true |
String | 备份目的地或者恢复来源 |
| Data.Data.Size | 81.82kB | String | 备份文件大小 |
| Data.Data.SizeByte | 83783 | Integer | - |
| Data.Data.ErrMsg | - | String | - |
| Data.Data.PolicyID | - | String | 备份策略 ID（如果有） |
| Data.Data.PolicyName | - | String | 备份策略名称（如果有） |
| Data.Data.Log | [2023/09/21 17:17:55.987 +08:00] [INFO] [collector.go:77] ["Full Backup success summary"] [total-ranges=18] [ranges-succeed=18] [ranges-failed=0] [backup-checksum=22.703686ms] [backup-fast-checksum=7.729801ms] [backup-total-ranges=81] [backup-total-regions=81] [total-take=4.653163136s] [Size=81819] [BackupTS=444409544014561290] [total-kv=1236] [total-kv-size=295.7kB] [average-speed=63.55kB/s] [backup-data-size(after-compressed)=81.82kB] | String | - |
| Data.Data.AccessKeyID | miniotem | String | AccessKeyID，仅当存储是 s3 类型时会有 |
| Data.Data.SecretAccessKey | miniotem | String | SecretAccessKey，仅当存储是 s3 类型时会有 |
| Data.Data.RateLimit | 128 | Integer | 每个 TiKV 执行备份任务的速度上限（单位 MiB/s） |
| Data.Data.Concurrency | 4 | Integer | 备份或恢复阶段的任务并发数 |
| Data.Data.LogFile | - | String | BR log 写入的目标文件，默认在 /tmp 目录下 |
| Data.Data.ExpireTime | - | Object | - |
| Data.Data.ExpireTime.Time | 2023-09-28T17:11:08.146+08:00 | String | 备份文件过期时间 |
| Data.Data.ExpireTime.Valid | true | Boolean | 备份文件过期时间有效标识 |
| Success | true | Boolean | 调用是否成功 |