文档

DescribeIncrementBackupList - 查看增量备份任务列表

该接口用于查看DBS增量备份任务列表。

调试

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

授权信息

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

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

请求参数

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

备份计划 ID,可通过调用 DescribeBackupPlanList 接口获取该参数的值。

dbsqdss5tmh****
PageSizeinteger

每页的记录数,取值 30、50、100。

说明 默认每页记录数为 30。
30
PageNuminteger

页码,大于等于 0 且不超过 Integer 的最大值,默认值为 0。

1
ClientTokenstring

任意字符串,用于保证请求的幂等性,防止重复提交请求。

ETnLKlblzczshOTUbOCzxxxxxxx
ShowStorageTypeboolean

是否显示存储类型,取值如下:

  • true
  • false
说明 默认 true。
true
StartTimestamplong

开始备份时间戳。

1570701361528
EndTimestamplong

结束备份时间戳。

1570701361600

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码。

200
PageNuminteger

页码。

0
RequestIdstring

请求 ID。

A5D52069-E8AA-5056-8C5C-654C3610****
ErrCodestring

错误码。

Param.NotFound
Successboolean

请求是否成功,返回值如下:

  • true:请求成功
  • false:请求失败
true
ErrMessagestring

错误信息。

The specified parameter %s value is not valid.
TotalPagesinteger

总页数。

1
TotalElementsinteger

增量备份任务总数。

1
PageSizeinteger

每页的记录数。

30
Itemsobject []

增量备份任务详情。

EndTimelong

备份结束时间戳。

1648434713000
BackupSetExpiredTimelong

备份集保留到期时间戳。

1711506719000
StartTimelong

备份开始时间戳。

1648433764000
StorageMethodstring

存储类型,返回值如下:

  • Standard:标准存储
  • IA:低频访问存储
  • Archive:归档存储
  • UNKNOWN:未知,通常是任务未完成时的状态
Standard
BackupSetJobIdstring

备份集任务 ID。

1hv5g9wk4****
BackupSetIdstring

备份集 ID。

mysql-bin.00****
BackupStatusstring

备份任务状态,返回值如下:

  • INIT:未启动
  • FILLING:备份中
  • COMPLETED:完成
  • UNCOMPLETED:未完成
FILLING
SourceEndpointIpPortstring

数据库连接地址。

172.1XX.103.1:4XXX
BackupSizelong

备份大小。

18535

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "PageNum": 0,
  "RequestId": "A5D52069-E8AA-5056-8C5C-654C3610****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 30,
  "Items": {
    "IncrementBackupFile": [
      {
        "EndTime": 1648434713000,
        "BackupSetExpiredTime": 1711506719000,
        "StartTime": 1648433764000,
        "StorageMethod": "Standard",
        "BackupSetJobId": "1hv5g9wk4****",
        "BackupSetId": "mysql-bin.00****",
        "BackupStatus": "FILLING",
        "SourceEndpointIpPort": "172.1XX.103.1:4XXX",
        "BackupSize": 18535
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
403Request.ForbiddenHave no Permissions当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)