catノード属性（cat nodeattrs）

cat nodeattrs API

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

カスタムノード属性に関する情報を返します。

Request

GET /_cat/nodeattrs

Prerequisites

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

Query parameters

• format
• （オプション、文字列）HTTP accept headerの短縮版。 有効な値にはJSON、YAMLなどが含まれます。
• h
• （オプション、文字列）表示する列名のカンマ区切りリスト。
  どの列を含めるかを指定しない場合、APIは以下にリストされたデフォルトの列を返します。1つ以上の列を明示的に指定した場合、指定された列のみが返されます。
  有効な列は：
  • node,name
  • （デフォルト）ノードの名前、例えばDKDM97B。
  • host, h
  • （デフォルト）ホスト名、例えばn1。
  • ip, i
  • （デフォルト）IPアドレス、例えば127.0.1.1。
  • attr, attr.name
  • （デフォルト）属性名、例えばrack。
  • value, attr.value
  • （デフォルト）属性値、例えばrack123。
  • id, nodeId
  • ノードのID、例えばk0zy。
  • pid, p
  • プロセスID、例えば13061。
  • port, po
  • バウンドトランスポートポート、例えば9300。
• help
• （オプション、ブール値）trueの場合、応答にはヘルプ情報が含まれます。デフォルトはfalseです。
• local
• （オプション、ブール値）trueの場合、リクエストはローカルノードからのみ情報を取得します。デフォルトはfalseで、これはマスターノードから情報を取得することを意味します。
• master_timeout
• （オプション、時間単位）マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。
• s
• （オプション、文字列）応答をソートするために使用される列名または列エイリアスのカンマ区切りリスト。
• v
• （オプション、ブール値）trueの場合、応答には列見出しが含まれます。デフォルトはfalseです。

Examples

Example with default columns

Python

resp = client.cat.nodeattrs(
   v=True,
)
print(resp)

Ruby

response = client.cat.nodeattrs(
  v: true
)
puts response

Js

const response = await client.cat.nodeattrs({
  v: "true",
});
console.log(response);

Console

GET /_cat/nodeattrs?v=true

APIは以下の応答を返します：

Txt

node    host      ip        attr     value
...
node-0 127.0.0.1 127.0.0.1 testattr test
...

### Example with explicit columns
以下のAPIリクエストは、`````name`````、`````pid`````、`````attr`````、および`````value`````列を返します。
#### Python
``````python
resp = client.cat.nodeattrs(
   v=True,
   h="name,pid,attr,value",
)
print(resp)
`

Ruby

response = client.cat.nodeattrs(
  v: true,
  h: 'name,pid,attr,value'
)
puts response

Js

const response = await client.cat.nodeattrs({
  v: "true",
  h: "name,pid,attr,value",
});
console.log(response);

Console

GET /_cat/nodeattrs?v=true&h=name,pid,attr,value

APIは以下の応答を返します：

Txt

name    pid   attr     value
...
node-0 19566 testattr test
...