调用DescribeIncrementBackupList接口查看DBS增量备份任务列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeIncrementBackupList

系统规定参数。取值:DescribeIncrementBackupList

BackupPlanId String dbsqdss5tmh****

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

PageSize Integer 30

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

说明 默认每页记录数为30。
PageNum Integer 1

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

RegionId String cn-hangzhou

地域ID,可通过调用DescribeRegions接口获取该参数的值。

ClientToken String ETnLKlblzczshOTUbOCzxxxxxxx

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

ShowStorageType Boolean true

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

  • true
  • false
说明 默认true。
StartTimestamp Long 1570701361528

开始备份时间。

EndTimestamp Long 1570701361600

结束备份时间。

返回数据

名称 类型 示例值 描述
HttpStatusCode Integer 200

HTTP状态码。

PageNum Integer 0

页码。

RequestId String A5D52069-E8AA-5056-8C5C-654C3610****

请求ID。

ErrCode String Param.NotFound

错误码。

Success Boolean true

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

  • true:请求成功
  • false:请求失败
ErrMessage String The specified parameter %s value is not valid.

错误信息。

TotalPages Integer 1

总页数。

TotalElements Integer 1

增量备份任务总数。

PageSize Integer 30

每页的记录数。

Items Array of IncrementBackupFile

增量备份任务详情。

IncrementBackupFile
EndTime Long 1648434713000

备份结束时间戳。

BackupSetExpiredTime Long 1711506719000

备份集保留到期时间戳。

StartTime Long 1648433764000

备份开始时间戳。

StorageMethod String Standard

存储类型,返回值如下:

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

备份集任务ID。

BackupSetId String mysql-bin.00****

备份集ID。

BackupStatus String FILLING

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

  • INIT:未启动
  • FILLING:备份中
  • COMPLETED:完成
  • UNCOMPLETED:未完成
SourceEndpointIpPort String 172.1XX.103.1:4XXX

数据库连接地址。

BackupSize Long 18535

备份大小。

示例

请求示例

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=DescribeIncrementBackupList
&BackupPlanId=dbsqdss5tmh****
&PageSize=30
&PageNum=1
&ClientToken=ETnLKlblzczshOTUbOCzxxxxxxx
&ShowStorageType=true
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeIncrementBackupListResponse>
    <RequestId>A5D52069-E8AA-5056-8C5C-654C3610****</RequestId>
    <PageSize>30</PageSize>
    <PageNum>0</PageNum>
    <HttpStatusCode>200</HttpStatusCode>
    <TotalElements>1</TotalElements>
    <TotalPages>1</TotalPages>
    <Items>
        <IncrementBackupFile>
            <SourceEndpointIpPort>172.1XX.103.1:4XXX</SourceEndpointIpPort>
            <EndTime>1648434713000</EndTime>
            <BackupSetJobId>1hv5g9wk4****</BackupSetJobId>
            <BackupSize>18535</BackupSize>
            <StartTime>1648433764000</StartTime>
            <BackupSetExpiredTime>1711506719000</BackupSetExpiredTime>
            <BackupSetId>mysql-bin.00****</BackupSetId>
            <BackupStatus>FILLING</BackupStatus>
        </IncrementBackupFile>
    </Items>
    <Success>true</Success>
</DescribeIncrementBackupListResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "A5D52069-E8AA-5056-8C5C-654C3610****",
  "PageSize" : 30,
  "PageNum" : 0,
  "HttpStatusCode" : 200,
  "TotalElements" : 1,
  "TotalPages" : 1,
  "Items" : {
    "IncrementBackupFile" : [ {
      "SourceEndpointIpPort" : "172.1XX.103.1:4XXX",
      "EndTime" : 1648434713000,
      "BackupSetJobId" : "1hv5g9wk4****",
      "BackupSize" : 18535,
      "StartTime" : 1648433764000,
      "BackupSetExpiredTime" : 1711506719000,
      "BackupSetId" : "mysql-bin.00****",
      "BackupStatus" : "FILLING"
    } ]
  },
  "Success" : true
}

错误码

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