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。