集群备份恢复信息
接口URL
/api/v1/dms/br/policy?ClusterID=
请求方式
GET
Content-Type
application/json
认证方式
Bearer auth
请求Query参数
| 参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|---|---|---|---|---|
| ClusterID | tidb-f91e1f860d360502 | Text | 是 | cluster id |
成功响应示例
{
"Data": {
"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": "bWluaW90ZW0=",
"Cycle": 0,
"Frequency": "0,1,2,3,4",
"Time": "03:00",
"Retention": 7,
"Clusters": [
{
"ID": "tidb-f91e1f860d360502",
"Name": "haibo_test1"
}
],
"LastBackupTime": {
"Time": "2023-09-21T17:17:56.027+08:00",
"Valid": true
},
"Size": "81.82kB",
"SizeByte": 83783,
"BackupFailAlertCount": 3,
"LastLogBackupTime": {
"Time": "2023-09-21T18:15:09.37+08:00",
"Valid": true
},
"LogBackupDelay": "46s"
},
"Success": true
}
| 参数名 | 示例值 | 参数类型 | 参数描述 |
|---|---|---|---|
| Data | - | Object | |
| Data.PolicyID | p-73189323 | String | 规则 ID |
| Data.Name | weekdayBackup | String | 规则名称 |
| Data.LogBackup | true | Boolean | 是否开启日志备份 |
| Data.Destination | s3://tem/br/tidb-test?endpoint=http://172.16.6.62:9999 &force-path-style=true |
String | 备份目的地或恢复来源 |
| Data.AccessKeyID | miniotem | String | AccessKeyID，仅当存储是 s3 类型时会有 |
| Data.SecretAccessKey | bWluaW90ZW0= | String | SecretAccessKey（加密），仅当存储是 s3 类型时会有 |
| Data.Cycle | 0 | Integer | 备份周期单位，0 代表周，1 代表月 |
| Data.Frequency | 0,1,2,3,4 | String | 当备份周期为周时，可以填写0~6代表周一到周日；当周期为月时，可以填写1~31代表该月的几号 |
| Data.Time | 03:00 | String | 备份调度时间 |
| Data.Retention | 7 | Integer | 备份保留时间，单位为天 |
| Data.Clusters | - | Array | 备份策略关联所有集群 |
| Data.Clusters.ID | tidb-f91e1f860d360502 | String | 集群 ID |
| Data.Clusters.Name | haibo_test1 | String | 集群名称 |
| Data.LastBackupTime | - | Object | |
| Data.LastBackupTime.Time | 2023-09-21T17:17:56.027+08:00 | String | 最近一次备份时间 |
| Data.LastBackupTime.Valid | true | Boolean | 最近一次备份时间有效标识 |
| Data.Size | 81.82kB | String | 备份文件大小（自带单位） |
| Data.SizeByte | 83783 | Integer | 备份文件大小（单位byte） |
| Data.BackupFailAlertCount | 3 | Integer | 备份失败告警次数 |
| Data.LastLogBackupTime | - | Object | |
| Data.LastLogBackupTime.Time | 2023-09-21T18:15:09.37+08:00 | String | 上次日志备份时间 |
| Data.LastLogBackupTime.Valid | true | Boolean | 上次日志备份时间有效标识 |
| Data.LogBackupDelay | 46s | String | 日志备份延迟 |
| Success | true | Boolean | 调用是否成功 |