Use DescribeSnapshots to query anti-ransomware backup snapshots - Security Center - Alibaba Cloud - Security Center

Queries anti-ransomware backup snapshots.

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:DescribeSnapshots

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Uuid	string	No	The UUID of the server. Note You can call the DescribeBackupPolicy operation to query the UUIDs of servers.	061d8042-59ff-416e-bc33-294a1cf5****
MachineRegion	string	No	The region in which the server resides. Note If the Uuid parameter is not specified, this parameter is required.	us-east-1
MachineRemark	string	No	The name or IP address of the server.	192.168.XX.XX
StatusList	string	No	The status of backup snapshots from which data can be restored. Valid values: COMPLETE: complete PARTIAL_COMPLETE: partial complete	["COMPLETE"]
PageSize	integer	Yes	The number of entries to return on each page.	20
CurrentPage	integer	No	The number of the page to return. Default value: 1.	1
NextToken	string	No	The pagination token. Leave empty to start from the beginning. Note You do not need to specify this parameter for the first request. Each response includes a token for the next request.	CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAB4SwmEAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM0NzY3YTZjNjI3NjZmNmU3MjcxNjk3NDY5MzY3MjY4****
ApiVersion	string	Yes	The version of the anti-ransomware policy. Valid values: 1.0.0 2.0.0	2.0.0
IsAliYunEcs	string	No	Indicates whether the server is an Elastic Compute Service (ECS) instance. Valid values: true: yes false: no	true

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
NextToken	string	The token for the next query.	CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4****
PageSize	integer	The number of entries returned per page.	20
TotalCount	integer	The total number of entries returned.	149
Count	integer	The number of entries returned on the current page.	20
Snapshots	array<object>	The backup snapshots.
	object	The backup snapshot details.
Status	string	The status of backup tasks. Valid values: COMPLETE: complete PARTIAL_COMPLETE: partial complete FAILED: failed	COMPLETE
SnapshotHash	string	The hash value of the backup snapshot.	9ee47cf12351e4ddecce8c12f4957d3946cd96fbe24cd4ab264c7200839d****
ActualItems	integer	The actual number of backup objects. Note This parameter is available only for file backup.	123
VaultId	string	The ID of the backup vault that stores the backup snapshot.	v-000ccok3zmw7fbzz****
ActualBytes	integer	The deduplicated data size of backup snapshots. Unit: bytes.	686188****
SourceType	string	The type of the data source. Valid values: ECS_FILE: ECS files OSS: Object Storage Service (OSS) buckets NAS: File Storage NAS file systems OTS_TABLE: Tablestore instances	ECS_FILE
ClientId	string	The ID of the Hybrid Backup Recovery (HBR) agent. Returned only when SourceType is ECS_FILE.	c-000dbefaw9f7gnbw****
ItemsDone	integer	The number of backup objects. Note This parameter is available only for file backup.	6
BytesTotal	integer	The total data amount of the data source. Unit: bytes.	3484541815****
Retention	integer	The retention period of the backup snapshot.	7
CreatedTime	integer	The snapshot creation time as a UNIX timestamp. Unit: seconds.	1646793988
ParentSnapshotHash	string	The hash value of the parent backup snapshot.	a0181606689c9562f092b3190bddb8a62bb5a24784424ba2102bc7fe92ae****
InstanceId	string	The ID of the ECS instance.	i-2ze78zfakirgh1yl****
PlanId	string	The ID of the backup plan.	plan-000ee8gh2ljelsnb****
RegionId	string	The ID of the region in which the backup snapshot is stored.	us-east-1
Uuid	string	The UUID of the server.	d332af48-1269-4a55-a6db-8543a80f****
ErrorFile	string	The file that records backup failure details, including partially completed tasks.	s-0008ndhgrflh55i5****.csv
SnapshotId	string	The ID of the backup snapshot.	s-0003ahfuqpjdztsg****
JobId	string	The ID of the backup task.	job-000a2q5vg6awgo01****
Path	string	The path to the backup files. Returned only when SourceType is ECS_FILE.	["/home"]
ItemsTotal	integer	The total number of objects in the data source. Note This parameter is available only for file backup.	7
BytesDone	integer	The amount of data generated by incremental backup. Unit: bytes.	800
Paths	array	The path to the backup files. Returned only when SourceType is NAS.
	string	The path information about the backup snapshot.	/home
ClientVersion	string	The version of the anti-ransomware agent.	2.10.0
ExpireTime	integer	The snapshot expiration timestamp. Unit: milliseconds.	1799132915000

Examples

Success response

JSON format

{
  "RequestId": "A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****",
  "PageInfo": {
    "CurrentPage": 1,
    "NextToken": "CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4****",
    "PageSize": 20,
    "TotalCount": 149,
    "Count": 20
  },
  "Snapshots": [
    {
      "Status": "COMPLETE",
      "SnapshotHash": "9ee47cf12351e4ddecce8c12f4957d3946cd96fbe24cd4ab264c7200839d****",
      "ActualItems": 123,
      "VaultId": "v-000ccok3zmw7fbzz****",
      "ActualBytes": 0,
      "SourceType": "ECS_FILE",
      "ClientId": "c-000dbefaw9f7gnbw****",
      "ItemsDone": 6,
      "BytesTotal": 0,
      "Retention": 7,
      "CreatedTime": 1646793988,
      "ParentSnapshotHash": "a0181606689c9562f092b3190bddb8a62bb5a24784424ba2102bc7fe92ae****",
      "InstanceId": "i-2ze78zfakirgh1yl****",
      "PlanId": "plan-000ee8gh2ljelsnb****",
      "RegionId": "us-east-1",
      "Uuid": "d332af48-1269-4a55-a6db-8543a80f****",
      "ErrorFile": "s-0008ndhgrflh55i5****.csv",
      "SnapshotId": "s-0003ahfuqpjdztsg****",
      "JobId": "job-000a2q5vg6awgo01****",
      "Path": "[\"/home\"]\n",
      "ItemsTotal": 7,
      "BytesDone": 800,
      "Paths": [
        "/home"
      ],
      "ClientVersion": "2.10.0",
      "ExpireTime": 1799132915000
    }
  ]
}

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.