首页 云数据库 RDS 开发参考 API参考 API目录 备份 DescribeBackupTasks - 查询实例的备份任务列表

DescribeBackupTasks - 查询实例的备份任务列表

更新时间: 2023-11-29 12:10:21

该接口用于查询RDS实例的备份任务列表。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

调试

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

调试

授权信息

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

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

请求参数

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

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。

ETnLKlblzczshOTUbOCz****
Flagstring

备用参数。

DBInstanceIdstring

实例ID。可调用DescribeDBInstances获取。

rm-uf6wjk5****
BackupJobIdinteger

备份任务ID。

476****
BackupModestring

备份模式,取值:

  • Automated:系统自动备份
  • Manual:手动备份
Automated
BackupJobStatusstring

备份任务状态,取值:

  • NoStart:未开始
  • Progressing:正在进行中

默认为所有状态。

NoStart

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求ID。

90496720-2319-42A8-87CD-FCE4DF95EBED
Itemsobject []

备份任务列表。

Processstring

任务进度百分比。

25
BackupJobIdstring

备份任务ID。

476****
BackupStatusstring

备份任务状态。取值:

  • NoStart:未开始
  • Checking:检查备份
  • Preparing:准备备份
  • Waiting:等待备份
  • Uploading:上传备份
  • Finished:完成备份
  • Failed:备份失败
说明 有任务执行时才会返回本参数。
NoStart
JobModestring

备份模式,取值:

  • Automated:系统自动备份
  • Manual:手动备份
Automated
BackupProgressStatusstring

备份程序状态。取值:

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

任务生成的备份集ID。

说明 当返回参数BackupStatusFinished后,传入请求参数BackupJobId才能够查看到备份集ID。
34665****
TaskActionstring

任务类型,取值:

  • TempBackupTask:临时备份任务
  • NormalBackupTask:普通备份任务
NormalBackupTask

示例

正常返回示例

JSON格式

{
  "RequestId": "90496720-2319-42A8-87CD-FCE4DF95EBED",
  "Items": {
    "BackupJob": [
      {
        "Process": "25",
        "BackupJobId": "476****",
        "BackupStatus": "NoStart",
        "JobMode": "Automated",
        "BackupProgressStatus": "NoStart",
        "BackupId": "34665****",
        "TaskAction": "NormalBackupTask"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InternalFailureInternal failure, retry later.请求失败,请稍后重试。
400InvalidParameter.OwnerAccountThe specified parameter OwnerAccount is not valid.操作失败,参数OwnerAccount不合法,请检查。
400ReadDBInstanceNotSupportThe operation is not permitted due to type of the instance.只读实例不允许执行该操作。
400InvalidParameters.FormatSpecified parameter is not valid操作失败,指定的参数格式不合法。
404InvalidDBInstanceName.NotFoundInvalid DBInstanceId NotFound.数据库实例ID不存在,请检查。
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.指定的实例不存在指定的实例被删除或者实例不支持当前操作。

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

阿里云首页 云数据库 RDS 相关技术圈