cat repositories API
cat APIは、コマンドラインまたはKibanaコンソールを使用して人間が消費することを目的としています。アプリケーションによる使用は意図されていません。アプリケーションでの使用には、get snapshot repository APIを使用してください。
クラスターのsnapshot repositoriesを返します。
Request
GET /_cat/repositories
Prerequisites
- Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するには
monitor_snapshot
、create_snapshot
、またはmanage
クラスター権限が必要です。
Query parameters
format
- (オプション、文字列) HTTP accept headerの短縮版。 有効な値にはJSON、YAMLなどが含まれます。
h
- (オプション、文字列) 表示する列名のカンマ区切りリスト。
help
- (オプション、Boolean)
true
の場合、レスポンスにはヘルプ情報が含まれます。 デフォルトはfalse
です。 local
- (オプション、Boolean)
true
の場合、リクエストはローカルノードからのみ情報を取得します。 デフォルトはfalse
で、これはマスターノードから情報を取得することを意味します。 master_timeout
- (オプション、時間単位) マスターノードを待機する期間。 タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。 デフォルトは
30s
です。 リクエストが決してタイムアウトしないことを示すために-1
に設定することもできます。 s
- (オプション、文字列) レスポンスをソートするために使用される列名または列エイリアスのカンマ区切りリスト。
v
- (オプション、Boolean)
true
の場合、レスポンスには列見出しが含まれます。 デフォルトはfalse
です。
Examples
Python
resp = client.cat.repositories(
v=True,
)
print(resp)
Ruby
response = client.cat.repositories(
v: true
)
puts response
Js
const response = await client.cat.repositories({
v: "true",
});
console.log(response);
Console
GET /_cat/repositories?v=true
APIは次のレスポンスを返します:
Txt
id type
repo1 fs
repo2 s3