DescribeSnapshots - Security Center - Alibaba Cloud Documentation Center

Queries the backup snapshots that are created for anti-ransomware.

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.

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:DescribeSnapshots	get	All Resources ``	none	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 starting position of the query. If this parameter is left empty, the query starts from the beginning. Note If you call the operation for the first time, you do not need to specify the parameter. The response to the first call contains the token that can be used for the second call. Each subsequent response contains the token that can be used for the next call.	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	Specifies whether the server is an Elastic Compute Service (ECS) instance. Valid values: true: yes false: no	true

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
NextToken	string	The token that is used to initiate the next call.	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>	An array that consists of the backup snapshots.
BackupSnapshots	object	The information about the backup snapshot.
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	long	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	long	The actual data amount of backup snapshots after duplicates are removed. 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	This parameter is returned only if the value of the SourceType parameter is ECS_FILE. This parameter indicates the ID of the Hybrid Backup Recovery (HBR) agent.	c-000dbefaw9f7gnbw****
ItemsDone	long	The number of backup objects. Note This parameter is available only for file backup.	6
BytesTotal	long	The total data amount of the data source. Unit: bytes.	3484541815****
Retention	long	The retention period of the backup snapshot.	7
CreatedTime	long	The time when the backup snapshot was created. The value is 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 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 the information about backup failures, including the information about partially completed backup 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	This parameter is returned only if the value of the SourceType parameter is ECS_FILE. This parameter indicates the path to the backup files.	["/home"]
ItemsTotal	long	The total number of objects in the data source. Note This parameter is available only for file backup.	7
BytesDone	long	The actual amount of data that is generated by incremental backup. Unit: bytes.	800
Paths	array	This parameter is returned only if the value of the SourceType parameter is NAS. This parameter indicates the path to the backup files.
StringItem	string	The path information about the backup snapshot.	/home
ClientVersion	string	The version of the anti-ransomware agent.	2.10.0

Examples

Sample success responses

JSONformat

{
  "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"
    }
  ]
}

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.

Change history

Change time	Summary of changes	Operation

No change history