ListInstance - Lister les instances Elasticsearch - Elasticsearch

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer.

En-têtes de requête

Cette opération utilise uniquement des en-têtes de requête communs, comme décrit dans la rubrique Paramètres communs.

Syntaxe

GET /openapi/instances HTTP/1.1

Paramètres de requête

Parameter	Type	Position	Required	Example	Description
page	Integer	Query	No.	1	Numéro de page. Commence à 1. Valeur par défaut : 1.
size	Integer	Query	No.	10	Nombre d'entrées par page. Maximum : 100. Valeur par défaut : 10.
description	String	Query	No.	aliyunes_test1	Nom de l'instance. La correspondance floue est prise en charge. Par exemple, la recherche de abc renvoie les instances nommées abc, abcde, xyabc et xabcy.
instanceId	String	Query	No.	es-cn-v641a0ta3000g****	ID de l'instance.
esVersion	String	Query	No.	6.7_with_X-Pack	Version de l'instance.
resourceGroupId	String	Query	No.	rg-aekzvowej3i****	ID du groupe de ressources.
tags	String	Query	No.	[{"tagKey":"key1","tagValue":"value1"}]	Tags de l'instance.
vpcId	String	Query	No.	vpc-bp16k1dvzxtmagcva****	ID du VPC de l'instance.
zoneId	String	Query	No.	cn-hangzhou-i	ID de la zone de l'instance.
paymentType	String	Query	No.	postpaid	Méthode de facturation de l'instance. Valeurs possibles : postpaid : paiement à l'utilisation prepaid : abonnement
instanceCategory	String	Query	No.	advanced	Édition du cluster Elasticsearch. Valeurs possibles : x-pack : Standard Edition advanced/IS : Enhanced Edition community : Basic Edition

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****	ID de la requête.
Headers	Object		En-têtes de réponse.
X-Total-Count	Integer	10	Nombre d'entrées renvoyées par page.
Result	Array of Instance		Instances renvoyées.
advancedDedicateMaster	Boolean	false	Indique si des nœuds maîtres dédiés sont inclus. Valeurs possibles : true : Le répertoire contient des fichiers stockés dans la classe de stockage Archive. false : Le répertoire ne contient pas de fichiers stockés dans la classe de stockage Archive.
nodeAmount	Integer	2	Nombre de nœuds de données.
createdAt	String	2018-07-13T03:58:07.253Z	Date de création de l'instance.
status	String	active	État de l'instance. Valeurs possibles : active : le cluster est normal. activating : le cluster est en cours d'activation. Inactive : le cluster est gelé. invalid : le cluster n'existe pas ou n'est pas accessible. Dans ce cas, certains champs de la réponse peuvent être manquants, tels que domain et kibanaDomain. unknown : le cluster n'existe pas ou n'est pas accessible. Dans ce cas, certains champs de la réponse peuvent être manquants, tels que domain et kibanaDomain.
dedicateMaster	Boolean	false	Indique si des nœuds maîtres dédiés sont inclus (obsolète). Valeurs possibles : true : Le répertoire contient des fichiers stockés dans la classe de stockage Archive. false : Le répertoire ne contient pas de fichiers stockés dans la classe de stockage Archive.
serviceVpc	Boolean	true	Indique s'il s'agit d'un VPC de service.
paymentType	String	postpaid	Méthode de facturation du cluster. Valeurs possibles : prepaid : annuel et mensuel postpaid : paiement à l'utilisation
resourceGroupId	String	rg-aekzvowej3i****	ID du groupe de ressources.
postpaidServiceStatus	String	active	État du service de paiement à l'utilisation pour le cluster sous abonnement. Valeurs possibles : active : Normal closed : fermé indebt : Le paiement impayé est gelé.
description	String	es-cn-abc	Nom de l'instance.
esVersion	String	6.7_with_X-Pack	Version de l'instance.
isNewDeployment	String	true	Indique si le cluster est déployé dans la nouvelle architecture.
updatedAt	String	2018-07-18T10:10:04.484Z	Date de la dernière mise à jour de l'instance.
instanceId	String	es-cn-v641a0ta3000g****	ID de l'instance.
tags	Array of Tag		Tags de l'instance. Chaque tag est une paire clé-valeur.
tagKey	String	env	Clé du tag.
tagValue	String	dev	Valeur du tag.
extendConfigs	Array of Object	[{ "configType": "aliVersion", "aliVersion": "ali1.3.0" }]	Paramètres de configuration étendus.
clientNodeConfiguration	Object		Configurations des nœuds clients.
spec	String	elasticsearch.sn2ne.large	Spécification de l'instance. Spécifications du produit.
amount	Integer	3	Nombre de nœuds.
disk	Integer	20	Taille du stockage des nœuds. Unité : Go.
diskType	String	cloud_efficiency	Type de stockage des nœuds. Seuls les disques ultra (cloud_efficiency) sont pris en charge.
specInfo	String	1C 2G	Détails des spécifications des nœuds.
elasticDataNodeConfiguration	Object		Configurations des nœuds élastiques.
spec	String	elasticsearch.sn2ne.large	Spécification de l'instance. Spécifications du produit.
amount	Integer	3	Nombre de nœuds.
disk	Integer	20	Taille du stockage des nœuds. Unité : Go.
diskEncryption	Boolean	true	Indique si le chiffrement des disques est activé. Valeurs possibles : true : Exécutez l'étape. false : N'exécutez pas l'étape.
diskType	String	cloud_ssd	Type de stockage. Valeurs possibles : cloud_ssd : SSD cloud_essd : ESSD cloud_efficiency : disque ultra
specInfo	String	1C 2G	Détails des spécifications des nœuds.
kibanaConfiguration	Object		Configurations des nœuds Kibana.
spec	String	elasticsearch.n4.small	Spécification de l'instance. Spécifications du produit.
amount	Integer	1	Nombre de nœuds.
disk	Integer	20	Taille du stockage des nœuds. Unité : Go.
diskType	String	cloud_ssd	Type de stockage.
specInfo	String	1C 2G	Détails des spécifications des nœuds.
masterConfiguration	Object		Configurations des nœuds maîtres dédiés.
spec	String	elasticsearch.sn2ne.large	Spécification de l'instance. Spécifications du produit.
amount	Integer	3	Nombre de nœuds.
disk	Integer	20	Taille du stockage des nœuds. Unité : Go.
diskType	String	cloud_ssd	Type de stockage. Seul cloud_ssd est pris en charge.
specInfo	String	1C 2G	Détails des spécifications des nœuds.
networkConfig	Object		Configuration réseau.
vpcId	String	vpc-abc	ID du VPC.
vsArea	String	cn-hangzhou-e	Zone où réside le cluster.
type	String	vpc	Type de réseau. Seul le VPC est pris en charge.
vswitchId	String	vsw-def	ID du vSwitch.
whiteIpGroupList	Array of whiteIpGroupList		Listes blanches IP pour l'accès aux réseaux public et privé.
groupName	String	default	Nom de la liste blanche IP.
whiteIpType	String	PUBLIC_KIBANA	Type de réseau. Valeurs possibles : PRIVATE_ES (réseau privé Elasticsearch), PUBLIC_ES (réseau public Elasticsearch), PRIVATE_KIBANA (réseau privé Kibana), PUBLIC_KIBANA (réseau public Kibana).
ips	Array of String	["0.0.0.0", "127.0.XX.XX"]	Liste blanche IP.
nodeSpec	Object		Configurations des nœuds de données.
spec	String	elasticsearch.n4.small	Spécification de l'instance. Spécifications du produit.
disk	Integer	50	Capacité de stockage des nœuds. Unité : Go.
diskEncryption	Boolean	false	Utilisation ou non du chiffrement des disques. Valeurs possibles : true : Le mode de format natif est utilisé. false : Le mode de format natif n'est pas utilisé.
diskType	String	cloud_ssd	Type de stockage. Valeurs possibles : cloud_ssd : SSD standard cloud_efficiency : disque ultra
performanceLevel	String	PL1	Niveau de performance ESSD (PL). Renvoyé uniquement lorsque diskType est cloud_essd. Valeurs possibles : PL1, PL2 et PL3.
specInfo	String	1C 2G	Détails des spécifications des nœuds.
vpcInstanceId	String	vpc-bp1uag5jj38c****	ID du VPC.
kibanaIPWhitelist	Array of String	"0.0.0.0/0"	Liste blanche IP publique Kibana.
kibanaPrivateIPWhitelist	Array of String	["192.168.XX.XX"]	Liste blanche IP privée Kibana.
publicIpWhitelist	Array of String	[ "0.0.0.0/0" ]	Liste blanche du réseau public Elasticsearch.
privateNetworkIpWhiteList	Array of String	["192.168.XX.XX/25"]	Liste blanche du réseau privé Elasticsearch.
endTime	Long	1715826092044	Date d'expiration de l'instance de réserve de cache.
archType	String	public	Architecture de déploiement. exclusive : gestion de base public : nouveau contrôle cloud-native
domain	String	es-cn-nif1q8auz0005****.elasticsearch.aliyuncs.com	Point de terminaison interne du cluster.

Remarque

L'exemple suivant inclut la plupart des paramètres de réponse. Les réponses réelles peuvent varier. Ne codez pas en dur les dépendances sur des paramètres spécifiques.

Exemples

Exemple de requête

GET /openapi/instances?esVersion=6.7_with_X-Pack&resourceGroupId=rg-aekzvowej3i****&tags=[{"tagKey":"key1","tagValue":"value1"}]&vpcId=vpc-bp16k1dvzxtmagcva****&zoneId=cn-hangzhou-i HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

Exemple de réponse

JSON format

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

{
  "Result" : [ {
    "instanceId" : "es-cn-v641a0ta3000g****",
    "description" : "aliyunes_test1",
    "nodeAmount" : 3,
    "paymentType" : "postpaid",
    "status" : "active",
    "esVersion" : "6.7.0_with_X-Pack",
    "esConfig" : { },
    "esIPWhitelist" : [ ],
    "esIPBlacklist" : [ ],
    "privateNetworkIpWhiteList" : [ ],
    "kibanaIPWhitelist" : [ ],
    "publicIpWhitelist" : [ ],
    "serviceVpc" : true,
    "enablePublic" : false,
    "haveKibana" : true,
    "nodeSpec" : {
      "spec" : "elasticsearch.sn1ne.large",
      "disk" : 20,
      "diskType" : "cloud_ssd",
      "diskEncryption" : true
    },
    "networkConfig" : {
      "vpcId" : "vpc-bp1xk0naij7jx4ph1****",
      "vswitchId" : "vsw-bp1ogpdintii5qvyx****",
      "vsArea" : "cn-hangzhou-g",
      "type" : "vpc"
    },
    "createdAt" : "2019-08-26T08:18:06.652Z",
    "updatedAt" : "2019-08-26T08:19:49.448Z",
    "inited" : true,
    "tags" : [ {
      "tagKey" : "key1",
      "tagValue" : "value1"
    } ],
    "dedicateMaster" : false,
    "advancedDedicateMaster" : true,
    "masterConfiguration" : {
      "spec" : "elasticsearch.ic5.large",
      "amount" : 3,
      "diskType" : "cloud_ssd",
      "disk" : 20
    },
    "haveClientNode" : true,
    "warmNode" : true,
    "warmNodeConfiguration" : {
      "spec" : "elasticsearch.ic5.large",
      "amount" : 2,
      "diskType" : "cloud_efficiency",
      "disk" : 500,
      "diskEncryption" : true
    },
    "clientNodeConfiguration" : {
      "spec" : "elasticsearch.ic5.large",
      "amount" : 2,
      "diskType" : "cloud_efficiency",
      "disk" : 20
    },
    "kibanaConfiguration" : {
      "spec" : "elasticsearch.n4.small",
      "amount" : 1,
      "disk" : 0
    },
    "commodityCode" : "elasticsearch",
    "endTime" : 4722508800000,
    "dictList" : [ ],
    "synonymsDicts" : [ ],
    "ikHotDicts" : [ ],
    "aliwsDicts" : [ ],
    "clusterTasks" : [ ],
    "resourceGroupId" : "rg-acfmwriiikz****",
    "zoneCount" : 1,
    "protocol" : "HTTP",
    "haveGrafana" : false,
    "haveCerebro" : false,
    "zoneInfos" : [ {
      "zoneId" : "cn-hangzhou-g",
      "status" : "NORMAL"
    } ],
    "enableKibanaPublicNetwork" : false,
    "advancedSetting" : {
      "gcName" : "CMS"
    }
  }, {
    "instanceId" : "es-cn-v641920bh0006****",
    "description" : "aliyunes_test2",
    "nodeAmount" : 2,
    "paymentType" : "postpaid",
    "status" : "active",
    "esVersion" : "6.7.0_with_X-Pack",
    "archType" : "exclusive",
    "esConfig" : { },
    "esIPWhitelist" : [ ],
    "esIPBlacklist" : [ ],
    "privateNetworkIpWhiteList" : [ ],
    "kibanaIPWhitelist" : [ ],
    "publicIpWhitelist" : [ ],
    "enablePublic" : false,
    "haveKibana" : true,
    "nodeSpec" : {
      "spec" : "elasticsearch.sn2ne.2xlarge",
      "disk" : 20,
      "diskType" : "cloud_ssd",
      "diskEncryption" : false
    },
    "networkConfig" : {
      "vpcId" : "vpc-bp1op7luys63go2x5****",
      "vswitchId" : "vsw-bp1rusvg785q97ucp****",
      "vsArea" : "cn-hangzhou-i",
      "type" : "vpc"
    },
    "createdAt" : "2019-08-07T13:14:07.974Z",
    "updatedAt" : "2019-08-12T03:04:27.215Z",
    "inited" : true,
    "tags" : [ ],
    "dedicateMaster" : false,
    "advancedDedicateMaster" : false,
    "masterConfiguration" : { },
    "haveClientNode" : false,
    "warmNode" : false,
    "warmNodeConfiguration" : { },
    "clientNodeConfiguration" : { },
    "kibanaConfiguration" : {
      "spec" : "elasticsearch.n4.small",
      "amount" : 1,
      "disk" : 0
    },
    "commodityCode" : "elasticsearch",
    "endTime" : 4720867200000,
    "dictList" : [ ],
    "synonymsDicts" : [ ],
    "ikHotDicts" : [ ],
    "aliwsDicts" : [ ],
    "clusterTasks" : [ ],
    "resourceGroupId" : "rg-acfmwriiikz****",
    "zoneCount" : 1,
    "protocol" : "HTTP",
    "haveGrafana" : false,
    "haveCerebro" : false,
    "zoneInfos" : [ {
      "zoneId" : "cn-hangzhou-i",
      "status" : "NORMAL"
    } ],
    "enableKibanaPublicNetwork" : false,
    "advancedSetting" : {
      "gcName" : "CMS"
    }
  } ]
}

Codes d'erreur

Codes d'erreur de service.