全部產品
Search

搜尋本產品

    Cloud Backup：DescribeUdmSnapshots - 查詢整機備份快照

    文件中心

    Cloud Backup：DescribeUdmSnapshots - 查詢整機備份快照

    更新時間：Nov 17, 2025

    查詢整機備份快照。

    調試

    您可以在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>

    快照詳情集合。

    array<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

    歸檔狀態。

    ARCHIVED
    ArchiveErrorMessage

    string

    歸檔錯誤資訊。

    InternalError
    ArchiveTriggerTime

    integer

    歸檔觸發時間。

    1763373304

    樣本

    正常返回樣本

    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": "ARCHIVED",
      "ArchiveErrorMessage": "InternalError",
      "ArchiveTriggerTime": 1763373304
    }
  ]
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。