スナップショットのマウント（Mount snapshot）

スナップショットのマウントAPI

スナップショットを検索可能なスナップショットインデックスとしてマウントします。

リクエスト

POST /_snapshot/<repository>/<snapshot>/_mount

前提条件

Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するには、manageクラスター権限と、含まれるインデックスのmanageインデックス権限が必要です。詳細については、セキュリティ権限を参照してください。

説明

パスパラメータ

• <repository>
• （必須、文字列）マウントするインデックスのスナップショットを含むリポジトリの名前。
• <snapshot>
• （必須、文字列）マウントするインデックスのスナップショットの名前。

クエリパラメータ

• master_timeout
• （オプション、時間単位）マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。
• wait_for_completion
• （オプション、Boolean）trueの場合、リクエストは操作が完了するまでブロックされます。デフォルトはfalseです。
• storage
• （オプション、文字列）検索可能なスナップショットインデックスのマウントオプション。可能な値は：
  • full_copy（デフォルト）
  • 完全にマウントされたインデックス。
  • shared_cache
  • 部分的にマウントされたインデックス。

リクエストボディ

• index
• （必須、文字列）マウントするデータを含むスナップショット内のインデックスの名前。

-   `````renamed_index

• （オプション、文字列）作成されるインデックスの名前。
• index_settings
• （オプション、オブジェクト）マウント時にインデックスに追加される設定。
• ignore_index_settings
• （オプション、文字列の配列）マウント時にインデックスから削除される設定の名前。

例

#### Python
``````python
resp = client.searchable_snapshots.mount(
   repository="my_repository",
   snapshot="my_snapshot",
   wait_for_completion=True,
   index="my_docs",
   renamed_index="docs",
   index_settings={
   "index.number_of_replicas": 0
   },
   ignore_index_settings=[
   "index.refresh_interval"
   ],
)
print(resp)
`

Js

const response = await client.searchableSnapshots.mount({
  repository: "my_repository",
  snapshot: "my_snapshot",
  wait_for_completion: "true",
  index: "my_docs",
  renamed_index: "docs",
  index_settings: {
   "index.number_of_replicas": 0,
  },
  ignore_index_settings: ["index.refresh_interval"],
});
console.log(response);

コンソール

POST /_snapshot/my_repository/my_snapshot/_mount?wait_for_completion=true
{
  "index": "my_docs",
  "renamed_index": "docs",
  "index_settings": {
   "index.number_of_replicas": 0
  },
  "ignore_index_settings": [ "index.refresh_interval" ]
}