ListBackupRecord - Security Center - Alibaba Cloud Documentation Center

Queries backup records.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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	Associated operation
yundun-sas:ListBackupRecord	list	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
MachineRemark	string	No	The information that you want to use to identify the servers protected by the anti-ransomware policy. You can enter the IP address or ID of a server.	192.168.XX.XX
StatusList	array	No	The backup task status. Valid values: BACKUP_COMPLETE: The backup task is successful. BACKUP_FAILED: The backup task failed. PARTIAL_COMPLETE: The backup task is partially successful.
	string	No	The details of the backup task status.	["BACKUP_COMPLETE"]
BackupStartTime	long	No	The timestamp when the backup task started. Unit: milliseconds.	1699514211000
BackupEndTime	long	No	The timestamp when the backup task ended. Unit: milliseconds.	1699600611000
CurrentPage	integer	No	The page number. Default value: 1. Pages start from page 1.	1
PageSize	integer	No	The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page. Note We recommend that you do not leave this parameter empty.	20

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID, which is used to locate and troubleshoot issues.	3956048F-9D73-5EDB-834B-4827BB48****
BackupRecordList	array<object>	The details of the backup record.
BackupRecord	object
Uuid	string	The UUID of the server whose data is backed up based on the anti-ransomware policy.	b93cccb9-f19f-4886-97fe-47df26ba****
ClientId	string	The ID of the anti-ransomware agent.	c-0002bgagelj3d2sc****
BackupPlanId	string	The backup plan ID.	plan-000c4tt43nolmx96****
BackupJobId	string	The backup task ID.	a006f24d069843c88688672d74ee****
BackupStartTime	long	The timestamp when the backup task started. Unit: milliseconds.	1699514211000
BackupEndTime	long	The timestamp when the backup task ended. Unit: milliseconds.	1699600611000
BackupStatus	string	The backup task status. Valid value: BACKUP_COMPLETE: The backup task is successful. BACKUP_FAILED: The backup task failed. PARTIAL_COMPLETE: The backup task is partially successful.	BACKUP_COMPLETE
ErrorCode	string	The error code of the backup task.	FILE_CACHE_NO_SPACE
ErrorMessage	string	The error message of the backup task.	FILE_CACHE_NO_SPACE
InstanceName	string	The instance name of the asset.	openapi
Ip	string	The IP address of the server.	1.1.1.1
InstanceId	string	The instance ID of the server.	i-wz9ikn44p46krnic****
InternetIp	string	The public IP address of the server.	1.1.1.1
IntranetIp	string	The private IP address of the server.	192.168.1.1
RegionId	string	The ID of the region in which the backup is stored.	cn-hangzhou
PageInfo	object	The pagination information.
CurrentPage	integer	The page number.	2
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries returned.	100
Count	integer	The number of entries returned on the current page.	20

Examples

Sample success responses

JSONformat

{
  "RequestId": "3956048F-9D73-5EDB-834B-4827BB48****",
  "BackupRecordList": [
    {
      "Uuid": "b93cccb9-f19f-4886-97fe-47df26ba****",
      "ClientId": "c-0002bgagelj3d2sc****",
      "BackupPlanId": "plan-000c4tt43nolmx96****",
      "BackupJobId": "a006f24d069843c88688672d74ee****",
      "BackupStartTime": 1699514211000,
      "BackupEndTime": 1699600611000,
      "BackupStatus": "BACKUP_COMPLETE",
      "ErrorCode": "FILE_CACHE_NO_SPACE",
      "ErrorMessage": "FILE_CACHE_NO_SPACE",
      "InstanceName": "openapi",
      "Ip": "1.1.1.1",
      "InstanceId": "i-wz9ikn44p46krnic****",
      "InternetIp": "1.1.1.1\n",
      "IntranetIp": "192.168.1.1",
      "RegionId": "cn-hangzhou"
    }
  ],
  "PageInfo": {
    "CurrentPage": 2,
    "PageSize": 20,
    "TotalCount": 100,
    "Count": 20
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

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