スナップショットを使用したコレクションのバックアップ

スナップショットは、災害対策機能を提供する Amazon OpenSearch Serverless コレクションのpoint-in-timeバックアップです。OpenSearch Serverless は、コレクションのスナップショットを自動的に作成および管理し、ビジネス継続性とデータ保護を確保します。各スナップショットには以下が含まれます。

インデックスメタデータ: インデックスの設定とマッピング
クラスターメタデータ: インデックステンプレートとエイリアス
インデックスデータ: インデックスに保存されているすべてのドキュメントとデータ

主な利点

手動設定を必要としない時間単位の自動バックアップ
メンテナンスオーバーヘッドゼロ
追加のストレージコストなし
偶発的なデータ損失からの迅速な復旧
スナップショットから特定のインデックスを復元する機能

重要な考慮事項

スナップショットの作成は即時ではなく、完了するまでに時間がかかります。
スナップショット作成時の新しいドキュメントや更新は、スナップショットに含まれない場合があります。
スナップショットは元のコレクションにのみ復元でき、新しいコレクションには復元できません。
復元すると、インデックスは元のバージョンとは異なる新しい UUIDs を受け取ります。
一度に実行できる復元オペレーションは 1 つだけです。
同じコレクションで複数の復元オペレーションを同時に開始することはできません。アクティブな復元オペレーション中にインデックスを復元しようとすると、オペレーションは失敗します。
復元オペレーション中、インデックスへのリクエストは失敗します。

必要なアクセス許可

スナップショットを使用するには、データアクセスポリシーで次のアクセス許可を設定します。データアクセスポリシーの詳細については、「」を参照してくださいデータアクセスポリシーと IAM ポリシーの比較。

データアクセスポリシー API

aoss:DescribeSnapshot

データアクセスポリシー	API
aoss:DescribeSnapshot	GET /_cat/snapshots GET /_cat/snapshots/aoss-automated/ GET _snapshot/aoss-automated/`snapshot`/
aoss:RestoreSnapshot	POST /_snapshot/aoss-automated/`snapshot`/_restore
aoss:DescribeCollectionItems	GET /_cat/recovery

GET /_cat/snapshots

GET /_cat/snapshots/aoss-automated/

GET _snapshot/aoss-automated/snapshot/

aoss:RestoreSnapshot POST /_snapshot/aoss-automated/snapshot/_restore

aoss:DescribeCollectionItems GET /_cat/recovery

ポリシーは、次の AWS CLI コマンドを使用して設定できます。

アクセスポリシーを作成するための CLI コマンドの例を次に示します。


aws opensearchserverless create-access-policy \
--type data \
--name AWSExample-data-access-policy \
--region us-west-2 \
--policy '[
  {
    "Rules": [
      {
        "Resource": [
          "collection/AWSExample-collection"
        ],
        "Permission": [
          "aoss:DescribeSnapshot",
          "aoss:RestoreSnapshot",
          "aoss:DescribeCollectionItems"
        ],
        "ResourceType": "collection"
      }
    ],
    "Principal": [
      "arn:aws:iam::AWSExample-account-ID:user/AWSExample-user"
    ],
    "Description": "Data policy to support snapshot operations."
  }
]'

スナップショットの使用

デフォルトでは、新しいコレクションを作成すると、OpenSearch Serverless は 1 時間ごとにスナップショットを自動的に作成します。ユーザー操作は必要はありません。各スナップショットには、コレクション内のすべてのインデックスが含まれます。OpenSearch Serverless がスナップショットを作成したら、次のコマンドを使用してスナップショットを一覧表示し、スナップショットの詳細を表示できます。

スナップショットの一覧表示

次のコマンドを使用して、コレクション内のすべてのスナップショットを一覧表示します。


GET /_cat/snapshots/aoss-automated/

OpenSearch Serverless は次のようなレスポンスを返します。



id                                 status  start_epoch start_time end_epoch  end_time    duration    indices successful_shards failed_shards total_shards
snapshot-AWSExampleSnapshotID1     SUCCESS 1737964331  07:52:11   1737964382 07:53:02    50.4s       1                                             
snapshot-AWSExampleSnapshotID2     SUCCESS 1737967931  08:52:11   1737967979 08:52:59    47.7s       2                                             
snapshot-AWSExampleSnapshotID3     SUCCESS 1737971531  09:52:11   1737971581 09:53:01    49.1s       3                                             
snapshot-AWSExampleSnapshotID4 IN_PROGRESS 1737975131  10:52:11   -          -            4.8d       3

スナップショットの取得

スナップショットに関する情報を取得します。


GET _snapshot/aoss-automated/snapshot/

リクエストの例


GET _snapshot/aoss-automated/snapshot-AWSExampleSnapshotID1/

レスポンスの例


{
    "snapshots": [
        {
            "snapshot": "snapshot-AWSExampleSnapshotID1-5e01-4423-9833Example",
            "uuid": "AWSExample-5e01-4423-9833-9e9eb757Example",
            "version_id": 136327827,
            "version": "2.11.0",
            "remote_store_index_shallow_copy": true,
            "indices": [
                "AWSExample-index-0117"
            ],
            "data_streams": [],
            "include_global_state": true,
            "metadata": {},
            "state": "SUCCESS",
            "start_time": "2025-01-27T09:52:11.953Z",
            "start_time_in_millis": 1737971531953,
            "end_time": "2025-01-27T09:53:01.062Z",
            "end_time_in_millis": 1737971581062,
            "duration_in_millis": 49109,
            "failures": [],
            "shards": {
                "total": 0,
                "failed": 0,
                "successful": 0
            }
        }
    ]
}

スナップショットレスポンスフィールドについて

id

スナップショットオペレーションの一意の識別子。

ステータス

スナップショットオペレーションの現在の状態。可能な値は以下のとおりです:

SUCCESS
IN_PROGRESS

duration

スナップショットオペレーションの完了にかかった時間。

インデックス

スナップショットに含まれるインデックスの数。

スナップショットからの復元

スナップショットから復元すると、以前に取得したバックアップからデータを復元できます。このプロセスは、OpenSearch Serverless でのディザスタリカバリとデータ管理に不可欠です。

重要な考慮事項

復元されたインデックスは、元のバージョンとは異なる UUIDs を持ちます。
スナップショットは元のコレクションにのみ復元できます。クロスコレクション復元はサポートされていません。
復元オペレーションは、クラスターのパフォーマンスに影響を与える可能性があります。変化に応じて計画を立てましょう。

スナップショットからバックアップされたインデックスを復元するには

次のコマンドを実行して、適切なスナップショットを特定します。
```
GET /_snapshot/aoss-automated/_all
```
スナップショットの小さなリストについては、次のコマンドを実行します。
```
GET /_cat/snapshots/aoss-automated/
```
復元する前に、次のコマンドを実行してスナップショットの詳細を確認します。
```
GET _snapshot/aoss-automated/snapshot-AWSExampleSnapshotID1/
```

次のコマンドを実行して、特定のスナップショットから復元します。


POST /_snapshot/aoss-automated/snapshot-ID/_restore

復元オペレーションをカスタマイズするには、リクエスト本文を含めます。以下に例を示します。


POST /_snapshot/aoss-automated/snapshot-AWSExampleSnapshotID1-5e01-4423-9833Example/_restore
{
  "indices": "opensearch-dashboards*,my-index*",
  "ignore_unavailable": true,
  "include_global_state": false,
  "include_aliases": false,
  "rename_pattern": "opensearch-dashboards(.+)",
  "rename_replacement": "restored-opensearch-dashboards$1"
}

復元の進行状況を表示するには、次のコマンドを実行します。
```
GET /_cat/recovery
```

注記

リクエスト本文を含むコマンドを使用してスナップショットを復元する場合、次のパラメータを使用して復元動作を制御できます。

インデックス: 復元するインデックスを指定します。このパラメータはワイルドカードパターンをサポートします。
ignore_unavailable: スナップショット内のインデックスが欠落している場合でも、復元オペレーションを続行できます。
include_global_state: クラスターの状態を復元するかどうかを決定します。
include_aliases: 関連付けられたエイリアスを復元するかどうかを制御します。
rename_pattern と rename_replacement: 復元オペレーション中にインデックスの名前を変更できます。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

CloudFormation を使用したコレクションの作成

キャパシティ制限の管理