All Products
Search
Document Center

Database Backup:DescribeIncrementBackupList

Last Updated:Nov 09, 2022

Queries incremental backup tasks.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
  • Condition keyword: refers to the condition keyword defined by the cloud product itself.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operateaccess levelResource typeconditional keywordAssociation operation
dbs:DescribeIncrementBackupListRead
    All resources
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
BackupPlanIdstringYes

The ID of the backup schedule. You can call the DescribeBackupPlanList operation to obtain the ID of the backup schedule.

dbsqdss5tmh****
PageSizeintegerNo

The number of entries to return on each page. Valid values: 30, 50, and 100.

NoteDefault value: 30.
30
PageNumintegerNo

The number of the page to return. The value must be a positive integer. Default value: 0.

1
ClientTokenstringNo

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

ETnLKlblzczshOTUbOCzxxxxxxx
ShowStorageTypebooleanNo

Specifies whether to return the storage class. Valid values:

  • true
  • false
NoteDefault value: true.
true
StartTimestamplongNo

The beginning of the time range to query.

1570701361528
EndTimestamplongNo

The end of the time range to query.

1570701361600

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

200
PageNuminteger

The page number of the returned page.

0
RequestIdstring

The ID of the request.

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

The error code.

Param.NotFound
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
true
ErrMessagestring

The error message.

The specified parameter %s value is not valid.
TotalPagesinteger

The total number of returned pages.

1
TotalElementsinteger

The total number of incremental backup tasks.

1
PageSizeinteger

The number of entries returned on each page.

30
Itemsarray

The details of incremental backup tasks.

object

The details of the incremental backup task.

EndTimelong

The end time of the incremental backup task.

1648434713000
BackupSetExpiredTimelong

The point in time when the backup set expires.

1711506719000
StartTimelong

The start time of the incremental backup task.

1648433764000
StorageMethodstring

The storage class of the backup data. Valid values:

  • Standard: The storage class is Standard.
  • IA: The storage class is Infrequent Access (IA).
  • Archive: The storage class is Archive.
  • UNKNOWN: The storage class is unknown. This value is returned because the task is not complete.
Standard
BackupSetJobIdstring

The ID of the incremental backup task.

1hv5g9wk4****
BackupSetIdstring

The ID of the backup set.

mysql-bin.00****
BackupStatusstring

The status of the incremental backup task. Valid values:

  • INIT: The incremental backup task is not started.
  • FILLING: The incremental backup task is in progress.
  • COMPLETED: The incremental backup task is complete.
  • UNCOMPLETED: The incremental backup task is not complete.
FILLING
SourceEndpointIpPortstring

The endpoint that is used to connect to the database.

172.1XX.103.1:4XXX
BackupSizelong

The size of the backup set.

18535

Example

Normal return example

JSONFormat

{
  "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": [
    {
      "EndTime": 1648434713000,
      "BackupSetExpiredTime": 1711506719000,
      "StartTime": 1648433764000,
      "StorageMethod": "Standard",
      "BackupSetJobId": "1hv5g9wk4****",
      "BackupSetId": "mysql-bin.00****",
      "BackupStatus": "FILLING",
      "SourceEndpointIpPort": "172.1XX.103.1:4XXX",
      "BackupSize": 18535
    }
  ]
}

Error codes

For a list of error codes, visit the API error center.