All Products
Search
Document Center

Security Center:DescribeUniRecoverableList

Last Updated:Feb 20, 2024

Queries the backup snapshots from which the data of a database can be restored.

Debugging

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

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:DescribeUniRecoverableListRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PolicyIdlongYes

The ID of the anti-ransomware policy.

Note You can call the DescribeUniBackupPolicies operation to query the IDs of anti-ransomware policies.
123
PageSizeintegerNo

The number of entries to return on each 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
CurrentPageintegerNo

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

1
DatabasestringNo

The name of the database.

msdb

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

CurrentPageinteger

The page number of the returned page.

1
RequestIdstring

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

F35F45B0-5D6B-4238-BE02-A62D0760****
Databasestring

The name of the database.

msdb
PageSizeinteger

The number of entries returned per page.

20
TotalCountinteger

The total number of entries returned.

23
Countinteger

The number of entries returned on the current page.

20
RecoverableInfoListobject []

An array that consists of the backup snapshots.

LastTimelong

The timestamp of the last backup. Unit: milliseconds.

1671468180000
ResetTimelong

The point in time for restoration in the backup version that is used. The database is an Oracle database.

2021-01-30 08:04:36
RestoreInfostring

The information about the database. This parameter is available when the database is a Microsoft SQL Server (MSSQL) database. The value is a JSON string. Valid values:

  • name: the name of the database
  • files: the path to the database files
{ "files": { "qtc": "F:\\database\\qtc.mdf", "qtc_log": "F:\\database\\qtc_0.ldf" }, "name": "qtc" }
FirstTimelong

The timestamp of the first backup. Unit: milliseconds.

1671468180000
ResetScnstring

The identifier of the point in time for restoration in the backup version that is used. The database is an Oracle database.

4529940.0

Examples

Sample success responses

JSONformat

{
  "CurrentPage": 1,
  "RequestId": "F35F45B0-5D6B-4238-BE02-A62D0760****",
  "Database": "msdb",
  "PageSize": 20,
  "TotalCount": 23,
  "Count": 20,
  "RecoverableInfoList": [
    {
      "LastTime": 1671468180000,
      "ResetTime": 0,
      "RestoreInfo": "{\n      \"files\": {\n            \"qtc\": \"F:\\\\database\\\\qtc.mdf\",\n            \"qtc_log\": \"F:\\\\database\\\\qtc_0.ldf\"\n      },\n      \"name\": \"qtc\"\n}",
      "FirstTime": 1671468180000,
      "ResetScn": "4529940.0"
    }
  ]
}

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.

Change history

Change timeSummary of changesOperation
No change history