ListAllNode - Elasticsearch - Alibaba Cloud ドキュメントセンター

Elasticsearch クラスタ内のすべてのノードの情報をクエリします。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストヘッダー

GetLogs 操作には操作固有のリクエストヘッダーはなく、共通リクエストヘッダーのみを使用します。詳細については、「共通リクエストヘッダー」をご参照ください。

リクエスト構文

GET /openapi/instances/{InstanceId}/nodes HTTP/1.1

リクエストパラメータ

パラメータ

タイプ

位置

必須

例

説明

InstanceId

String

Path

はい

es-cn-tl32cpgwa002l****

インスタンス ID。

extended

ブール値

Query

いいえ

false

クラスタ内のノードの監視情報を返すかどうかを指定します。デフォルト値: いいえ。有効な値:

true (デフォルト): 返す
false

レスポンスパラメータ

パラメータ	タイプ	例	説明
RequestId	String	0D71B597-F3FF-5B56-88D7-74F9D3F7****	リクエスト ID。
Result	Result の配列		戻り値。
heapPercent	String	21.6%	ノードの Java 仮想マシン ( JVM ) ヒープメモリ使用量。
zoneId	String	cn-hangzhou-i	ノードのゾーン ID。
cpuPercent	String	4.2%	CPU 使用率。説明 extended リクエストパラメータが true に設定されていて、クラスタ内のノードの監視情報が同期されている場合、cpuPercent パラメータの値は null になります。この場合、cpuPercent パラメータの値を取得するには、10 秒後にリクエストを再送信する必要があります。
host	String	10.15.XX.XX	ノードの IP アドレス。
nodeType	String	WORKER	ノードのタイプ。有効な値: MASTER: 専用マスターノード WORKER: ホットノード WORKER_WARM: ウォームノード COORDINATING: クライアントノード KIBANA: Kibana ノード
diskUsedPercent	String	1.0%	ディスク使用量。
port	Integer	9200	ノードへの接続に使用するポート。
loadOneM	String	0.12	ノードの 1 分間の負荷。
health	String	GREEN	ノードのヘルスステータス。有効な値: GREEN、YELLOW、RED、GRAY。

例

リクエストの例

GET /openapi/instances/es-cn-tl32cpgwa002l****/nodes HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

成功レスポンスの例

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : [ {
    "nodeType" : "WORKER",
    "host" : "10.15.XX.XX",
    "port" : 9200,
    "zoneId" : "cn-hangzhou-i",
    "heapPercent" : "21.6%",
    "cpuPercent" : "4.2%",
    "loadOneM" : "0.12",
    "diskUsedPercent" : "1.0%",
    "health" : "GREEN"
  }, {
    "nodeType" : "WORKER",
    "host" : "10.15.XX.XX",
    "port" : 9200,
    "zoneId" : "cn-hangzhou-i",
    "heapPercent" : "23.3%",
    "cpuPercent" : "3.6%",
    "loadOneM" : "0.04",
    "diskUsedPercent" : "1.0%",
    "health" : "GREEN"
  }, {
    "nodeType" : "WORKER",
    "host" : "10.15.XX.XX",
    "port" : 9200,
    "zoneId" : "cn-hangzhou-i",
    "heapPercent" : "18.3%",
    "cpuPercent" : "2.7%",
    "loadOneM" : "0.08",
    "diskUsedPercent" : "1.0%",
    "health" : "GREEN"
  }, {
    "nodeType" : "KIBANA",
    "host" : "10.15.XX.XX",
    "port" : 5601,
    "zoneId" : "cn-hangzhou-i",
    "health" : "GREEN"
  } ],
  "RequestId" : "0D71B597-F3FF-5B56-88D7-74F9D3F7****"
}

エラーコード

エラーコードの一覧については、API エラーセンターをご覧ください。

よくある質問

Q: ListAllNode API を使用すると、返される結果が不完全になります。場合によっては、diskUsedPercent、cpuPercent、heapPercent などのメトリックが返されません。どうすればよいですか?

A: Elasticsearch Client API とは異なり、OpenAPI はクラスタのすべてのメトリックのステータスをリアルタイムで取得できることを保証できません。たとえば、クラスタの負荷が高い場合や不安定な場合、一部のメトリック情報は返されません。この場合、Elasticsearch Client API を使用して、Elasticsearch クラスタ自体のメトリックを取得できます。詳細については、「クライアントから Alibaba Cloud Elasticsearch にアクセスする」をご参照ください。