文档

DescribeBackupTasks - 查询备份任务执行情况

更新时间:

查询Redis实例的备份任务执行情况。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:DescribeBackupTasksRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID,可调用 DescribeInstances 接口获取。

r-bp1zxszhcgatnx****
BackupJobIdstring

备份任务 ID。

说明 如果您调用 CreateBackup 执行了手动备份,您可以将返回的备份 ID 传入,用以查询备份的进度。
1162****
JobModestring

备份模式,取值:

  • Automated:系统自动备份,您可以调用 DescribeBackupPolicy 查询自动备份策略。
  • Manual:手动备份
说明 默认返回所有备份模式的任务信息。
Manual

返回参数

名称类型描述示例值
object
InstanceIdstring

实例 ID。

r-bp1zxszhcgatnx****
RequestIdstring

请求 ID。

BB73740C-23E2-4392-9DA4-2660C74C****
BackupJobsobject []

备份任务详情。

StartTimestring

备份任务开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2021-01-05T19:24:00Z
Processstring

备份任务进度百分比。

0
JobModestring

备份模式,返回值:

  • Automated:系统自动备份。
  • Manual:手动备份。
Manual
BackupJobIDinteger

备份任务 ID。

29****10
BackupProgressStatusstring

备份任务状态,返回值:

  • NoStart:未开始。
  • Preparing:准备中。
  • Waiting:等待中。
  • Uploading:上传中
  • Checking:检查中。
  • Finished:已完成。
NoStart
NodeIdstring

数据节点 ID。

****
TaskActionstring

备份任务类型,返回值:

  • TempBackupTask:临时备份任务,即手动备份。
  • NormalBackupTask:普通备份任务,即自动备份。
NormalBackupTask
AccessDeniedDetailobject

本组参数已弃用,请忽略。

AuthActionstring

说明如上。

_
AuthPrincipalDisplayNamestring

说明如上。

_
AuthPrincipalOwnerIdstring

说明如上。

_
AuthPrincipalTypestring

说明如上。

_
EncodedDiagnosticMessagestring

说明如上。

_
NoPermissionTypestring

说明如上。

_
PolicyTypestring

说明如上。

_

示例

正常返回示例

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": "_"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-11-13OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-11-06OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-07-25OpenAPI 描述信息更新、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈