查询云数据库 Tair(兼容 Redis)实例的备份任务执行情况。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
kvstore:DescribeBackupTasks |
get |
*DBInstance
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID,可调用 DescribeInstances 接口获取。 |
r-bp1zxszhcgatnx**** |
| BackupJobId |
string |
否 |
备份任务 ID。 说明
如果您调用 CreateBackup 执行了手动备份,您可以将返回的备份 ID 传入,用以查询备份的进度。 |
1162**** |
| JobMode |
string |
否 |
备份模式,取值:
说明
默认返回所有备份模式的任务信息。 枚举值:
|
Manual |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| InstanceId |
string |
实例 ID。 |
r-bp1zxszhcgatnx**** |
| RequestId |
string |
请求 ID。 |
BB73740C-23E2-4392-9DA4-2660C74C**** |
| BackupJobs |
array<object> |
备份任务详情。 |
|
|
object |
|||
| StartTime |
string |
备份任务开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2021-01-05T19:24:00Z |
| Process |
string |
备份任务进度百分比(不推荐,请查看 Progress 参数)。 |
0 |
| JobMode |
string |
备份模式,返回值:
|
Manual |
| BackupJobID |
integer |
备份任务 ID。 |
29****10 |
| BackupProgressStatus |
string |
备份任务状态,返回值:
|
NoStart |
| NodeId |
string |
数据节点 ID。 |
**** |
| TaskAction |
string |
备份任务类型,返回值:
|
NormalBackupTask |
| Progress |
string |
备份的进度百分比,取值为 0-100。 |
27 |
| AccessDeniedDetail |
object |
本组参数已弃用,请忽略。 |
|
| AuthAction |
string |
说明如上。 |
- |
| AuthPrincipalDisplayName |
string |
说明如上。 |
- |
| AuthPrincipalOwnerId |
string |
说明如上。 |
- |
| AuthPrincipalType |
string |
说明如上。 |
- |
| EncodedDiagnosticMessage |
string |
说明如上。 |
- |
| NoPermissionType |
string |
说明如上。 |
- |
| PolicyType |
string |
说明如上。 |
- |
示例
正常返回示例
JSON格式
{
"InstanceId": "r-bp1zxszhcgatnx****",
"RequestId": "BB73740C-23E2-4392-9DA4-2660C74C****",
"BackupJobs": [
{
"StartTime": "2021-01-05T19:24:00Z",
"Process": "0",
"JobMode": "Manual",
"BackupJobID": 0,
"BackupProgressStatus": "NoStart",
"NodeId": "****",
"TaskAction": "NormalBackupTask",
"Progress": "27"
}
],
"AccessDeniedDetail": {
"AuthAction": "-",
"AuthPrincipalDisplayName": "-",
"AuthPrincipalOwnerId": "-",
"AuthPrincipalType": "-",
"EncodedDiagnosticMessage": "-",
"NoPermissionType": "-",
"PolicyType": "-"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。