DescribeFullBackupList - Database Backup - Alibaba Cloud Documentation Center

Queries full backup tasks.

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	Association operation
dbs:DescribeFullBackupList	Read	All Resources	none	none

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	Yes	The ID of the backup schedule.	1ibh2XXXXXXX
PageSize	integer	No	The number of entries to return on each page. Valid values: 30 50 100 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. Default value: true.	true
BackupSetId	string	No	The ID of the backup set.	1ibh2XXXXXXX
StartTimestamp	long	No	The beginning of the time range to query.	1609430400
EndTimestamp	long	No	The end of the time range to query.	1638288000

Response parameters

Parameter	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
PageNum	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	636BC118-6080-4119-A6B5-C199CEC1037D
ErrCode	string	The error code.	Param.NotFound
Success	boolean	Indicates whether the request is successful.	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 full backup tasks.	1
PageSize	integer	The number of entries returned on each page.	10
Items	array	The details of full backup tasks.
	object
FinishTime	long	The timestamp when the full backup task ended, such as 1554560477000.	1583741466000
BackupStatus	string	The status of the backup task. Valid values: schedule: The backup task is being initialized. running: The backup task is running. finish: The backup task is complete. stop: The backup task failed. pause: The backup task is stopped.	finish
SourceEndpointIpPort	string	The endpoint that is used to connect to the database.	100.X.X.10:33204
CreateTime	long	The timestamp when the full backup task started, such as 1554560477000.	1583740896000
ErrMessage	string	The error message.	NULL
BackupObjects	string	The backup object.	[{\"DBName\":\"test\"}]
EndTime	long	The end time of the backup task, such as 1554560477000.	1583741465000
StartTime	long	The start time of the backup task, such as 1554560477000.	1583741439000
BackupSetExpiredTime	long	The point in time when the backup set expires, such as 1554560477000.	1554560477000
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
BackupSetId	string	The ID of the backup set.	1ibh2f5uXXXX
BackupSize	long	The size of the backup set.	151

Examples

Sample success responses

JSONformat

{
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "636BC118-6080-4119-A6B5-C199CEC1037D",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 10,
  "Items": {
    "FullBackupFile": [
      {
        "FinishTime": 1583741466000,
        "BackupStatus": "finish",
        "SourceEndpointIpPort": "100.X.X.10:33204",
        "CreateTime": 1583740896000,
        "ErrMessage": "NULL",
        "BackupObjects": "[{\\\"DBName\\\":\\\"test\\\"}]",
        "EndTime": 1583741465000,
        "StartTime": 1583741439000,
        "BackupSetExpiredTime": 1554560477000,
        "StorageMethod": "Standard",
        "BackupSetId": "1ibh2f5uXXXX",
        "BackupSize": 151
      }
    ]
  }
}

Error codes

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