备份集群
全量备份集群，目的地可选 S3 或者 nfs 挂载的路径
接口URL
/api/v1/dms/br/backup
请求方式
POST
Content-Type
application/json
认证方式
Bearer auth
请求Body参数
{
"AccessKeyID": "miniotem",
"ClusterID": "tidb-c020f15067007531",
"Destination": "s3://tem/br/xinyi-test/10261427?endpoint=http://172.16.6.62:9999&force-path-style=true",
"Name": "xinyi-test-fullbackup-10261427",
"Retention": 7,
"SecretAccessKey": "miniotem",
"Concurrency": 2,
"LogFile": "/tmp/xinyi-test-br-10261427.log",
"RateLimit": 1
}
| 参数名 | 示例值 | 参数类型 | 是否必填 |
参数描述 |
|---|---|---|---|---|
| AccessKeyID | miniotem | String | 否 | 仅当存储类型是 s3 时需要 |
| ClusterID | tidb-c020f15067007531 | String | 否 | - |
| Destination | s3://tem/br/xinyi-test/10261427? endpoint=http://172.16.6.62:9999& force-path-style=true |
String | 否 | 可以参考样例填写 s3 路径，或者如果是本地 nfs 挂载路径可以填写如 local:///tmp/backup |
| Name | xinyi-test-fullbackup-10261427 | String | 否 | - |
| Retention | 7 | Integer | 否 | 备份保留时长，单位为天 |
| SecretAccessKey | miniotem | String | 否 | 仅当存储类型是 s3 时需要 |
| Concurrency | 2 | Integer | 是 | 备份或恢复阶段的任务并发数 |
| LogFile | /tmp/xinyi-test-br-10261427.log | String | 是 | BR log 写入的目标文件，默认在 /tmp 目录下 |
| RateLimit | 1 | Integer | 是 | 每个 TiKV 执行备份任务的速度上限（单位 MiB/s） |
成功响应示例
{
"Data": {
"BRTaskID": "b-82959789",
"Storage": "s3://tem/br/tidb-test/0921?endpoint=http://172.16.6.62:9999&force-path-style=true"
},
"Success": true
}
| 参数名 | 示例值 | 参数类型 | 参数描述 |
|---|---|---|---|
| code | - | String | |
| data.BRTaskID | b-xxx | String | 备份任务 ID |
| data.Storage | s3://bucket/path?endpoint=s3. amazonaws.com&force-path-style=true |
String | 备份目的地 |
| message | - | String | |
| success | - | Boolean |