シャットダウンAPIを取得（Get shutdown API）

シャットダウンAPIの取得

この機能は、Elasticsearch Service、Elastic Cloud Enterprise、およびElastic Cloud on Kubernetesによる間接的な使用を目的としています。直接の使用はサポートされていません。

シャットダウンの準備が進められているノードの状態を取得します。

リクエスト

GET _nodes/shutdown

GET _nodes/<node-id>/shutdown

前提条件

• Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するにはmanage クラスター権限が必要です。
• オペレーター権限機能が有効になっている場合、このAPIを使用するにはオペレーターである必要があります。

説明

ノードがシャットダウンの準備が整っているか、シャットダウンの準備が進行中または停止しているかを示します。シャットダウンプロセスの各部分の状態情報を返します。put shutdownを呼び出した後にシャットダウンプロセスを監視するために使用します。

パスパラメータ

• <node-id>
• （オプション、文字列）シャットダウンの準備が進められているノードのID。IDが指定されていない場合、シャットダウンの準備が進められているすべてのノードの状態を返します。

例

ノードを再起動するために準備します:

Python

resp = client.shutdown.put_node(
   node_id="USpTGYaBSIKbgSUJR2Z9lg",
   type="restart",
   reason="Demonstrating how the node shutdown API works",
   allocation_delay="10m",
)
print(resp)

Ruby

response = client.shutdown.put_node(
  node_id: 'USpTGYaBSIKbgSUJR2Z9lg',
  body: {
   type: 'restart',
   reason: 'Demonstrating how the node shutdown API works',
   allocation_delay: '10m'
  }
)
puts response

Js

const response = await client.shutdown.putNode({
  node_id: "USpTGYaBSIKbgSUJR2Z9lg",
  type: "restart",
  reason: "Demonstrating how the node shutdown API works",
  allocation_delay: "10m",
});
console.log(response);

コンソール

PUT /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown
{
  "type": "restart",
  "reason": "Demonstrating how the node shutdown API works",
  "allocation_delay": "10m"
}

シャットダウンの準備の状態を取得します:

Python

resp = client.shutdown.get_node(
   node_id="USpTGYaBSIKbgSUJR2Z9lg",
)
print(resp)

Ruby

response = client.shutdown.get_node(
  node_id: 'USpTGYaBSIKbgSUJR2Z9lg'
)
puts response

Js

const response = await client.shutdown.getNode({
  node_id: "USpTGYaBSIKbgSUJR2Z9lg",
});
console.log(response);

コンソール

GET /_nodes/USpTGYaBSIKbgSUJR2Z9lg/shutdown

レスポンスは、シャットダウンの準備に関する情報を示し、シャードの移行、タスクの移行、およびプラグインのクリーンアップの状態を含みます:

コンソール-結果

{
   "nodes": [
   {
   "node_id": "USpTGYaBSIKbgSUJR2Z9lg",
   "type": "RESTART",
   "reason": "Demonstrating how the node shutdown API works",
   "shutdown_startedmillis": 1624406108685,
   "allocation_delay": "10m",
   "status": "COMPLETE",
   "shard_migration": {
   "status": "COMPLETE",
   "shard_migrations_remaining": 0,
   "explanation": "no shard relocation is necessary for a node restart"
   },
   "persistent_tasks": {
   "status": "COMPLETE"
   },
   "plugins": {
   "status": "COMPLETE"
   }
   }
   ]
}