查询云数据库 Tair（兼容 Redis）实例的备份任务执行情况。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| kvstore:DescribeBackupTasks | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 实例 ID，可调用 DescribeInstances 接口获取。 | r-bp1zxszhcgatnx**** |
| BackupJobId | string | 否 | 备份任务 ID。 说明
如果您调用 CreateBackup 执行了手动备份，您可以将返回的备份 ID 传入，用以查询备份的进度。
| 1162**** |
| JobMode | string | 否 | Manual |
返回参数
示例
正常返回示例
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"
}
],
"AccessDeniedDetail": {
"AuthAction": "-",
"AuthPrincipalDisplayName": "-",
"AuthPrincipalOwnerId": "-",
"AuthPrincipalType": "-",
"EncodedDiagnosticMessage": "-",
"NoPermissionType": "-",
"PolicyType": "-"
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-03-26 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-11-13 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-11-06 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-07-25 | OpenAPI 描述信息更新、OpenAPI 返回结构发生变更 | 查看变更详情 |