DescribeBackupFiles - Security Center - Alibaba Cloud Documentation Center

Queries backup files.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DescribeBackupFiles	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Uuid	string	Yes	The UUID of the server to which an anti-ransomware policy is applied.	6d5b361f-958d-48a8-a9d2-d6e82c1a****
Path	string	No	The path to the backup file.	“”
SnapshotHash	string	Yes	The hash value of the backup file.	a7f26223ef3974c6fac324cd37713ab65ab618859d20b4039192a5da44d77b63
CurrentPage	string	Yes	The number of the page to return. Default value: 1.	1
PageSize	string	Yes	The number of entries to return on each page. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	00A60A6D-33E0-5D5A-9B7C-E5D4DCA88148
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page. Default value: 10.	10
TotalCount	integer	The total number of backup files returned.	69
Count	integer	The number of backup files returned on the current page.	10
BackupFiles	object []	An array that consists of the backup files returned.
Type	string	The type of the protected file. Valid values: file: files dir: folders	dir
Name	string	The name of the anti-ransomware policy.	Group 1
Subtree	string	The path to the subdirectory of the backup file.	Python27\
Size	long	The size of the backup file. Unit: bytes.	100

Examples

Sample success responses

JSONformat

{
  "RequestId": "00A60A6D-33E0-5D5A-9B7C-E5D4DCA88148",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 10,
    "TotalCount": 69,
    "Count": 10
  },
  "BackupFiles": [
    {
      "Type": "dir",
      "Name": "Group 1",
      "Subtree": "Python27\\",
      "Size": 100
    }
  ]
}

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.