調(diào)用ListAllNode，獲取集群下的所有節(jié)點(diǎn)信息。

調(diào)試

您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。

請(qǐng)求頭

該接口使用公共請(qǐng)求頭，無特殊請(qǐng)求頭。請(qǐng)參見公共請(qǐng)求參數(shù)文檔。

請(qǐng)求語法

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

請(qǐng)求參數(shù)

名稱 類型 位置 是否必選 示例值 描述
InstanceId String Path 是 es-cn-tl32cpgwa002l****

實(shí)例ID。
extended Boolean Query 否 false

是否返回節(jié)點(diǎn)的監(jiān)控信息。可選值：

  • true（默認(rèn)值）：返回
  • false：不返回

返回?cái)?shù)據(jù)

名稱 類型 示例值 描述
RequestId String 0D71B597-F3FF-5B56-88D7-74F9D3F7****

請(qǐng)求ID。
Result Array of Result

返回結(jié)果。
heapPercent String 21.6%

JVM內(nèi)存使用率。
zoneId String cn-hangzhou-i

節(jié)點(diǎn)所在可用區(qū)。
cpuPercent String 4.2%

CPU使用率。

說明 當(dāng)extended為true且節(jié)點(diǎn)的監(jiān)控信息在同步時(shí)，參數(shù)值會(huì)返回null，此時(shí)需要等待10秒重新發(fā)送請(qǐng)求獲取該值。
host String 10.15.XX.XX

節(jié)點(diǎn)IP。
nodeType String WORKER

節(jié)點(diǎn)類型，支持：

  • MASTER：專有主節(jié)點(diǎn)
  • WORKER：熱節(jié)點(diǎn)
  • WORKER_WARM：冷節(jié)點(diǎn)
  • COORDINATING：協(xié)調(diào)節(jié)點(diǎn)
  • KIBANA：Kibana節(jié)點(diǎn)
diskUsedPercent String 1.0%

磁盤使用率。
port Integer 9200

節(jié)點(diǎn)訪問端口。
loadOneM String 0.12

一分鐘負(fù)載。
health String GREEN

節(jié)點(diǎn)健康狀態(tài)。支持：GREEN、YELLOW、RED和GRAY。

示例

請(qǐng)求示例

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****"
}

錯(cuò)誤碼

訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。

常見問題

Q：使用ListAllNode API，返回結(jié)果不完整，部分情況下沒有返回diskUsedPercent、cpuPercent、heapPercent等指標(biāo)信息，怎么處理？

A：OpenAPI與Elasticsearch Client API不同，無法確保可實(shí)時(shí)獲取到集群的所有指標(biāo)狀態(tài)。例如當(dāng)集群負(fù)載高或不穩(wěn)定時(shí)，會(huì)導(dǎo)致某些指標(biāo)信息無法返回。此時(shí)您可以使用Elasticsearch Client API獲取Elasticsearch集群自身的指標(biāo)信息，詳細(xì)信息請(qǐng)參見通過客戶端訪問阿里云Elasticsearch。