ListBackupJobs - 获取备份任务列表

更新时间:

获取备份任务列表

调试

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

授权信息

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

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

请求参数

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

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-xxxxxxxxx
BackupModestring

备份模式。取值说明:

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

如果不传,则返回所有。

Automated

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

ABB39CC3-4488-4857-905D-2E4A051D0521
Itemsarray<object>

备份任务列表。

BackupJobobject
BackupJobIdstring

备份任务 ID。

123
BackupModestring

备份模式。取值说明:

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

备份集状态。取值说明:

  • Success:成功。
  • Failure:失败。
Success
Processstring

备份任务进度百分比。

50%
StartTimestring

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

2022-08-11T09:26:43Z

示例

正常返回示例

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Items": {
    "BackupJob": [
      {
        "BackupJobId": "123",
        "BackupMode": "Automated",
        "BackupStatus": "Success",
        "Process": "50%",
        "StartTime": "2022-08-11T09:26:43Z"
      }
    ]
  }
}

错误码

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