AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 云备份 开发参考 API参考 API目录 备份快照 DescribeUdmSnapshots - 查询整机备份快照

DescribeUdmSnapshots - 查询整机备份快照

更新时间：
产品详情
我的收藏

查询整机备份快照。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hbr:DescribeUdmSnapshots

list

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
SourceType

string

是

数据源类型，取值范围：

  • UDM_ECS：整机备份

  • UDM_ECS_DISK：整机备份云盘子任务

  • UDM_DISK：云盘备份

UDM_ECS
StartTime

integer

是

查询开始时间。UNIX 格式时间戳，单位为秒。

1642057551
EndTime

integer

是

查询截止时间。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\"]

返回参数

名称

类型

描述

示例值

object

Code

string

返回码，200 表示成功。

200
Message

string

返回信息描述，成功一般返回 successful，错误时会返回相应错误信息。

successful
RequestId

string

请求 ID。

51CDEECB-7001-51CC-94AC-2A0F2A4B71D2
TotalCount

integer

快照总个数。

3
Success

boolean

请求是否成功。

  • true：成功

  • false：失败

true
Snapshots

array<object>

快照详情集合。

object

快照详情集合。

Status

string

备份快照任务的状态。取值范围：

  • COMPLETE：成功

  • PARTIAL_COMPLETE：部分成功

  • FAILED：失败

COMPLETE
SnapshotHash

string

快照 HASH 值。

f2fe...
BackupType

string

备份类型。取值为 COMPLETE，表示全量备份。

COMPLETE
CreateTime

integer

创建备份快照的时间.

1607436917
ActualBytes

string

快照的实际容量。单位：byte。

600
SourceType

string

数据源类型，取值范围：

  • UDM_ECS：整机备份

  • UDM_ECS_DISK：整机备份云盘子任务

  • UDM_DISK：云盘备份

UDM_ECS
Prefix

string

快照的前缀。

example/
DiskId

string

云盘或本地盘 ID。

d-2ze86h5fga5rfwxxa8ef
BytesTotal

integer

数据源总量。单位为字节。

1000
NativeSnapshotInfo

string

快照信息。

{ "sourceDiskId":"d-bp17misjuy636t82v7b0", "lastModifiedTime":"2022-03-09T11:35:12Z", "snapshotSN":"64588-429372675-857161235", "snapshotId":"s-bp1fbtwv3e6xr6wpe9e0", "creationTime":"2022-03-09T11:31:12Z", "snapshotType":"user", "usage":"none", "description":"", "sourceStorageType":"disk", "tags":[ { "tagValue":"job-0007e0wqjl0imbrtkmnm", "tagKey":"HBR JobId" } ], "productCode":"", "encrypted":false, "sourceDiskType":"system", "retentionDays":30, "snapshotName":"Created-from-HBR-job:job-0007e0wqjl0imbrtkmnm", "kMSKeyId":"", "progress":"100%", "category":"standard", "sourceDiskSize":"20", "status":"accomplished" }
CompleteTime

integer

备份快照完成时间。UNIX 时间，单位为秒。

1646895666
Retention

integer

快照保留时间，单位为天。

7
CreatedTime

integer

备份快照的创建时间。UNIX 时间，单位为秒。

1642496679
RealSnapshotTime

integer

快照时间戳。UNIX 时间，单位为秒。

1642496679
ParentSnapshotHash

string

父级快照 Hash 值。

f2fe..
InstanceId

string

ECS 实例 ID。

i-bp1f0pe78dxizrsdcgxd
StartTime

integer

快照开始时间。UNIX 时间，单位为秒。

1554347313
UpdatedTime

integer

备份快照的更新时间。UNIX 时间，单位为秒。

1642496679
SnapshotId

string

备份快照 ID。

s-00047mxg17p26*****b
JobId

string

备份任务 ID。

job-00030j3chkt******2
NativeSnapshotId

string

快照 ID。

s-00047mg17p26x*****b
Detail

object

快照详情。

DiskDevName

string

磁盘名称。

/dev/xvdb
DowngradeReason

string

降级原因。

HBR.NoRamRoleBound
OsDiskId

string

系统盘 ID。

d-bp1e6427vhd320hifvc
OsName

string

操作系统名称。

Debian 10.10 64-bit (UEFI)
ContainOsDisk

boolean

是否包含系统盘。

true
ConsistentLevel

string

一致性等级。

CRASH
VmName

string

实例名称。

BNSHSVR42 IPGUARD
DiskHbrSnapshotIdWithDeviceMap

object

设备与恢复点 ID 映射关系。

{ "/dev/xvdb":"s-0000u7y6wm3v1e7hxh5a", "/dev/xvda":"s-0004bl6yr5pt89jjsv5a" }
InstanceIdWithDiskIdListMap

object

实例 ID 与云盘 ID 映射关系。

{ "i-bp1dlp0keohh7ids4uo6":"d-bp1e6427vhd320hifvs", "i-bp1dlp0keohh7ids4uo6":"d-bp1e6427vhd320hifvd" }
InstanceName

string

实例名称。

swh-hbr
OsType

string

操作系统类型，linux 或 windows。

windows
Platform

string

系统平台。

CentOS
OsNameEn

string

操作系统英文名称。

Debian 11.1 64 bit
HostName

string

主机名。

iZbpxxxxxxxxxxxxxxxxe2Z
SystemDisk

boolean

是否为系统盘。

true
DiskIdList

array

恢复点备份的云盘 ID 列表。

string

恢复点备份的云盘 ID。

d-bp1e6427vhd320hifvs
NativeSnapshotIdList

array

快照 ID 列表，与 DiskIdList 一一对应。

string

快照 ID。

s-0004bl6yr5pt89jjsv5a
SnapshotGroupId

string

快照分组 ID。

ssg-uf6856txcaq31uj***
InstanceType

string

源实例规格。

ecs.c6.xlarge
DiskCategory

string

源磁盘类型。

cloud_essd
PerformanceLevel

string

源磁盘性能等级。

PL0
InstantAccess

boolean

是否为即刻克隆功能创建的备份。

false
AdvancedRetentionType

string

特殊保留类型，仅对特殊保留备份有效：

  • WEEKLY：周特殊保留备份

  • MONTHLY：月特殊保留备份

  • YEARLY：年特殊保留备份

WEEKLY
ExpireTime

integer

备份过期时间。

1640334062
CanBeDeleted

boolean

云盘备份点是否允许删除。仅当 SourceType=UDM_ECS_DISK 时有效。

false
ArchiveStatus

string

ArchiveErrorMessage

string

ArchiveTriggerTime

integer

示例

正常返回示例

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,
      "CanBeDeleted": false,
      "ArchiveStatus": "",
      "ArchiveErrorMessage": "",
      "ArchiveTriggerTime": 0
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。

上一篇：SearchHistoricalSnapshots - 获取备份快照下一篇：恢复任务