DescribeFullBackupList API: Query Full Backup Records via OpenAPI - Data Management - Alibaba Cloud - Data Management

This operation lists full backup jobs 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 to return on each page. Valid values: 30 50 100 Default value: 30.	30
PageNum	integer	No	The page number of the page to return. The value must be an integer that is greater than or equal to 0. Default value: 0.	1
ClientToken	string	No	A token that you can use to ensure the idempotence of the request.	ETnLKlblzczshOTUbOCzxxxxxxx
ShowStorageType	boolean	No	Specifies whether to return the storage type of the backup set.	true
BackupSetId	string	No	The ID of the backup set.	1iukx5h******
StartTimestamp	integer	No	The beginning of the time range to query. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1676887100
EndTimestamp	integer	No	The end of the time range to query. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1676887128
ShowProgress	string	No	Specifies whether to return real-time information about the backup progress.	true
BackupSetStatus	string	No	The status of the backup set. You can use this parameter to filter backup sets.	finish

Response elements

Element	Type	Description	Example
	object	The response parameters.
HttpStatusCode	integer	The HTTP status code.	200
PageNum	integer	The page number.	1
RequestId	string	The request ID.	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 sets.	1
PageSize	integer	The number of entries per page.	10
Items	object	The details of the full backup sets.
FullBackupFile	array<object>	The details of the full backup sets.
	object	The details of a full backup set.
FinishTime	integer	The time when the backup task was complete. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1676887128000
BackupStatus	string	The status of the backup task. Valid values: schedule: The backup task is pending. running: The backup task is in progress. finish: The backup task is complete. stop: The backup task failed. pause: The backup task is paused.	finish
SourceEndpointIpPort	string	The endpoint that is used to connect to the database.	121.XXX.XXX.144:3306
CreateTime	integer	The time when the backup task was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1676886947000
ErrMessage	string	The error message that is returned if the backup task fails.	NULL
BackupObjects	string	The backup objects.	[{\"DBName\":\"test\"}]
EndTime	integer	The time when the backup was complete. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1676887128000
StartTime	integer	The time when the backup started. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1676887100000
BackupSetExpiredTime	integer	The time when the backup set expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1677491900000
StorageMethod	string	The storage class of the backup set. Valid values: Standard IA: infrequent access Archive UNKNOWN: This value is returned if the storage class is not obtained.	Standard
BackupSetId	string	The ID of the backup set.	1iukx5h******
BackupSize	integer	The size of the backup set in bytes.	580
SourceEndpointInstanceType	string	The instance type of the source database.	rds
SourceEndpointInstanceId	string	The ID of the source instance.	rm-testxx
SourceEndpointRegion	string	The region in which the source instance resides.	cn-beijing
SourceEndpointHost	string	The endpoint of the source database.	127.0.0.1
StorageEncryptMethod	string	The encryption method of the backup storage.	encrypted
CrossRoleName	string	The name of the RAM role that is created for cross-account backup.	ram-for-dbs
CrossAliyunId	string	The ID of the Alibaba Cloud account that is used for cross-account backup.	2xxx7778xxxxxxxxxx
SourceEndpointEnableSsl	string	Indicates whether the SSL encryption is enabled for the source database.	true
LogicalStructureBackupProgress	integer	The progress of the logical schema backup.	100
LogicalFullBackupProgress	integer	The progress of the logical full backup.	100
BackupGatewayIdentifier	string	The ID of the backup gateway.	TESTGATEWAY
SourceEndpointUserName	string	The username of the source database.	dbs_backup
SourceEndpointPort	string	The port number 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.