すべてのプロダクト
Search

このプロダクト

    :SearchHistoricalSnapshots

    ドキュメントセンター

    :SearchHistoricalSnapshots

    最終更新日:Aug 27, 2026

    指定された条件を満たす 1 つ以上の履歴バックアップスナップショットを取得します。

    今すぐお試しください

    この 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:SearchHistoricalSnapshots

    get

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    SourceType

    string

    任意

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

    • ECS_FILE: ECS ファイルのバックアップスナップショット。

    • OSS: Alibaba Cloud OSS のバックアップスナップショット。

    • NAS: Alibaba Cloud NAS のバックアップスナップショット。

    ECS_FILE
    Query

    array

    必須

    クエリ条件。Query の例:

    [
  {
    "field": "VaultId",
    "value": "v-0003rf9m*****qx5",
    "operation": "MATCH_TERM"
  },
  {
    "field": "InstanceId",
    "value": "i-bp1i20zq2*****e9368m",
    "operation": "MATCH_TERM"
  },
  {
    "field": "PlanId",
    "value": "plan-0005vk*****gkd1iu4f",
    "operation": "MATCH_TERM"
  },
  {
    "field": "CompleteTime",
    "value": "1626769913",
    "operation": "GREATER_THAN_OR_EQUAL"
  }
]

    • サポートされているフィールド:

      • VaultId: 必須。ボールト ID。

      • InstanceId: SourceType=ECS_FILE の場合のみ必須。ECS インスタンスの ID。

      • Bucket: SourceType=OSS の場合のみ必須。OSS バケット名。

      • FileSystemId: SourceType=NAS の場合のみ必須。NAS ファイルシステムの ID。

      • CreateTime: SourceType=NAS の場合のみ必須。NAS ファイルシステムの作成時間。

      • CompleteTime: スナップショットが完了した時間。

      • PlanId: バックアッププランの ID。

    • サポートされている操作:

      • MATCH_TERM: 完全に一致。

      • GREATER_THAN: より大きい。

      • GREATER_THAN_OR_EQUAL: 以上。

      • LESS_THAN: より小さい。

      • LESS_THAN_OR_EQUAL: 以下。

      • BETWEEN: 有効値。値は JSON 配列 [下限, 上限] です。

      • IN: セット内。値は配列です。

      • NOT_IN: セット外。値は配列です。

    [ { "フィールド": "VaultId", "値": "v-0003rf9m17pap3ltpqx5", "操作": "MATCH_TERM" }, { "フィールド": "InstanceId", "値": "i-bp1i20zq2wuzdie9368m", "操作": "MATCH_TERM" }, { "フィールド": "PlanId", "値": "plan-0005vkqhpesqgkd1iu4f", "操作": "MATCH_TERM" }, { "フィールド": "CompleteTime", "値": 1626769913, "操作": "GREATER_THAN_OR_EQUAL" } ]

    any

    任意

    クエリ条件。Query の例:

    [
  {
    "field": "VaultId",
    "value": "v-0003rf9m*****qx5",
    "operation": "MATCH_TERM"
  },
  {
    "field": "InstanceId",
    "value": "i-bp1i20zq2*****e9368m",
    "operation": "MATCH_TERM"
  },
  {
    "field": "PlanId",
    "value": "plan-0005vk*****gkd1iu4f",
    "operation": "MATCH_TERM"
  },
  {
    "field": "CompleteTime",
    "value": "1626769913",
    "operation": "GREATER_THAN_OR_EQUAL"
  }
]

    • サポートされているフィールド:

      • VaultId: 必須。ボールト ID。

      • InstanceId: SourceType=ECS_FILE の場合のみ必須。ECS インスタンスの ID。

      • Bucket: SourceType=OSS の場合のみ必須。OSS バケット名。

      • FileSystemId: SourceType=NAS の場合のみ必須。NAS ファイルシステムの ID。

      • CreateTime: SourceType=NAS の場合のみ必須。NAS ファイルシステムの作成時間。

      • CompleteTime: スナップショットが完了した時間。

      • PlanId: バックアッププランの ID。

    • サポートされている操作:

      • MATCH_TERM: 完全に一致。

      • GREATER_THAN: より大きい。

      • GREATER_THAN_OR_EQUAL: 以上。

      • LESS_THAN: より小さい。

      • LESS_THAN_OR_EQUAL: 以下。

      • BETWEEN: 有効値。値は JSON 配列 [下限, 上限] です。

      • IN: セット内。値は配列です。

      • NOT_IN: セット外。値は配列です。

    [ { "フィールド": "VaultId", "値": "v-0003rf9m17pap3ltpqx5", "操作": "MATCH_TERM" }, { "フィールド": "InstanceId", "値": "i-bp1i20zq2wuzdie9368m", "操作": "MATCH_TERM" }, { "フィールド": "PlanId", "値": "plan-0005vkqhpesqgkd1iu4f", "操作": "MATCH_TERM" }, { "フィールド": "CompleteTime", "値": 1626769913, "操作": "GREATER_THAN_OR_EQUAL" } ]
    Limit

    integer

    任意

    このクエリで返される結果の最大値。 実際のデータなしで行数のみを取得したい場合は、limit=0 を設定して行を返さないようにします。

    10
    NextToken

    string

    任意

    スナップショットの次のページを取得するために必要なトークン。

    caeba0bbb2be03f84eb48b699f0a****
    SortBy

    string

    任意

    ソートに使用されるフィールド。

    CreatedTime
    Order

    string

    任意

    ソート順序。デフォルト値: ASC。

    • ASC: 昇順。

    • DESC: 降順。

    ASC
    Edition

    string

    任意

    エディションタイプ。有効な値: BASIC および STANDARD。デフォルト値: STANDARD。

    BASIC

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    NextToken

    string

    スナップショットの次のページを取得するために必要なトークン。

    BE
    RequestId

    string

    リクエスト ID。

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    Success

    boolean

    リクエストが成功したかどうかを示します。

    • true: リクエストが成功しました。

    • false: リクエストが失敗したことを示します。

    true
    Limit

    integer

    現在のページに表示される履歴スナップショットの数。

    10
    Code

    string

    応答コード。値が 200 の場合は成功を示します。

    200
    Message

    string

    返されたメッセージ。リクエストが成功した場合は "successful" という値が返されます。リクエストが失敗した場合はエラーメッセージが返されます。

    successful
    TotalCount

    integer

    指定された条件を満たすスナップショットの総数。

    20
    Snapshots

    object

    Snapshot

    array<object>

    履歴スナップショットのリスト。

    array<object>

    Status

    string

    バックアップスナップショットジョブのステータス。有効な値:

    • COMPLETE: 成功。

    • PARTIAL_COMPLETE: 一部成功。

    • FAILED: 失敗。

    COMPLETE
    SnapshotHash

    string

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

    f2fe...
    VaultId

    string

    バックアップスナップショットを保存するボールトの ID。

    v-0003rf9m17pap3ltpqx5
    ActualItems

    integer

    スナップショット内の実際の項目数。

    説明

    現在、ファイルバックアップでのみ利用可能です。

    6
    BackupType

    string

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

    COMPLETE
    CreateTime

    integer

    このパラメーターは SourceType が NAS に設定されている場合にのみ有効です。ファイルシステムの作成時間。この値は UNIX タイムスタンプです。単位: 秒。

    1607436917
    ActualBytes

    integer

    重複排除後のスナップショットの実際のデータ量。単位: バイト。

    600
    SourceType

    string

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

    • ECS_FILE: ECS ファイルのバックアップスナップショット。

    • OSS: Alibaba Cloud OSS のバックアップスナップショット。

    • NAS: Alibaba Cloud NAS のバックアップスナップショット。

    ECS_FILE
    Prefix

    string

    このパラメーターは SourceType が OSS に設定されている場合にのみ有効です。バックアッププレフィックス。

    example/
    ClientId

    string

    このパラメーターは SourceType が ECS_FILE に設定されている場合にのみ有効です。バックアップクライアント ID。

    c-*********************
    BytesTotal

    integer

    データソースの総データ量。単位: バイト。

    1000
    ItemsDone

    integer

    バックアップ済みの項目数。

    説明

    現在、ファイルバックアップでのみ利用可能です。

    8
    CompleteTime

    integer

    バックアップスナップショットが完了した時間。この値は UNIX タイムスタンプです。単位: 秒。

    1554347313
    Retention

    integer

    バックアップスナップショットの保持期間。単位: 日。

    7
    CreatedTime

    integer

    バックアップスナップショットが作成された時間。この値は UNIX タイムスタンプです。単位: 秒。

    1554347313
    Bucket

    string

    このパラメーターは SourceType が OSS に設定されている場合にのみ有効です。OSS バケット名。

    hbr-バックアップ-oss
    ParentSnapshotHash

    string

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

    f2fe..
    InstanceId

    string

    このパラメーターは SourceType が ECS_FILE に設定されている場合にのみ有効です。ECS インスタンス ID。

    i-*********************
    FileSystemId

    string

    このパラメーターは SourceType が NAS に設定されている場合にのみ有効です。ファイルシステム ID。

    005494
    ErrorFile

    string

    部分的に完了したバックアップに関する情報を含む、バックアップ失敗情報を記録するファイル。

    Item Error Message C:\data\app\service.dat Open: open \\?\C:\data\app\service.dat: The process cannot access the file because it is being used by another process
    StartTime

    integer

    スナップショットが開始された時間。この値は UNIX タイムスタンプです。単位: 秒。

    1554347313
    UpdatedTime

    integer

    バックアップスナップショットが最後に更新された時間。この値は UNIX タイムスタンプです。単位: 秒。

    1554347313
    SnapshotId

    string

    バックアップスナップショット ID。

    s-*********************
    JobId

    string

    バックアップジョブ ID。

    v-*********************
    Path

    string

    このパラメーターは SourceType が ECS_FILE に設定されている場合にのみ有効です。バックアップファイルパス。

    ["/home"]
    ItemsTotal

    integer

    データソース内の項目の総数。

    説明

    現在、ファイルバックアップでのみ利用可能です。

    10
    BytesDone

    integer

    増分バックアップデータのデータ量。単位: バイト。

    800
    Paths

    object

    Path

    array

    バックアップファイルパスのリスト。

    "/home"

    string

    このパラメーターは SourceType が NAS に設定されている場合にのみ有効です。バックアップファイルパス。

    "/home"
    InstanceName

    string

    Tablestore インスタンス名。

    インスタンス名
    TableName

    string

    Tablestore インスタンス内のデータテーブルの名前。

    table2
    RangeStart

    integer

    バックアップジョブが開始された時間。この値は UNIX タイムスタンプです。単位: ミリ秒。

    1642492553038
    RangeEnd

    integer

    バックアップジョブが終了した時間。この値は UNIX タイムスタンプです。単位: ミリ秒。

    1642521709966
    ExpireTime

    integer

    スナップショットの有効期限時間。この値は UNIX タイムスタンプです。単位: 秒。

    1640334062
    SourceSnapshotHash

    string

    アーカイブ前のスナップショットハッシュ値。

    qwer***
    SourceParentSnapshotHash

    string

    アーカイブ前の親スナップショットハッシュ値。

    qwer***
    StorageClass

    string

    ストレージクラス。有効な値:

    • Standard: 標準。

    • Archive: アーカイブ。

    • ColdArchive: コールドアーカイブストレージ。

    STANDARD
    ArchiveTime

    integer

    スナップショットがアーカイブされた時間。

    1640334062
    UseCommonNas

    boolean

    ローカル NAS が使用されているかどうかを示します。

    false
    Include

    string

    バックアップジョブに含まれるソースパス。

    [\"/test/example_cn-huhehaote_3.txt\", \"/test/example_cn-huhehaote_9.txt\", \"/test/example_cn-huhehaote_5.txt\", \"/test/example_cn-huhehaote_1.txt\", \"/test/example_cn-huhehaote_7.txt\"]
    Exclude

    string

    バックアップジョブから除外されるソースパス。

    [\"/test/example_cn-hangzhou_7.txt\", \"/test/example_cn-hangzhou_1.txt\", \"/test/example_cn-hangzhou_3.txt\", \"/test/example_cn-hangzhou_9.txt\", \"/test/example_cn-hangzhou_6.txt\"]
    ProtectedDataSize

    integer

    保護対象のソースデータ量 (バイト単位)。SourceType=ECS_FILE の場合、これは保護対象のクラウドディスク容量を示します。

    42949672960

    例

    成功レスポンス

    JSONJSON

    {
  "NextToken": "BE",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Limit": 10,
  "Code": "200",
  "Message": "successful",
  "TotalCount": 20,
  "Snapshots": {
    "Snapshot": [
      {
        "Status": "COMPLETE",
        "SnapshotHash": "f2fe...",
        "VaultId": "v-0003rf9m17pap3ltpqx5",
        "ActualItems": 6,
        "BackupType": "COMPLETE",
        "CreateTime": 1607436917,
        "ActualBytes": 600,
        "SourceType": "ECS_FILE",
        "Prefix": "example/",
        "ClientId": "c-*********************",
        "BytesTotal": 1000,
        "ItemsDone": 8,
        "CompleteTime": 1554347313,
        "Retention": 7,
        "CreatedTime": 1554347313,
        "Bucket": "hbr-バックアップ-oss",
        "ParentSnapshotHash": "f2fe..",
        "InstanceId": "i-*********************",
        "FileSystemId": "005494",
        "ErrorFile": "Item\tError Message C:\\Program Files (x86)\\Symantec\\Symantec Endpoint Protection\\14.3.558.0000.105\\Bin\\service.dat\tOpen: open \\\\?\\C:\\Program Files (x86)\\Symantec\\Symantec Endpoint Protection\\14.3.558.0000.105\\Bin\\service.dat: The process cannot access the file because it is being used by another process. C:\\ProgramData\\McAfee\\Agent\\data\\InstallerFiles\\172e8a3b04b7ab0fd0215f4fb7707e3744b37d83b6743b3eacb94447c74dc9af_contrib.ini\tOpen: open \\\\?\\C:\\ProgramData\\McAfee\\Agent\\data\\InstallerFiles\\172e8a3b04b7ab0fd0215f4fb7707e3744b37d83b6743b3eacb94447c74dc9af_contrib.ini: Access is denied",
        "StartTime": 1554347313,
        "UpdatedTime": 1554347313,
        "SnapshotId": "s-*********************",
        "JobId": "v-*********************",
        "Path": "[\"/home\"]",
        "ItemsTotal": 10,
        "BytesDone": 800,
        "Paths": {
          "Path": [
            "\"/home\""
          ]
        },
        "InstanceName": "インスタンス名",
        "TableName": "table2",
        "RangeStart": 1642492553038,
        "RangeEnd": 1642521709966,
        "ExpireTime": 1640334062,
        "SourceSnapshotHash": "qwer***",
        "SourceParentSnapshotHash": "qwer***",
        "StorageClass": "STANDARD",
        "ArchiveTime": 1640334062,
        "UseCommonNas": false,
        "Include": "[\\\"/test/example_cn-huhehaote_3.txt\\\", \\\"/test/example_cn-huhehaote_9.txt\\\", \\\"/test/example_cn-huhehaote_5.txt\\\", \\\"/test/example_cn-huhehaote_1.txt\\\", \\\"/test/example_cn-huhehaote_7.txt\\\"]",
        "Exclude": "[\\\"/test/example_cn-hangzhou_7.txt\\\", \\\"/test/example_cn-hangzhou_1.txt\\\", \\\"/test/example_cn-hangzhou_3.txt\\\", \\\"/test/example_cn-hangzhou_9.txt\\\", \\\"/test/example_cn-hangzhou_6.txt\\\"]",
        "ProtectedDataSize": 42949672960
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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