Retrieve DBS Incremental Backup Records via DescribeIncrementBackupList API - Data Management - Alibaba Cloud - Data Management

This operation queries the list of incremental backup tasks for DBS.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dbs:DescribeIncrementBackupList

get

*BackupPlan

acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

None

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	Yes	The backup plan ID. Call the DescribeBackupPlanList interface to get this parameter's value.	dbsqdss5tmh****
PageSize	integer	No	The number of entries per page. Valid values are 30, 50, and 100. Note The default number of entries per page is 30.	30
PageNum	integer	No	The page number. The value must be greater than or equal to 0 and less than or equal to the maximum integer value. The default value is 0.	1
ClientToken	string	No	A unique string that ensures the idempotence of the request and prevents duplicate requests.	ETnLKlblzczshOTUbOCzxxxxxxx
ShowStorageType	boolean	No	Indicates whether to display the storage class. Valid values: true false Note The default value is true.	true
StartTimestamp	integer	No	The start backup UNIX timestamp.	1570701361528
EndTimestamp	integer	No	The end backup UNIX timestamp.	1570701361600

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
PageNum	integer	The page number.	0
RequestId	string	The request ID.	A5D52069-E8AA-5056-8C5C-654C3610****
ErrCode	string	The error code.	Param.NotFound
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
TotalPages	integer	The total number of pages.	1
TotalElements	integer	The total number of incremental backup tasks.	1
PageSize	integer	The number of entries per page.	30
Items	object
IncrementBackupFile	array<object>	The incremental backup task details.
	object	The incremental backup task details are as follows.
EndTime	integer	The end backup UNIX timestamp.	1648434713000
BackupSetExpiredTime	integer	The UNIX timestamp when the backup set expires.	1711506719000
StartTime	integer	The start backup UNIX timestamp.	1648433764000
StorageMethod	string	The storage class. Valid values: Standard: Standard Storage IA: Infrequent Access Storage Archive: Archive Storage UNKNOWN: Unknown. This status usually indicates that the task is not complete.	Standard
BackupSetJobId	string	The backup set job ID.	1hv5g9wk4****
BackupSetId	string	The backup set ID.	mysql-bin.00****
BackupStatus	string	The backup task status. Valid values: INIT: Not started FILLING: Backing up COMPLETED: Completed UNCOMPLETED: Not completed	FILLING
SourceEndpointIpPort	string	The database endpoint.	172.1XX.103.1:4XXX
BackupSize	integer	The backup size.	18535
SourceEndpointInstanceType	string		rds
SourceEndpointInstanceId	string		rm-testxx
SourceEndpointRegion	string		cn-beijing
SourceEndpointHost	string		127.0.0.1
SourceEndpointPort	string		3306

Examples

Success response

JSON format

{
  "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,
        "SourceEndpointInstanceType": "rds",
        "SourceEndpointInstanceId": "rm-testxx",
        "SourceEndpointRegion": "cn-beijing",
        "SourceEndpointHost": "127.0.0.1",
        "SourceEndpointPort": "3306"
      }
    ]
  }
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.