备份策略列表
接口URL
api/v1/dms/br/policies
请求方式
GET
Content-Type
application/json
认证方式
Bearer auth
成功响应示例
{
"Data": {
"Policies": [
{
"PolicyID": "p-73189323",
"Name": "weekdayBackup",
"LogBackup": true,
"Destination": "s3://tem/br/tidb-test?endpoint=http://172.16.6.62:9999&force-path-style=true",
"AccessKeyID": "miniotem",
"SecretAccessKey": "miniotem",
"Cycle": 0,
"Frequency": "0,1,2,3,4",
"Time": "02:00",
"Retention": 7,
"Concurrency": 2,
"LogFile": "/tmp/weekdayBackupV2.log",
"RateLimit": 1,
"Clusters": [
{
"ID": "tidb-f91e1f860d360502",
"Name": "haibo_test1"
}
]
}
]
},
"Success": true
}
参数名 | 示例值 | 参数类型 | 参数描述 |
---|---|---|---|
Data | - | Object | |
Data.Policies | - | Array | |
Data.Policies.PolicyID | p-73189323 | String | 策略 ID |
Data.Policies.Name | weekdayBackup | String | 策略名称 |
Data.Policies.LogBackup | true | Boolean | 是否开启日志备份 |
Data.Policies.Destination | s3://tem/br/tidb-test?endpoint= http://172.16.6.62:9999 &force-path-style=true |
String | 可以参考样例填写 s3 路径,或者如果是本地 nfs 挂载路径可以填写如 local:///tmp/backup |
Data.Policies.AccessKeyID | miniotem | String | 仅当存储类型是 s3 时需要 |
Data.Policies.SecretAccessKey | miniotem | String | 仅当存储类型是 s3 时需要 |
Data.Policies.Cycle | 0 | Integer | 备份周期单位,0 代表周,1 代表月 |
Data.Policies.Frequency | 0,1,2,3,4 | String | 当备份周期为周时,可以填写0~6代表周一到周日;当周期为月时,可以填写1~31代表该月的几号 |
Data.Policies.Time | 02:00 | String | 备份调度时间 |
Data.Policies.Retention | 7 | Integer | 备份保留时间,单位为天 |
Data.Policies.Clusters | - | Array | |
Data.Policies.Clusters.ID | tidb-f91e1f860d360502 | String | 集群 ID |
Data.Policies.Clusters.Name | haibo_test1 | String | 集群名称 |
Success | true | Boolean | 调用是否成功 |