DescribeBackupFiles API Reference for Anti-Ransomware - Security Center - Alibaba Cloud - Security Center

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

yundun-sas:DescribeBackupFiles

get

*All Resource

*

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 elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	00A60A6D-33E0-5D5A-9B7C-E5D4DCA88148
PageInfo	object	The pagination information.
CurrentPage	integer	The page number.	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	array<object>	The backup files.
	object
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	integer	The size of the backup file. Unit: bytes.	100

Examples

Success response

JSON format

{
  "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
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.