All Products
Search
Document Center

Security Center:DescribeBackupFiles

Last Updated:Nov 13, 2024

Queries backup files.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeBackupFilesget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
UuidstringYes

The UUID of the server to which an anti-ransomware policy is applied.

6d5b361f-958d-48a8-a9d2-d6e82c1a****
PathstringNo

The path to the backup file.

“”
SnapshotHashstringYes

The hash value of the backup file.

a7f26223ef3974c6fac324cd37713ab65ab618859d20b4039192a5da44d77b63
CurrentPagestringYes

The number of the page to return. Default value: 1.

1
PageSizestringYes

The number of entries to return on each page. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

00A60A6D-33E0-5D5A-9B7C-E5D4DCA88148
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page. Default value: 10.

10
TotalCountinteger

The total number of backup files returned.

69
Countinteger

The number of backup files returned on the current page.

10
BackupFilesarray<object>

An array that consists of the backup files returned.

BrowseFileobject
Typestring

The type of the protected file. Valid values:

  • file: files
  • dir: folders
dir
Namestring

The name of the anti-ransomware policy.

Group 1
Subtreestring

The path to the subdirectory of the backup file.

Python27\
Sizelong

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 codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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