文档

DescribeUdmSnapshots - 查询整机备份快照

更新时间:

查询整机备份快照。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
SourceTypestring

数据源类型,取值范围:

  • UDM_ECS:整机备份
  • UDM_ECS_DISK:整机备份云盘子任务
  • UDM_DISK:云盘备份
UDM_ECS
StartTimelong

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

1642057551
EndTimelong

查询截止时间。UNIX 格式时间戳,单位为秒。

1643092168
UdmRegionIdstring

整机所在地域 ID。

cn-hangzhou
InstanceIdstring

ECS 实例 ID。

i-bp18x2k7sw925ir7ofh8
DiskIdstring

云盘 ID。

d-bp1560750pclffpzxy70
JobIdstring

备份任务 ID。

job-*********************
SnapshotIdsobject

快照列表。

[\"s-000e3vhhu62xsm6v92r0\"]

返回参数

名称类型描述示例值
object
Codestring

返回码,200 表示成功。

200
Messagestring

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

successful
RequestIdstring

请求 ID。

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

快照总个数。

3
Successboolean

请求是否成功。

  • true:成功
  • false:失败
true
Snapshotsobject []

快照详情集合。

Statusstring

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

  • COMPLETE:成功
  • PARTIAL_COMPLETE:部分成功
  • FAILED:失败
COMPLETE
SnapshotHashstring

快照 HASH 值。

f2fe...
BackupTypestring

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

COMPLETE
CreateTimelong

创建备份快照的时间.

1607436917
ActualBytesstring

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

600
SourceTypestring

数据源类型,取值范围:

  • UDM_ECS:整机备份
  • UDM_ECS_DISK:整机备份云盘子任务
  • UDM_DISK:云盘备份
UDM_ECS
Prefixstring

快照的前缀。

example/
DiskIdstring

云盘或本地盘 ID。

d-2ze86h5fga5rfwxxa8ef
BytesTotallong

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

1000
NativeSnapshotInfostring

快照信息。

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

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

1646895666
Retentionlong

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

7
CreatedTimelong

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

1642496679
RealSnapshotTimelong

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

1642496679
ParentSnapshotHashstring

父级快照 Hash 值。

f2fe..
InstanceIdstring

ECS 实例 ID。

i-bp1f0pe78dxizrsdcgxd
StartTimelong

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

1554347313
UpdatedTimelong

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

1642496679
SnapshotIdstring

备份快照 ID。

s-00047mxg17p26*****b
JobIdstring

备份任务 ID。

job-00030j3chkt******2
NativeSnapshotIdstring

快照 ID。

s-00047mg17p26x*****b
Detailobject

快照详情。

DiskDevNamestring

磁盘名称。

/dev/xvdb
DowngradeReasonstring

降级原因。

HBR.NoRamRoleBound
OsDiskIdstring

系统盘 ID。

d-bp1e6427vhd320hifvc
OsNamestring

操作系统名称。

Debian 10.10 64-bit (UEFI)
ContainOsDiskboolean

是否包含系统盘。

true
ConsistentLevelstring

一致性等级。

CRASH
VmNamestring

实例名称。

BNSHSVR42 IPGUARD
DiskHbrSnapshotIdWithDeviceMapobject

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

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

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

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

实例名称。

swh-hbr
OsTypestring

操作系统类型,linux 或 windows。

windows
Platformstring

系统平台。

CentOS
OsNameEnstring

操作系统英文名称。

Debian 11.1 64 bit
HostNamestring

主机名。

iZbpxxxxxxxxxxxxxxxxe2Z
SystemDiskboolean

是否为系统盘。

true
DiskIdListarray

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

string

恢复点备份的云盘 ID。

d-bp1e6427vhd320hifvs
NativeSnapshotIdListarray

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

string

快照 ID。

s-0004bl6yr5pt89jjsv5a
SnapshotGroupIdstring

快照分组 ID。

ssg-uf6856txcaq31uj***
InstanceTypestring

源实例规格。

ecs.c6.xlarge
DiskCategorystring

源磁盘类型。

cloud_essd
PerformanceLevelstring

源磁盘性能等级。

PL0
InstantAccessboolean

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

false
AdvancedRetentionTypestring

特殊保留类型,仅对特殊保留备份有效:

  • WEEKLY:周特殊保留备份
  • MONTHLY:月特殊保留备份
  • YEARLY:年特殊保留备份
WEEKLY
ExpireTimelong

备份过期时间。

1640334062

示例

正常返回示例

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈