cat snapshots API

cat APIは、コマンドラインまたはKibanaコンソールを使用して人間が消費することを目的としています。アプリケーションによる使用は意図されていません。アプリケーションでの使用には、get snapshot APIを使用してください。

1つ以上のリポジトリに保存されているsnapshotsに関する情報を返します。スナップショットは、インデックスまたは実行中のElasticsearchクラスターのバックアップです。

Request

GET /_cat/snapshots/<repository>

GET /_cat/snapshots

Prerequisites

  • Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するには、monitor_snapshot、create_snapshot、またはmanage cluster privilegeが必要です。

Path parameters

  • <repository>
  • (オプション、文字列) リクエストを制限するために使用されるスナップショットリポジトリのカンマ区切りリスト。ワイルドカード式を受け入れます。_allはすべてのリポジトリを返します。
    リクエスト中にリポジトリが失敗した場合、Elasticsearchはエラーを返します。

Query parameters

  • format
  • (オプション、文字列) HTTP accept headerの短縮版。妥当な値にはJSON、YAMLなどが含まれます。
  • h
  • (オプション、文字列) 表示する列名のカンマ区切りリスト。
    どの列を含めるか指定しない場合、APIは以下にリストされたデフォルトの列を返します。1つ以上の列を明示的に指定した場合、指定された列のみを返します。
    妥当な列は:
    • id, snapshot
    • (デフォルト) スナップショットのID、例えばsnap1。
    • repository, re, repo
    • (デフォルト) リポジトリの名前、例えばrepo1。
    • status, s
    • (デフォルト) スナップショットプロセスの状態。返される値は:
      • FAILED: スナップショットプロセスが失敗しました。
      • INCOMPATIBLE: スナップショットプロセスが現在のクラスターのバージョンと互換性がありません。
      • IN_PROGRESS: スナップショットプロセスが開始されましたが、完了していません。
      • PARTIAL: スナップショットプロセスが部分的に成功しました。
      • SUCCESS: スナップショットプロセスが完全に成功しました。
    • start_epoch, ste, startEpoch
    • (デフォルト) スナップショットプロセスが開始されたUnix epoch time。
    • start_time, sti, startTime
    • (デフォルト) スナップショットプロセスが開始されたHH:MM:SS time。
    • end_epoch, ete, endEpoch
    • (デフォルト) スナップショットプロセスが終了したUnix epoch time。
    • end_time, eti, endTime
    • (デフォルト) スナップショットプロセスが終了したHH:MM:SS time。
    • duration, dur
    • (デフォルト) スナップショットプロセスが完了するのにかかった時間time units。
    • indices, i
    • (デフォルト) スナップショット内のインデックスの数。
    • successful_shards, ss
    • (デフォルト) スナップショット内の成功したシャードの数。
    • failed_shards, fs
    • (デフォルト) スナップショット内の失敗したシャードの数。
    • total_shards, ts
    • (デフォルト) スナップショット内のシャードの総数。
    • reason, r
    • スナップショットの失敗の理由。
  • help
  • (オプション、Boolean) trueの場合、レスポンスにはヘルプ情報が含まれます。デフォルトはfalseです。
  • ignore_unavailable
  • (オプション、Boolean) trueの場合、レスポンスには利用できないスナップショットの情報が含まれません。デフォルトはfalseです。
  • master_timeout
  • (オプション、time units) マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーを返します。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。
  • s
  • (オプション、文字列) レスポンスをソートするために使用される列名または列エイリアスのカンマ区切りリスト。
  • time
  • (オプション、time units) 時間値を表示するために使用される単位。
  • v
  • (オプション、Boolean) trueの場合、レスポンスには列見出しが含まれます。デフォルトはfalseです。

Examples

Python

  1. resp = client.cat.snapshots(
  2.    repository="repo1",
  3.    v=True,
  4.    s="id",
  5. )
  6. print(resp)

Js

  1. const response = await client.cat.snapshots({
  2.   repository: "repo1",
  3.   v: "true",
  4.   s: "id",
  5. });
  6. console.log(response);

Console

  1. GET /_cat/snapshots/repo1?v=true&s=id

APIは以下のレスポンスを返します:

Txt

  1. id     repository status start_epoch start_time end_epoch  end_time duration indices successful_shards failed_shards total_shards
  2. snap1  repo1      FAILED 1445616705  18:11:45   1445616978 18:16:18     4.6m       1                 4             1            5
  3. snap2  repo1      SUCCESS 1445634298  23:04:58   1445634672 23:11:12     6.2m       2                10             0           10