调用DescribeBackupTasks查询备份任务列表_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

查询集群的备份任务详情。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
polardb:DescribeBackupTasks	Read	dbcluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}	无	无

请求参数

名称	类型	必填	描述	示例值
DBClusterId	string	是	集群 ID。	pc-***************
BackupJobId	string	否	备份任务 ID。	11111111
BackupMode	string	否	备份模式，取值范围如下： Automated：系统自动备份 Manual：手动备份	Manual

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	FA8C1EF1-E3D4-44D7-B809-823187******
Items	object []	备份任务详情。
StartTime	string	备份任务开始时间（UTC），格式为`YYYY-MM-DDThh:mm:ssZ`。	2020-08-08T07:24:01Z
Process	string	备份任务进度百分比。	0
BackupJobId	string	备份任务 ID。	11111111
JobMode	string	备份模式，取值范围如下： Automated：系统自动备份 Manual：手动备份	Automated
BackupProgressStatus	string	备份任务状态，取值范围如下： NoStart：未开始 Preparing：准备中 Waiting：等待中 Uploading：上传中 Checking：检查中 Finished：已完成	NoStart
TaskAction	string	备份任务类型，取值范围如下： TempBackupTask：临时备份任务 NormalBackupTask：普通备份任务	NormalBackupTask

示例

正常返回示例

JSON格式

{
  "RequestId": "FA8C1EF1-E3D4-44D7-B809-823187******",
  "Items": {
    "BackupJob": [
      {
        "StartTime": "2020-08-08T07:24:01Z",
        "Process": "0",
        "BackupJobId": "11111111",
        "JobMode": "Automated",
        "BackupProgressStatus": "NoStart",
        "TaskAction": "NormalBackupTask"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	当前的记录中不存在提供的 DBClusterId。
400	InvalidBackupMode.Malformed	The specified parameter BackupMode is not valid.	指定的参数BackupMode无效

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