クラスタAPI

ノード仕様

いくつかのクラスタレベルのAPIは、ノードフィルターを使用して指定できるノードのサブセットで操作することがあります。たとえば、タスク管理、ノード統計、およびノード情報 APIは、すべてのノードからではなく、フィルタリングされたノードのセットから結果を報告できます。

ノードフィルターは、個々のフィルターのカンマ区切りリストとして記述され、各フィルターは選択されたサブセットからノードを追加または削除します。各フィルターは次のいずれかです：

  • _all、サブセットにすべてのノードを追加します。
  • _local、サブセットにローカルノードを追加します。
  • _master、サブセットに現在選出されたマスターノードを追加します。
  • ノードIDまたは名前、サブセットにこのノードを追加します。
  • IPアドレスまたはホスト名、サブセットにすべての一致するノードを追加します。
  • パターン、*ワイルドカードを使用して、名前、アドレス、またはホスト名がパターンに一致するすべてのノードをサブセットに追加します。
  • master:true、data:true、ingest:true、voting_only:true、ml:true、またはcoordinating_only:true、それぞれすべてのマスターノード候補、すべてのデータノード、すべてのインジェストノード、すべての投票専用ノード、すべての機械学習ノード、およびすべてのコーディネート専用ノードをサブセットに追加します。
  • master:false、data:false、ingest:false、voting_only:false、ml:false、またはcoordinating_only:false、それぞれすべてのマスターノード候補、すべてのデータノード、すべてのインジェストノード、すべての投票専用ノード、すべての機械学習ノード、およびすべてのコーディネート専用ノードをサブセットから削除します。
  • パターンのペア、*ワイルドカードを使用して、attrname:attrvalueの形式で、名前と値がそれぞれのパターンに一致するカスタムノード属性を持つすべてのノードをサブセットに追加します。カスタムノード属性は、node.attr.attrname: attrvalueの形式の設定ファイルでプロパティを設定することによって構成されます。

ノードフィルターは、与えられた順序で実行されます。これは、セットからノードを削除するフィルターを使用する場合に重要です。たとえば、_all,master:falseはマスターノード候補を除くすべてのノードを意味しますが、master:false,_allは_allと同じ意味になります。なぜなら、_allフィルターはmaster:falseフィルターの後に実行されるからです。

フィルターが指定されていない場合、デフォルトはすべてのノードを選択することです。ただし、フィルターが指定されている場合、それらは空の選択されたサブセットから開始して実行されます。これは、master:falseのようなフィルターが選択されたサブセットからノードを削除する場合、他のフィルターの後に来る場合にのみ有用であることを意味します。単独で使用されると、master:falseはノードを選択しません。

以下は、ノード情報 APIでのノードフィルターの使用例です。

Python

  1. resp = client.nodes.info()
  2. print(resp)
  4. resp1 = client.nodes.info(
  5.    node_id="_all",
  6. )
  7. print(resp1)
  9. resp2 = client.nodes.info(
  10.    node_id="_local",
  11. )
  12. print(resp2)
  14. resp3 = client.nodes.info(
  15.    node_id="_master",
  16. )
  17. print(resp3)
  19. resp4 = client.nodes.info(
  20.    node_id="node_name_goes_here",
  21. )
  22. print(resp4)
  24. resp5 = client.nodes.info(
  25.    node_id="node_name_goes_*",
  26. )
  27. print(resp5)
  29. resp6 = client.nodes.info(
  30.    node_id="10.0.0.3,10.0.0.4",
  31. )
  32. print(resp6)
  34. resp7 = client.nodes.info(
  35.    node_id="10.0.0.*",
  36. )
  37. print(resp7)
  39. resp8 = client.nodes.info(
  40.    node_id="_all,master:false",
  41. )
  42. print(resp8)
  44. resp9 = client.nodes.info(
  45.    node_id="data:true,ingest:true",
  46. )
  47. print(resp9)
  49. resp10 = client.nodes.info(
  50.    node_id="coordinating_only:true",
  51. )
  52. print(resp10)
  54. resp11 = client.nodes.info(
  55.    node_id="master:true,voting_only:false",
  56. )
  57. print(resp11)
  59. resp12 = client.nodes.info(
  60.    node_id="rack:2",
  61. )
  62. print(resp12)
  64. resp13 = client.nodes.info(
  65.    node_id="ra*:2",
  66. )
  67. print(resp13)
  69. resp14 = client.nodes.info(
  70.    node_id="ra*:2*",
  71. )
  72. print(resp14)

Ruby

  1. response = client.nodes.info
  2. puts response
  4. response = client.nodes.info(
  5.   node_id: '_all'
  6. )
  7. puts response
  9. response = client.nodes.info(
  10.   node_id: '_local'
  11. )
  12. puts response
  14. response = client.nodes.info(
  15.   node_id: '_master'
  16. )
  17. puts response
  19. response = client.nodes.info(
  20.   node_id: 'node_name_goes_here'
  21. )
  22. puts response
  24. response = client.nodes.info(
  25.   node_id: 'node_name_goes_*'
  26. )
  27. puts response
  29. response = client.nodes.info(
  30.   node_id: '10.0.0.3,10.0.0.4'
  31. )
  32. puts response
  34. response = client.nodes.info(
  35.   node_id: '10.0.0.*'
  36. )
  37. puts response
  39. response = client.nodes.info(
  40.   node_id: '_all,master:false'
  41. )
  42. puts response
  44. response = client.nodes.info(
  45.   node_id: 'data:true,ingest:true'
  46. )
  47. puts response
  49. response = client.nodes.info(
  50.   node_id: 'coordinating_only:true'
  51. )
  52. puts response
  54. response = client.nodes.info(
  55.   node_id: 'master:true,voting_only:false'
  56. )
  57. puts response
  59. response = client.nodes.info(
  60.   node_id: 'rack:2'
  61. )
  62. puts response
  64. response = client.nodes.info(
  65.   node_id: 'ra*:2'
  66. )
  67. puts response
  69. response = client.nodes.info(
  70.   node_id: 'ra*:2*'
  71. )
  72. puts response

Js

  1. const response = await client.nodes.info();
  2. console.log(response);
  4. const response1 = await client.nodes.info({
  5.   node_id: "_all",
  6. });
  7. console.log(response1);
  9. const response2 = await client.nodes.info({
  10.   node_id: "_local",
  11. });
  12. console.log(response2);
  14. const response3 = await client.nodes.info({
  15.   node_id: "_master",
  16. });
  17. console.log(response3);
  19. const response4 = await client.nodes.info({
  20.   node_id: "node_name_goes_here",
  21. });
  22. console.log(response4);
  24. const response5 = await client.nodes.info({
  25.   node_id: "node_name_goes_*",
  26. });
  27. console.log(response5);
  29. const response6 = await client.nodes.info({
  30.   node_id: "10.0.0.3,10.0.0.4",
  31. });
  32. console.log(response6);
  34. const response7 = await client.nodes.info({
  35.   node_id: "10.0.0.*",
  36. });
  37. console.log(response7);
  39. const response8 = await client.nodes.info({
  40.   node_id: "_all,master:false",
  41. });
  42. console.log(response8);
  44. const response9 = await client.nodes.info({
  45.   node_id: "data:true,ingest:true",
  46. });
  47. console.log(response9);
  49. const response10 = await client.nodes.info({
  50.   node_id: "coordinating_only:true",
  51. });
  52. console.log(response10);
  54. const response11 = await client.nodes.info({
  55.   node_id: "master:true,voting_only:false",
  56. });
  57. console.log(response11);
  59. const response12 = await client.nodes.info({
  60.   node_id: "rack:2",
  61. });
  62. console.log(response12);
  64. const response13 = await client.nodes.info({
  65.   node_id: "ra*:2",
  66. });
  67. console.log(response13);
  69. const response14 = await client.nodes.info({
  70.   node_id: "ra*:2*",
  71. });
  72. console.log(response14);

コンソール

  3. # フィルターが指定されていない場合、デフォルトはすべてのノードを選択することです
  5. GET /_nodes
  8. # すべてのノードを明示的に選択する
  10. GET /_nodes/_all
  13. # ローカルノードのみを選択する
  15. GET /_nodes/_local
  18. # 選出されたマスターノードを選択する
  20. GET /_nodes/_master
  23. # 名前でノードを選択する（ワイルドカードを含むことができます）
  25. GET /_nodes/node_name_goes_here
  26. GET /_nodes/node_name_goes_*
  29. # アドレスでノードを選択する（ワイルドカードを含むことができます）
  31. GET /_nodes/10.0.0.3,10.0.0.4
  32. GET /_nodes/10.0.0.*
  35. # 役割でノードを選択する
  37. GET /_nodes/_all,master:false
  38. GET /_nodes/data:true,ingest:true
  39. GET /_nodes/coordinating_only:true
  40. GET /_nodes/master:true,voting_only:false
  43. # カスタム属性でノードを選択する（例：設定ファイルに`node.attr.rack: 2`のようなものがある場合）
  45. GET /_nodes/rack:2
  46. GET /_nodes/ra*:2
  47. GET /_nodes/ra*:2*