Queries the list of incremental DBS backup tasks.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeIncrementBackupList

The parameter specified by the system. Value: DescribeIncrementBackupList.

BackupPlanId String Yes dbs1hvb0wwXXXXX

The ID of the backup plan.

PageSize Integer Optional 30

The number of records on each page. Valid values:

  • 30
  • 50
  • 100
Note Default value: 30.
PageNum Integer Optional 1

The number of the page to return. Valid values: any non-zero positive Integer. Default value: 0.

RegionId String No cn-hangzhou

Region ID, call DescribeRegions to view the regions supported by DBS.

ClientToken String No ETnLKlblzczshOTUbOCzxxxxxxx

The client token that is used to ensure the idempotence of the request.

ShowStorageType Boolean No true

Specifies whether to display the storage type.

Note Default value: true.

Response parameters

Parameter Type Example Description
ErrCode String Param.NotFound

The error code.

ErrMessage String The specified parameter %s value is not valid.

The error message.

HttpStatusCode Integer 200

The HTTP status code.

Items Array of IncrementBackupFile

The details of incremental backup tasks.

IncrementBackupFile
BackupSetExpiredTime Long 1554560477000

The timestamp when the backup set expires. Value: 1554560477000.

BackupSetId String dbs1XXXXX

The ID of the backup set.

BackupSize Long 100

The size of the backup.

BackupStatus String INIT

The status of the backup tasks to query. Valid values:

  • INIT: Not started
  • FILLING: backup in progress
  • COMPLETED: COMPLETED
  • UNCOMPLETED
EndTime Long 1554560477000

The timestamp of the backup end. Value: 1554560477000.

SourceEndpointIpPort String 100.X.X.10:33204

The endpoint used to connect to the database.

StartTime Long 1554560477000

The start time of the backup. Value: 1554560477000.

StorageMethod String Standard

The storage type. Valid values:

  • Standard
  • IA: IA
  • Archive
  • UNKNOWN: The status of the UNKNOWN task.
PageNum Integer 1

The page number of the page to be returned.

PageSize Integer 30

The number of records per page.

RequestId String E161C346-5BE3-4E37-BCE8-6A86FB12E132

The ID of the request.

Success Boolean true

Indicates whether the request succeeded.

TotalElements Integer 1

The total number of incremental backup tasks.

TotalPages Integer 1

The total number of returned pages.

Examples

Sample requests

http(s)://dbs-api.cn-hangzhou.aliyuncs.com/? Action=DescribeIncrementBackupList
&BackupPlanId=dbs1hvb0wwXXXXX
&<Common request parameters>

Sample success responses

XML format

<DescribeIncrementBackupListResponse>
  <RequestId>E161C346-5BE3-4E37-BCE8-6A86FB12E132</RequestId>
  <PageSize>30</PageSize>
  <PageNum>0</PageNum>
  <HttpStatusCode>200</HttpStatusCode>
  <TotalElements>1</TotalElements>
  <TotalPages>1</TotalPages>
  <Items>
        <IncrementBackupFile>
              <SourceEndpointIpPort>100.X.X.10:33204</SourceEndpointIpPort>
              <StorageMethod>Standard</StorageMethod>
              <EndTime>1583742490000</EndTime>
              <BackupSize>4908210</BackupSize>
              <StartTime>1583721876000</StartTime>
              <BackupSetExpiredTime>1646814495000</BackupSetExpiredTime>
              <BackupSetId>mysql-bin.000003</BackupSetId>
              <BackupStatus>FILLING</BackupStatus>
        </IncrementBackupFile>
  </Items>
  <Success>true</Success>
</DescribeIncrementBackupListResponse>

JSON format

{
	"RequestId": "E161C346-5BE3-4E37-BCE8-6A86FB12E132",
	"PageSize": 30,
	"PageNum": 0,
	"HttpStatusCode": 200,
	"TotalElements": 1,
	"TotalPages": 1,
	"Items": {
		"IncrementBackupFile": [
			{
				"SourceEndpointIpPort": "100.X.X.10:33204",
				"StorageMethod": "Standard",
				"EndTime": 1583742490000,
				"BackupSize": 4908210,
				"StartTime": 1583721876000,
				"BackupSetExpiredTime": 1646814495000,
				"BackupSetId": "mysql-bin.000003",
				"BackupStatus": "FILLING"
			}
		]
	},
	"Success": true
}

Error codes

For a list of error codes, visit the API Error Center.