DescribeIncrementBackupList - Database Backup

Queries incremental backup tasks.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

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 Key: the condition key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
dbs:DescribeIncrementBackupList	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	Yes	The ID of the backup schedule. You can call the DescribeBackupPlanList operation to obtain the ID of the backup schedule.	dbsqdss5tmh****
PageSize	integer	No	The number of entries to return on each page. Valid values: 30, 50, and 100. Note Default value: 30.	30
PageNum	integer	No	The number of the page to return. The value must be a positive integer. Default value: 0.	1
ClientToken	string	No	The client token that is used to ensure the idempotence of the request.	ETnLKlblzczshOTUbOCzxxxxxxx
ShowStorageType	boolean	No	Specifies whether to return the storage class. Valid values: true false Note Default value: true.	true
StartTimestamp	long	No	The beginning of the time range to query.	1570701361528
EndTimestamp	long	No	The end of the time range to query.	1570701361600

Response parameters

Parameter	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
PageNum	integer	The page number of the returned page.	0
RequestId	string	The ID of the request.	A5D52069-E8AA-5056-8C5C-654C3610****
ErrCode	string	The error code.	Param.NotFound
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
TotalPages	integer	The total number of returned pages.	1
TotalElements	integer	The total number of incremental backup tasks.	1
PageSize	integer	The number of entries returned on each page.	30
Items	array<object>	The details of incremental backup tasks.
IncrementBackupFile	object	The details of the incremental backup task.
EndTime	long	The end time of the incremental backup task.	1648434713000
BackupSetExpiredTime	long	The point in time when the backup set expires.	1711506719000
StartTime	long	The start time of the incremental backup task.	1648433764000
StorageMethod	string	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
BackupSetJobId	string	The ID of the incremental backup task.	1hv5g9wk4****
BackupSetId	string	The ID of the backup set.	mysql-bin.00****
BackupStatus	string	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
SourceEndpointIpPort	string	The endpoint that is used to connect to the database.	172.1XX.103.1:4XXX
BackupSize	long	The size of the backup set.	18535

Examples

Sample success responses

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": {
    "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
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
403	Request.Forbidden	Have no Permissions

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history