DescribeFullBackupList-阿里云帮助中心

Queries the list of full backup tasks in Database Backup (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

*BackupPlan

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

None

Request parameters

Parameter	Type	Required	Description	Example
BackupPlanId	string	Yes	The ID of the backup plan.	dbsr179qz******
PageSize	integer	No	The number of entries per page. Valid values: 30 50 100 Default value: 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 value of the Integer data type. Default value: 0.	1
ClientToken	string	No	The client token that is used to ensure request idempotence and prevent duplicate submissions.	ETnLKlblzczshOTUbOCzxxxxxxx
ShowStorageType	boolean	No	Specifies whether to display the storage type.	true
BackupSetId	string	No	The ID of the backup set.	1iukx5h******
StartTimestamp	integer	No	The start time of the backup.	1676887100
EndTimestamp	integer	No	The end time of the backup.	1676887128
ShowProgress	string	No	Specifies whether to display the backup progress.	true
BackupSetStatus	string	No	The status of the backup set.	finish

Response elements

Element	Type	Description	Example
	object	The response parameters are as follows.
HttpStatusCode	integer	The HTTP status code.	200
PageNum	integer	The page number.	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.	1
TotalElements	integer	The total number of full backup tasks.	1
PageSize	integer	The number of entries per page.	10
Items	object
FullBackupFile	array<object>	The details of the full backup tasks.
	object	The details of the full backup tasks.
FinishTime	integer	The timestamp when the task ended.	1676887128000
BackupStatus	string	The status of the backup task. Valid values: schedule: Initializing. running: Running. finish: Completed. stop: Failed. pause: Paused.	finish
SourceEndpointIpPort	string	The database connection address.	121.XXX.XXX.144:3306
CreateTime	integer	The timestamp when the task started.	1676886947000
ErrMessage	string	The error message.	NULL
BackupObjects	string	The backup objects.	[{\"DBName\":\"test\"}]
EndTime	integer	The timestamp when the backup ended.	1676887128000
StartTime	integer	The start time of the backup. The value is a UNIX timestamp in milliseconds.	1676887100000
BackupSetExpiredTime	integer	The timestamp when the retention period of the backup set expires.	1677491900000
StorageMethod	string	The storage type. Valid values: Standard: Standard storage. IA: Infrequent Access (IA) storage. Archive: Archive storage. UNKNOWN: Unknown. This value is typically returned when the task is not completed.	Standard
BackupSetId	string	The ID of the backup set.	1iukx5h******
BackupSize	integer	The size of the backup.	580
SourceEndpointInstanceType	string	The instance type of the source database.	rds
SourceEndpointInstanceId	string	The ID of the source database instance.	rm-testxx
SourceEndpointRegion	string	The region where the source database resides.	cn-beijing
SourceEndpointHost	string	The database connection address of the source database for backup.	127.0.0.1
StorageEncryptMethod	string	The encryption method for the backup storage.	encrypted
CrossRoleName	string	The name of the Resource Access Management (RAM) role for cross-account backup.	ram-for-dbs
CrossAliyunId	string	The ID of the Alibaba Cloud account for cross-account backup.	2xxx7778xxxxxxxxxx
SourceEndpointEnableSsl	string	Indicates whether a Secure Sockets Layer (SSL) secure connection is enabled for the source database.	true
LogicalStructureBackupProgress	integer	The progress of the logical structure backup.	100
LogicalFullBackupProgress	integer	The progress of the logical full backup.	100
BackupGatewayIdentifier	string	The unique identifier of the backup gateway.	TESTGATEWAY
SourceEndpointUserName	string	The account of the source database.	dbs_backup
SourceEndpointPort	string	The port of the source database.	3306

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,
        "SourceEndpointInstanceType": "rds",
        "SourceEndpointInstanceId": "rm-testxx",
        "SourceEndpointRegion": "cn-beijing",
        "SourceEndpointHost": "127.0.0.1",
        "StorageEncryptMethod": "encrypted",
        "CrossRoleName": "ram-for-dbs",
        "CrossAliyunId": "2xxx7778xxxxxxxxxx",
        "SourceEndpointEnableSsl": "true",
        "LogicalStructureBackupProgress": 100,
        "LogicalFullBackupProgress": 100,
        "BackupGatewayIdentifier": "TESTGATEWAY",
        "SourceEndpointUserName": "dbs_backup",
        "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.