ListAllNode - Elasticsearch

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

要求標頭

該介面使用公用要求標頭，無特殊要求標頭。請參見公用請求參數文檔。

請求文法

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

請求參數

名稱

類型

位置

是否必選

樣本值

描述

InstanceId

String

Path

是

es-cn-tl32cpgwa002l****

執行個體ID。

extended

Boolean

Query

否

false

是否返回節點的監控資訊。可選值：

true（預設值）：返回
false：不返回

返回資料

名稱	類型	樣本值	描述
RequestId	String	0D71B597-F3FF-5B56-88D7-74F9D3F7****	請求ID。
Result	Array of Result		返回結果。
heapPercent	String	21.6%	JVM記憶體使用量率。
zoneId	String	cn-hangzhou-i	節點所在可用性區域。
cpuPercent	String	4.2%	CPU使用率。說明當extended為true且節點的監控資訊在同步時，參數值會返回null，此時需要等待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	一分鐘負載。
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****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

常見問題

Q：使用ListAllNode API，返回結果不完整，部分情況下沒有返回diskUsedPercent、cpuPercent、heapPercent等指標資訊，怎麼處理？

A：OpenAPI與Elasticsearch Client API不同，無法確保可即時擷取到叢集的所有指標狀態。例如當叢集負載高或不穩定時，會導致某些指標資訊無法返回。此時您可以使用Elasticsearch Client API擷取Elasticsearch叢集自身的指標資訊，詳細資料請參見通過用戶端訪問Elasticsearch。