DescribeFullBackupList - Data Management - Alibaba Cloud Documentation Center

Queries the list of full backup jobs in Database Backup Service (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:DescribeFullBackupList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	Yes	The ID of the backup schedule.	dbsr179qz******
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 page number to return. The value must be a number that is greater than or equal to 0. The value cannot exceed the maximum value of an integer. Default value: 0.	1
ClientToken	string	No	A client token that is used to ensure the idempotence of the request. This prevents the system from processing duplicate requests.	ETnLKlblzczshOTUbOCzxxxxxxx
ShowStorageType	boolean	No	Specifies whether to show the storage class.	true
BackupSetId	string	No	The ID of the backup set.	1iukx5h******
StartTimestamp	integer	No	The backup start time.	1676887100
EndTimestamp	integer	No	The end of the time range to query. This is a UNIX timestamp.	1676887128

Response elements

Element	Type	Description	Example
	object	The response parameters.
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 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 returned.	1
TotalElements	integer	The total number of full backup jobs.	1
PageSize	integer	The number of entries returned per page.	10
Items	object
FullBackupFile	array<object>	The details of the full backup job.
	object	The details of the full backup job.
FinishTime	integer	The UNIX timestamp that indicates when the task ended.	1676887128000
BackupStatus	string	The status of the backup job. Valid values: schedule: The job is being initialized. running: The job is running. finish: The job is complete. stop: The job failed. pause: The job is paused.	finish
SourceEndpointIpPort	string	The database endpoint.	121.XXX.XXX.144:3306
CreateTime	integer	The UNIX timestamp that indicates when the task was created.	1676886947000
ErrMessage	string	The error message.	NULL
BackupObjects	string	The backup objects.	[{\"DBName\":\"test\"}]
EndTime	integer	The UNIX timestamp that indicates when the backup ended.	1676887128000
StartTime	integer	The UNIX timestamp that indicates when the backup started.	1676887100000
BackupSetExpiredTime	integer	The UNIX timestamp that indicates when the backup set expires.	1677491900000
StorageMethod	string	The storage class. Valid values: Standard: Standard IA: Infrequent Access Archive: Archive Storage UNKNOWN: Unknown. This value is typically returned when the task is not complete.	Standard
BackupSetId	string	The ID of the backup set.	1iukx5h******
BackupSize	integer	The backup size in bytes.	580

Examples

Success response

JSON format

{
  "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": 1676887128000,
        "BackupStatus": "finish",
        "SourceEndpointIpPort": "121.XXX.XXX.144:3306",
        "CreateTime": 1676886947000,
        "ErrMessage": "NULL",
        "BackupObjects": "[{\\\"DBName\\\":\\\"test\\\"}]",
        "EndTime": 1676887128000,
        "StartTime": 1676887100000,
        "BackupSetExpiredTime": 1677491900000,
        "StorageMethod": "Standard",
        "BackupSetId": "1iukx5h******",
        "BackupSize": 580
      }
    ]
  }
}

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.