すべてのプロダクト
Search

このプロダクト

    Hologres:ListBackupData

    ドキュメントセンター

    Hologres:ListBackupData

    最終更新日:Oct 30, 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    hologram:ListBackupData

    list

    *Instance

    acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}

    		 なし なし

    リクエスト構文

    GET /api/v1/backups HTTP/1.1

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    任意

    インスタンス ID。

    hgprecn-cn-wwoxxxxx
    backupType

    string

    任意

    バックアップタイプ。このパラメーターを使用してバックアップデータをフィルターします。このパラメーターを空のままにすると、すべてのバックアップデータが返されます。

    列挙値:

    • redundant_remote :

      ゾーン冗長ストレージを使用したリモートバックアップ。

    • remote :

      リモートバックアップ。

    • redundant :

      ゾーン冗長ストレージを使用したローカルバックアップ。

    • full_remote :

      単一レプリカストレージを使用したリモートバックアップ。

    • local :

      ローカルバックアップ。

    • full :

      単一レプリカストレージを使用したローカルバックアップ。

    redundant

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    4AA0C48F-B5BB-5FF9-A43B-6B91E0715D46
    BackupDataList

    array<object>

    バックアップのリスト。

    object

    BackupType

    string

    バックアップタイプ。バックアップには主に 2 つのカテゴリがあります。スナップショットとインスタンスが同じリージョンにあるローカルバックアップと、スナップショットとインスタンスが異なるリージョンにあるリモートバックアップです。

    • redundant: 同じ都市の複数のゾーンに複数のレプリカとして保存されるローカルバックアップ (ゾーン冗長ストレージ)。

    • redundant_remote: ゾーン冗長ストレージを使用したリモートバックアップ。これは、冗長バックアップのオフサイトコピーです。

    • full: 単一のレプリカとして保存されるローカルバックアップ。

    • full_remote: 単一のレプリカとして保存されるリモートバックアップ。これは、完全バックアップのオフサイトコピーです。

    • local: この値は特定のバックアップタイプを表しません。ローカルバックアップデータをフィルターするためにのみ使用されます。

    • remote: この値は特定のバックアップタイプを表しません。リモートバックアップデータをフィルターするためにのみ使用されます。

    redundant
    DataGran

    string

    バックアップ粒度。

    列挙値:

    • instance :

      インスタンスレベル。

    instance
    Id

    integer

    バックアップの一意の ID。

    1780805690994479105
    InstanceId

    string

    インスタンス ID。

    hgpostcn-cn-pe33jdxxxxx
    StartTime

    string

    バックアップが開始された時間。時間は YYYY-MM-DDTHH:mm:ss.SSSTZ 形式で、UTC + 08:00 で表示されます。この形式は、すべての時間関連のパラメーターに適用されます。

    2024-10-28T11:19:56.000+00:00
    Status

    string

    バックアップステータス。

    列挙値:

    • processing :

      バックアップは進行中です。

    • completed :

      バックアップは完了しました。

    • failed :

      バックアップは失敗しました。

    completed
    TriggerType

    string

    トリガータイプ。

    列挙値:

    • scheduled :

      定期的なバックアップ。

    • manual :

      手動バックアップ。

    scheduled
    DataDesc

    string

    バックアップデータの説明。この説明は更新できます。

    demo
    DataTime

    string

    データスナップショットが作成された時間。形式については、「StartTime」をご参照ください。

    2024-10-28T12:23:37.000+00:00
    DataSize

    integer

    バックアップデータのサイズ (バイト単位)。

    76085723136
    EndTime

    string

    バックアップが完了した時間。形式については、「StartTime」をご参照ください。

    2024-10-28T12:27:34.000+00:00
    ColdDataSize

    integer

    コールドデータのサイズ (バイト単位)。

    32413521
    InstanceType

    string

    インスタンスタイプ。

    列挙値:

    • Warehouse :

      コンピュートグループ版。

    • Standard :

      標準版。

    Warehouse
    InstanceRegion

    string

    インスタンスが存在するリージョン。

    cn-hangzhou
    SnapshotRegion

    string

    バックアップデータが保存されているリージョン。

    cn-hangzhou
    InstanceZoneId

    string

    インスタンスが存在するゾーン。

    cn-hangzhou-j
    SnapshotZoneId

    string

    バックアップデータが保存されているゾーン。ゾーン冗長ストレージを使用する場合、データは複数のゾーンにまたがって保存されます。このパラメーターは、それらのゾーンの 1 つを返します。

    cn-hangzhou-j
    InstanceName

    string

    インスタンス名。

    my-hologres-dw

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "4AA0C48F-B5BB-5FF9-A43B-6B91E0715D46",
  "BackupDataList": [
    {
      "BackupType": "redundant",
      "DataGran": "instance",
      "Id": 1780805690994479000,
      "InstanceId": "hgpostcn-cn-pe33jdxxxxx",
      "StartTime": "2024-10-28T11:19:56.000+00:00",
      "Status": "completed",
      "TriggerType": "scheduled",
      "DataDesc": "demo",
      "DataTime": "2024-10-28T12:23:37.000+00:00",
      "DataSize": 76085723136,
      "EndTime": "2024-10-28T12:27:34.000+00:00",
      "ColdDataSize": 32413521,
      "InstanceType": "Warehouse",
      "InstanceRegion": "cn-hangzhou",
      "SnapshotRegion": "cn-hangzhou",
      "InstanceZoneId": "cn-hangzhou-j",
      "SnapshotZoneId": "cn-hangzhou-j",
      "InstanceName": "my-hologres-dw"
    }
  ]
}

    エラーコード

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

    変更履歴

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