调用DescribeIncrementBackupList API获取增量备份任务列表-数据管理 DMS-阿里云

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
dbs:DescribeIncrementBackupList	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
BackupPlanId	string	是	备份计划 ID，可通过调用 DescribeBackupPlanList 接口获取该参数的值。	dbsqdss5tmh****
PageSize	integer	否	每页的记录数，取值 30、50、100。说明默认每页记录数为 30。	30
PageNum	integer	否	页码，大于等于 0 且不超过 Integer 的最大值，默认值为 0。	1
ClientToken	string	否	任意字符串，用于保证请求的幂等性，防止重复提交请求。	ETnLKlblzczshOTUbOCzxxxxxxx
ShowStorageType	boolean	否	是否显示存储类型，取值如下： true false 说明默认 true。	true
StartTimestamp	long	否	开始备份时间戳。	1570701361528
EndTimestamp	long	否	结束备份时间戳。	1570701361600

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 状态码。	200
PageNum	integer	页码。	0
RequestId	string	请求 ID。	A5D52069-E8AA-5056-8C5C-654C3610****
ErrCode	string	错误码。	Param.NotFound
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true
ErrMessage	string	错误信息。	The specified parameter %s value is not valid.
TotalPages	integer	总页数。	1
TotalElements	integer	增量备份任务总数。	1
PageSize	integer	每页的记录数。	30
Items	array<object>	增量备份任务详情。
IncrementBackupFile	object	增量备份任务详情信息如下。
EndTime	long	备份结束时间戳。	1648434713000
BackupSetExpiredTime	long	备份集保留到期时间戳。	1711506719000
StartTime	long	备份开始时间戳。	1648433764000
StorageMethod	string	存储类型，返回值如下： Standard：标准存储 IA：低频访问存储 Archive：归档存储 UNKNOWN：未知，通常是任务未完成时的状态	Standard
BackupSetJobId	string	备份集任务 ID。	1hv5g9wk4****
BackupSetId	string	备份集 ID。	mysql-bin.00****
BackupStatus	string	备份任务状态，返回值如下： INIT：未启动 FILLING：备份中 COMPLETED：完成 UNCOMPLETED：未完成	FILLING
SourceEndpointIpPort	string	数据库连接地址。	172.1XX.103.1:4XXX
BackupSize	long	备份大小。	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	错误码	错误信息	描述
403	Request.Forbidden	Have no Permissions	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史