ListAllNode - Elasticsearch - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. Il génère dynamiquement des exemples de code pour différents SDK.

En-têtes de requête

L'opération ListAllNode ne possède pas d'en-têtes de requête spécifiques et utilise uniquement les en-têtes communs. Pour plus d'informations, consultez la section En-têtes de requête communs.

Syntaxe de la requête

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

Paramètres de requête

Parameter

Type

Position

Required

Example

Description

InstanceId

String

Path

Yes

es-cn-tl32cpgwa002l****

ID de l'instance.

extended

Boolean

Query

No

false

Indique si les informations de surveillance des nœuds du cluster doivent être renvoyées. Valeur par défaut : false. Valeurs valides :

true (par défaut) : renvoie les informations
false

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	0D71B597-F3FF-5B56-88D7-74F9D3F7****	ID de la requête.
Result	Array of Result		Résultats renvoyés.
heapPercent	String	21.6%	Utilisation de la mémoire heap de la machine virtuelle Java (JVM) du nœud.
zoneId	String	cn-hangzhou-i	ID de la zone du nœud.
cpuPercent	String	4.2%	Utilisation du processeur. Remarque Si le paramètre de requête extended est défini sur true et que les informations de surveillance des nœuds du cluster sont en cours de synchronisation, la valeur du paramètre cpuPercent est nulle. Dans ce cas, renvoyez une requête après 10 secondes pour obtenir la valeur du paramètre cpuPercent.
host	String	10.15.XX.XX	Adresse IP du nœud.
nodeType	String	WORKER	Type de nœud. Valeurs valides : MASTER : nœud maître dédié WORKER : nœud chaud WORKER_WARM : nœud froid COORDINATING : nœud client KIBANA : nœud Kibana
diskUsedPercent	String	1.0%	Utilisation du disque.
port	Integer	9200	Port utilisé pour se connecter au nœud.
loadOneM	String	0.12	Charge du nœud sur 1 minute.
health	String	GREEN	État de santé du nœud. Valeurs valides : GREEN, YELLOW, RED et GRAY.

Exemples

Exemple de requête

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

Exemple de réponse réussie

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

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs API.

FAQ

Q : Lors de l'utilisation de l'API ListAllNode, les résultats renvoyés sont incomplets. Dans certains cas, aucune métrique telle que diskUsedPercent, cpuPercent ou heapPercent n'est renvoyée. Que faire ?

R : Contrairement à l'API Client Elasticsearch, OpenAPI ne garantit pas l'obtention en temps réel de l'état de toutes les métriques d'un cluster. Par exemple, lorsque la charge du cluster est élevée ou instable, certaines informations de métriques peuvent ne pas être renvoyées. Dans ce cas, utilisez l'API Client Elasticsearch pour obtenir les métriques du cluster Elasticsearch lui-même. Pour plus d'informations, consultez la section Accès à Alibaba Cloud Elasticsearch via un client.