すべてのプロダクト
Search

このプロダクト

    :DescribeUdmSnapshots

    ドキュメントセンター

    :DescribeUdmSnapshots

    最終更新日:Nov 17, 2025

    完全バックアップのスナップショットを照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    hbr:DescribeUdmSnapshots

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    SourceType

    string

    必須

    データソースのタイプ。 有効な値:

    • UDM_ECS: ECS インスタンスのバックアップ

    • UDM_ECS_DISK: ECS インスタンスバックアップのディスクバックアップサブタスク

    • UDM_DISK: ディスクバックアップ

    UDM_ECS
    StartTime

    integer

    必須

    クエリする時間範囲の開始。 この値は、秒単位の UNIX タイムスタンプです。

    1642057551
    EndTime

    integer

    必須

    クエリする時間範囲の終了。 この値は、秒単位の UNIX タイムスタンプです。

    1643092168
    UdmRegionId

    string

    必須

    ECS インスタンスのリージョン ID。

    cn-hangzhou
    InstanceId

    string

    任意

    ECS インスタンスの ID。

    i-bp18x2k7sw925ir7ofh8
    DiskId

    string

    任意

    ディスクの ID。

    d-bp1560750pclffpzxy70
    JobId

    string

    任意

    バックアップジョブの ID。

    job-*********************
    SnapshotIds

    object

    任意

    スナップショット ID のリスト。

    [\"s-000e3vhhu62xsm6v92r0\"]

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Code

    string

    HTTP ステータスコード。 値 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

    スナップショットのハッシュ値。

    f2fe...
    BackupType

    string

    バックアップタイプ。 値 COMPLETE は完全バックアップを示します。

    COMPLETE
    CreateTime

    integer

    バックアップスナップショットが作成された時間。

    1607436917
    ActualBytes

    string

    スナップショットの実際のサイズ。 単位: バイト。

    600
    SourceType

    string

    データソースのタイプ。 有効な値:

    • UDM_ECS: ECS インスタンスのバックアップ

    • UDM_ECS_DISK: ECS インスタンスバックアップのディスクバックアップサブタスク

    • 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

    親スナップショットのハッシュ値。

    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 のリスト。 このリストのネイティブスナップショット ID は、`DiskIdList` リストのディスク ID と 1 対 1 で対応しています。

    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

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。