Queries the backup snapshots of an Elastic Compute Service (ECS) instance.
Debugging
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 Resourcesis 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 |
|---|---|---|---|---|
| hbr:DescribeUdmSnapshots | list | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| SourceType | string | Yes | The type of the data source. Valid values:
| UDM_ECS |
| StartTime | long | Yes | The beginning of the time range to query. The value must be a UNIX timestamp. Unit: seconds. | 1642057551 |
| EndTime | long | Yes | The end of the time range to query. The value must be a UNIX timestamp. Unit: seconds. | 1643092168 |
| UdmRegionId | string | Yes | The ID of the region where the ECS instance resides. | cn-hangzhou |
| InstanceId | string | Yes | The ID of the ECS instance. | i-bp18x2k7sw925ir7ofh8 |
| DiskId | string | No | The ID of the disk. | d-bp1560750pclffpzxy70 |
| JobId | string | No | The ID of the backup job. | job-********************* |
| SnapshotIds | object | No | The list of backup snapshots. | [\"s-000e3vhhu62xsm6v92r0\"] |
Response parameters
Examples
Sample success responses
JSONformat
{
"Code": "200",
"Message": "successful",
"RequestId": "51CDEECB-7001-51CC-94AC-2A0F2A4B71D2",
"TotalCount": 3,
"Success": true,
"Snapshots": [
{
"Status": "COMPLETE",
"SnapshotHash": "f2fe...",
"BackupType": "COMPLETE",
"CreateTime": 1607436917,
"ActualBytes": "600",
"SourceType": "UDM_ECS",
"Prefix": "example/",
"DiskId": "d-2ze86h5fga5rfwxxa8ef",
"BytesTotal": 1000,
"NativeSnapshotInfo": "{\n\t\t\t\t\t\"sourceDiskId\":\"d-bp17misjuy636t82v7b0\",\n\t\t\t\t\t\"lastModifiedTime\":\"2022-03-09T11:35:12Z\",\n\t\t\t\t\t\"snapshotSN\":\"64588-429372675-857161235\",\n\t\t\t\t\t\"snapshotId\":\"s-bp1fbtwv3e6xr6wpe9e0\",\n\t\t\t\t\t\"creationTime\":\"2022-03-09T11:31:12Z\",\n\t\t\t\t\t\"snapshotType\":\"user\",\n\t\t\t\t\t\"usage\":\"none\",\n\t\t\t\t\t\"description\":\"\",\n\t\t\t\t\t\"sourceStorageType\":\"disk\",\n\t\t\t\t\t\"tags\":[\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"tagValue\":\"job-0007e0wqjl0imbrtkmnm\",\n\t\t\t\t\t\t\t\"tagKey\":\"HBR JobId\"\n\t\t\t\t\t\t}\n\t\t\t\t\t],\n\t\t\t\t\t\"productCode\":\"\",\n\t\t\t\t\t\"encrypted\":false,\n\t\t\t\t\t\"sourceDiskType\":\"system\",\n\t\t\t\t\t\"retentionDays\":30,\n\t\t\t\t\t\"snapshotName\":\"Created-from-HBR-job:job-0007e0wqjl0imbrtkmnm\",\n\t\t\t\t\t\"kMSKeyId\":\"\",\n\t\t\t\t\t\"progress\":\"100%\",\n\t\t\t\t\t\"category\":\"standard\",\n\t\t\t\t\t\"sourceDiskSize\":\"20\",\n\t\t\t\t\t\"status\":\"accomplished\"\n\t\t\t\t}",
"CompleteTime": 1646895666,
"Retention": 7,
"CreatedTime": 1642496679,
"RealSnapshotTime": 1642496679,
"ParentSnapshotHash": "f2fe..",
"InstanceId": "i-bp1f0pe78dxizrsdcgxd",
"StartTime": 1554347313,
"UpdatedTime": 1642496679,
"SnapshotId": "s-00047mxg17p26*****b",
"JobId": "job-00030j3chkt******2",
"NativeSnapshotId": "s-00047mg17p26x*****b",
"Detail": {
"DiskDevName": "/dev/xvdb",
"DowngradeReason": "HBR.NoRamRoleBound",
"OsDiskId": "d-bp1e6427vhd320hifvc",
"OsName": "Debian 10.10 64-bit (UEFI)",
"ContainOsDisk": true,
"ConsistentLevel": "CRASH",
"VmName": "BNSHSVR42 IPGUARD",
"DiskHbrSnapshotIdWithDeviceMap": {
"/dev/xvdb": "s-0000u7y6wm3v1e7hxh5a",
"/dev/xvda": "s-0004bl6yr5pt89jjsv5a"
},
"InstanceIdWithDiskIdListMap": {
"i-bp1dlp0keohh7ids4uo6": "d-bp1e6427vhd320hifvd"
},
"InstanceName": "swh-hbr",
"OsType": "windows",
"Platform": "CentOS",
"OsNameEn": "Debian 11.1 64 bit",
"HostName": "iZbpxxxxxxxxxxxxxxxxe2Z",
"SystemDisk": true,
"DiskIdList": [
"d-bp1e6427vhd320hifvs"
],
"NativeSnapshotIdList": [
"s-0004bl6yr5pt89jjsv5a"
],
"SnapshotGroupId": "ssg-uf6856txcaq31uj***",
"InstanceType": "ecs.c6.xlarge",
"DiskCategory": "cloud_essd",
"PerformanceLevel": "PL0",
"InstantAccess": false
},
"AdvancedRetentionType": "WEEKLY",
"ExpireTime": 1640334062
}
]
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|
No change history