Queries a list of backup points.
Operation description
This operation queries a list of backup points based on the protected resource (ProtectedResourceId). Limits:
The protected resource must exist, and SourceType must match the data source type of the protected resource.
MaxResults must be greater than 1. Default value: 10.
Skip must be a non-negative integer and a multiple of MaxResults. When Skip is greater than 0, you cannot specify NextToken at the same time.
CompleteTimeStart and CompleteTimeEnd are UNIX timestamps in seconds. The filter range is [CompleteTimeStart, CompleteTimeEnd).
If no sorting field is specified, results are sorted by backup completion time (CompleteTime) in descending order by default.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| NextToken |
string |
No |
The pagination token. You do not need to specify this parameter for the first request. For subsequent pages, pass in the NextToken value returned from the previous request. An empty NextToken indicates that no more pages are available. This parameter cannot be used together with Skip. |
eyJJbmRleCI6NjUwMX0= |
| MaxResults |
integer |
No |
The maximum number of results to return in a paged query. Default value: 10. The value must be greater than 1. |
10 |
| Skip |
integer |
No |
The number of entries to skip. The value must be a non-negative integer and a multiple of MaxResults. This parameter cannot be used together with NextToken. |
0 |
| SourceType |
string |
Yes |
The data source type. The value must match the data source type of the protected resource (ProtectedResourceId). The supported data source types are listed in the valid values. Valid values:
|
ECS_FILE |
| ProtectedResourceId |
string |
Yes |
The ID of the protected resource. The protected resource must exist, and its data source type must match the SourceType parameter. |
pr-123***7890 |
| VaultId |
string |
No |
The vault ID. This is an optional filter condition. If specified, only backup points in the specified vault are returned. |
v-00030j3c******sn |
| CompleteTimeStart |
integer |
No |
The start completion time. A UNIX timestamp, in seconds. Only backup points with a completion time greater than or equal to this value are returned. |
1776059082 |
| CompleteTimeEnd |
integer |
No |
The end completion time. A UNIX timestamp, in seconds. Only backup points with a completion time earlier than this value are returned. |
1776059382 |
| PlanId |
string |
No |
The backup plan ID. This is an optional filter condition. If specified, only backup points under the specified backup plan are returned. |
po-0000****123 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response. |
||
| RequestId |
string |
The request ID. |
17189276-****-****-****-0FF51B5A41A0 |
| Code |
string |
The return code. A value of 200 indicates success. |
200 |
| Message |
string |
The return message. The value "successful" is returned for successful requests. An error message is returned for failed requests. |
successful |
| Success |
boolean |
Indicates whether the request was successful.
|
true |
| Snapshots |
array<object> |
The list of backup points. |
|
|
object |
The backup point information. |
||
| Status |
string |
The backup point status. Valid values:
|
COMPLETE |
| SnapshotHash |
string |
The hash value of the backup point. |
f2ac5fd243**********************bc4451777be019 |
| VaultId |
string |
The ID of the vault that stores the backup data. |
v-00030j*******sn |
| ActualItems |
integer |
The actual number of nodes. |
6 |
| BackupType |
string |
The backup type. The value is COMPLETE, which indicates a full backup. |
COMPLETE |
| CreateTime |
integer |
The time when the backup point was created, in seconds. |
1607436917 |
| ActualBytes |
integer |
The actual amount of data written, in bytes. |
600 |
| SourceType |
string |
The data source type. Valid values:
|
ECS_FILE |
| ClientId |
string |
When SourceType is set to ECS_FILE or File, this parameter indicates the backup client ID. In other cases, it indicates the ID of the backup data source. |
c-********************* |
| BytesTotal |
integer |
The total amount of data to back up, in bytes. |
1000 |
| ItemsDone |
integer |
The number of nodes that have been backed up. |
8 |
| CompleteTime |
integer |
The backup completion time. A UNIX timestamp, in seconds. |
1642496679 |
| Retention |
integer |
The retention period of the backup, in days. |
7 |
| CreatedTime |
integer |
The time when the backup was created. |
1642496679 |
| InstanceId |
string |
The instance ID of the backup data source. |
i-********************* |
| ErrorFile |
string |
The file that records backup failure information, including information about partially completed backups. |
temp/report/123456789/job-xxxxxxxxx_failed.zip |
| SnapshotId |
string |
The backup point ID. |
s-00047mxg17p26*****b |
| JobId |
string |
The backup job ID. |
job-00030j3chkt******2 |
| Path |
string |
The source path. |
/home |
| ItemsTotal |
integer |
The total number of nodes to back up. |
10 |
| BytesDone |
integer |
The amount of data that has been backed up, in bytes. |
800 |
| Paths |
array |
The list of source paths. |
|
|
string |
The source path. |
/home |
|
| InstanceName |
string |
The Tablestore instance name. |
instancename |
| TableName |
string |
The name of the data table in the Tablestore instance. |
table2 |
| RangeStart |
integer |
The start time of the Tablestore backup job execution. A UNIX timestamp, in milliseconds. |
1642492553038 |
| RangeEnd |
integer |
The end time of the Tablestore backup job execution. A UNIX timestamp, in milliseconds. |
1642521709966 |
| ExpireTime |
integer |
The backup expiration time. |
1771901707 |
| StorageClass |
string |
The storage class. Valid values:
|
STANDARD |
| ArchiveTime |
integer |
The time when the backup was archived. |
1640334062 |
| Include |
string |
The source paths included in the backup job. |
[\"/test/example_cn-huhehaote_3.txt\", \"/test/example_cn-huhehaote_9.txt\", \"/test/example_cn-huhehaote_5.txt\", \"/test/example_cn-huhehaote_1.txt\", \"/test/example_cn-huhehaote_7.txt\"] |
| Exclude |
string |
The source paths excluded from the backup job. |
[\"/test/example_cn-hangzhou_7.txt\", \"/test/example_cn-hangzhou_1.txt\", \"/test/example_cn-hangzhou_3.txt\", \"/test/example_cn-hangzhou_9.txt\", \"/test/example_cn-hangzhou_6.txt\"] |
| ProtectedDataSize |
integer |
The protected source data size, in bytes. When SourceType is set to ECS_FILE, this indicates the protected cloud disk capacity. |
42949672960 |
| PlanId |
string |
The backup plan ID. |
po-123***7890 |
| TotalCount |
integer |
The total number of records. |
3 |
| MaxResults |
integer |
The maximum number of results returned. |
10 |
| NextToken |
string |
The token for the next page. An empty NextToken indicates that no more pages are available. |
aWQj********MCMy |
Examples
Success response
JSON format
{
"RequestId": "17189276-****-****-****-0FF51B5A41A0",
"Code": "200",
"Message": "successful",
"Success": true,
"Snapshots": [
{
"Status": "COMPLETE",
"SnapshotHash": "f2ac5fd243**********************bc4451777be019",
"VaultId": "v-00030j*******sn",
"ActualItems": 6,
"BackupType": "COMPLETE",
"CreateTime": 1607436917,
"ActualBytes": 600,
"SourceType": "ECS_FILE",
"ClientId": "c-*********************",
"BytesTotal": 1000,
"ItemsDone": 8,
"CompleteTime": 1642496679,
"Retention": 7,
"CreatedTime": 1642496679,
"InstanceId": "i-*********************",
"ErrorFile": "temp/report/123456789/job-xxxxxxxxx_failed.zip",
"SnapshotId": "s-00047mxg17p26*****b",
"JobId": "job-00030j3chkt******2",
"Path": "/home",
"ItemsTotal": 10,
"BytesDone": 800,
"Paths": [
"/home"
],
"InstanceName": "instancename",
"TableName": "table2",
"RangeStart": 1642492553038,
"RangeEnd": 1642521709966,
"ExpireTime": 1771901707,
"StorageClass": "STANDARD",
"ArchiveTime": 1640334062,
"Include": "[\\\"/test/example_cn-huhehaote_3.txt\\\", \\\"/test/example_cn-huhehaote_9.txt\\\", \\\"/test/example_cn-huhehaote_5.txt\\\", \\\"/test/example_cn-huhehaote_1.txt\\\", \\\"/test/example_cn-huhehaote_7.txt\\\"]",
"Exclude": "[\\\"/test/example_cn-hangzhou_7.txt\\\", \\\"/test/example_cn-hangzhou_1.txt\\\", \\\"/test/example_cn-hangzhou_3.txt\\\", \\\"/test/example_cn-hangzhou_9.txt\\\", \\\"/test/example_cn-hangzhou_6.txt\\\"]",
"ProtectedDataSize": 42949672960,
"PlanId": "po-123***7890"
}
],
"TotalCount": 3,
"MaxResults": 10,
"NextToken": "aWQj********MCMy"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.