查询整机备份快照。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| hbr:DescribeUdmSnapshots | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SourceType | string | 是 | 数据源类型，取值范围：
| UDM_ECS |
| StartTime | long | 是 | 查询开始时间。UNIX 格式时间戳，单位为秒。 | 1642057551 |
| EndTime | long | 是 | 查询截止时间。UNIX 格式时间戳，单位为秒。 | 1643092168 |
| UdmRegionId | string | 是 | 整机所在地域 ID。 | cn-hangzhou |
| InstanceId | string | 是 | ECS 实例 ID。 | i-bp18x2k7sw925ir7ofh8 |
| DiskId | string | 否 | 云盘 ID。 | d-bp1560750pclffpzxy70 |
| JobId | string | 否 | 备份任务 ID。 | job-********************* |
| SnapshotIds | object | 否 | 快照列表。 | [\"s-000e3vhhu62xsm6v92r0\"] |
返回参数
示例
正常返回示例
JSON格式
{
"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
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史