Tous les produits
Search

Ce produit

    Elasticsearch:DescribeInstance

    Centre de documentation

    Elasticsearch:DescribeInstance

    Dernière mise à jour :Aug 09, 2026

    Interroge les informations détaillées d'un cluster Elasticsearch spécifié.

    Débogage

    OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

    En-têtes de requête

    Cette opération ne possède pas d'en-têtes de requête spécifiques et utilise uniquement les en-têtes de requête communs. Pour plus d'informations, consultez la section « Common request headers » de la rubrique « Common parameters ».

    Syntaxe

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

    Paramètres de requête

    Paramètre

    Type

    Emplacement

    Obligatoire

    Exemple

    Description
    InstanceId String Path Oui es-cn-3h4k3axh33th9****

    ID de l'instance N.

    Paramètres de réponse

    Paramètre

    Type

    Exemple

    Description
    RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

    ID de la requête.

    Result Object

    Paramètres de réponse.

    advancedDedicateMaster Boolean true

    Indique si le cluster contient des nœuds maître dédiés. Valeurs possibles :

    • true : le cluster contient des nœuds client.
    • false : le cluster ne contient pas de nœuds client.
    protocol String HTTP

    Protocole de communication. Valeurs possibles : HTTP et HTTPS.

    enableKibanaPublicNetwork Boolean true

    Indique si l'accès à Kibana via Internet est activé. Valeurs possibles :

    • true : activé
    • false
    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.

    enableKibanaPrivateNetwork Boolean false

    Indique si l'accès à Kibana via un réseau interne est activé. Valeurs possibles :

    • true : activé
    • false
    vpcInstanceId String vpc-bp1uag5jj38c****

    ID du VPC.

    port Integer 9200

    Numéro de port utilisé pour accéder au cluster.

    enablePublic Boolean true

    Indique si l'accès au cluster via Internet est activé. Valeurs possibles :

    • true : activé
    • false
    dedicateMaster Boolean false

    Indique si le cluster contient des nœuds maître dédiés. Ce paramètre est obsolète.

    kibanaPort Integer 5601

    Numéro de port utilisé pour accéder à Kibana.

    esConfig Map

    Configuration du fichier YML du cluster.

    resourceGroupId String rg-aekzvowej3i****

    ID du groupe de ressources auquel l'instance ALB appartient.

    paymentType String postpaid

    Mode de facturation du cluster. Valeurs possibles :

    • prepaid : abonnement
    • postpaid : paiement à l'utilisation
    postpaidServiceStatus String active

    État du service de paiement à l'utilisation pour le cluster sous abonnement. Valeurs possibles :

    • active : normal
    • closed : fermé
    • indebt : gelé en raison d'un paiement en souffrance
    esVersion String 6.3.2_with_X-Pack

    Version de l'instance.

    haveKibana Boolean true

    Indique si le cluster contient des nœuds Kibana. Valeurs possibles :

    • true : le cluster contient des nœuds client.
    • false : le cluster ne contient pas de nœuds client.
    isNewDeployment Boolean true

    Indique si le cluster est déployé dans la nouvelle architecture.

    warmNode Boolean true

    Indique si les nœuds de stockage à froid (warm nodes) sont activés pour le cluster. Valeurs possibles :

    • true : activé
    • false
    updatedAt String 2018-07-13T03:58:07.253Z

    Date de la dernière mise à jour de l'instance.

    instanceId String es-cn-3h4k3axh33th9****

    ID de l'instance.

    zoneCount Integer 2

    Nombre de zones.

    publicDomain String es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com

    Endpoint public du cluster.

    status String active

    État de l'instance. Valeurs possibles :

    • active : le cluster est dans un état normal.
    • activating : le cluster est en cours d'initialisation.
    • 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.
    serviceVpc Boolean true

    Indique si le VPC se trouve dans le compte de service Elasticsearch.

    publicPort Integer 9200

    Numéro de port utilisé pour accéder au cluster via Internet.

    haveClientNode Boolean true

    Indique si le cluster contient des nœuds client. Valeurs possibles :

    • true : le cluster contient des nœuds client.
    • false : le cluster ne contient pas de nœuds client.
    domain String es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com

    Endpoint interne du cluster.

    description String es-cn-abc

    Nom de l'instance.

    kibanaDomain String es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com

    Endpoint de Kibana.

    dictList Array of DictList

    Configurations des dictionnaires IK.

    fileSize Long 2782602

    Taille du fichier de dictionnaire. Unité : octets.

    sourceType String ORIGIN

    Type de source du fichier de dictionnaire. Valeurs possibles :

    • OSS : OSS. Vous devez vous assurer que la liste de contrôle d'accès (ACL) du bucket OSS associé est définie sur lecture publique.
    • ORIGIN : Elasticsearch open source.
    • UPLOAD : fichier téléchargé.
    name String SYSTEM_MAIN.dic

    Nom du fichier de dictionnaire.

    type String MAIN

    Type de dictionnaire. Valeurs possibles :

    • STOP : liste de mots vides
    • MAIN : dictionnaire principal
    • SYNONYMS : dictionnaire de synonymes
    • ALI_WS : dictionnaire Alibaba Cloud
    synonymsDicts Array of SynonymsDicts

    Configurations des dictionnaires de synonymes.

    fileSize Long 2782602

    Taille du fichier de dictionnaire. Unité : octet.

    sourceType String ORIGIN

    Type de source.

    name String SYSTEM_MAIN.dic

    Nom du fichier de dictionnaire.

    type String STOP

    Type de dictionnaire. Valeurs possibles :

    • STOP : liste de mots vides
    • MAIN : dictionnaire principal
    • SYNONYMS : dictionnaire de synonymes
    • ALI_WS : dictionnaire Alibaba Cloud
    zoneInfos Array of ZoneInfo

    Informations sur la zone.

    status String NORMAL

    État de la zone. Valeurs possibles :

    • ISOLATION : désactivé
    • NORMAL : normal
    zoneId String cn-hangzhou-b

    ID de la zone.

    aliwsDicts Array of Dict

    Configurations des dictionnaires IK Alibaba Cloud.

    fileSize Long 2782602

    Taille du fichier de dictionnaire. Unité : octet.

    sourceType String OSS

    Type de source du fichier de dictionnaire. Valeurs possibles :

    • OSS : OSS. Vous devez vous assurer que la liste de contrôle d'accès (ACL) du bucket OSS associé est définie sur lecture publique.
    • ORIGIN : Elasticsearch open source.
    • UPLOAD : fichier téléchargé.
    name String aliws_ext_dict.txt

    Nom du fichier de dictionnaire.

    type String ALI_WS

    Type de dictionnaire. Valeurs possibles :

    • STOP : liste de mots vides
    • MAIN : dictionnaire principal
    • SYNONYMS : dictionnaire de synonymes
    • ALI_WS : dictionnaire Alibaba Cloud
    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.

    esIPWhitelist Array of String [ "0.0.0.0/0" ]

    Liste blanche d'adresses IP privées. Ce paramètre est obsolète.

    extendConfigs Array of Object [{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]

    Configurations étendues de l'instance.

    privateNetworkIpWhiteList Array of String 0.0.0.0/0

    Liste blanche d'adresses IP de l'instance.

    publicIpWhitelist Array of String [ "0.0.0.0/0" ]

    Liste blanche d'accès à l'endpoint public de l'instance.

    kibanaPrivateIPWhitelist Array of String ["192.168.XX.XX"]

    Liste des adresses IP privées dans la liste blanche de Kibana.

    esIPBlacklist Array of String [ "0.0.0.0/0" ]

    Liste noire d'accès au réseau privé (obsolète).

    kibanaIPWhitelist Array of String [ "0.0.0.0/0" ]

    Liste blanche d'accès à l'endpoint public de Kibana.

    nodeSpec Object

    Configurations des nœuds de données.

    spec String elasticsearch.n4.small

    Catégorie de spécification. Pour plus d'informations, consultez Spécifications du produit.

    disk Integer 0

    Capacité de stockage. Unité : Go.

    diskEncryption Boolean true

    Indique si le chiffrement du disque est activé. Valeurs possibles :

    • true
    • false
    diskType String cloud_ssd

    Catégorie de disque du nœud. Valeurs possibles :

    • cloud_ssd : SSD standard
    • cloud_efficiency : disque ultra
    performanceLevel String PL1

    Niveau de performance (PL) du disque ESSD. Ce paramètre est renvoyé si la valeur de diskType est cloud_essd. Valeurs possibles : PL1, PL2 et PL3.

    specInfo String 1C 2G

    Description des spécifications du nœud
    networkConfig Object

    Type de réseau.

    vpcId String vpc-abc

    ID du Virtual Private Cloud (VPC).

    vsArea String cn-hangzhou-b

    Zone où réside le cluster.

    type String vpc

    Type de réseau. Seul le VPC est pris en charge.

    vswitchId String vsw-abc

    ID du vSwitch.

    whiteIpGroupList Array of whiteIpGroupList

    Liste des listes blanches.

    whiteIpType String PRIVATE_ES

    Type de liste blanche. Valeurs possibles :

    • PRIVATE_ES : liste blanche d'adresses IP privées pour Elasticsearch
    • PUBLIC_ES : liste blanche d'adresses IP publiques pour Elasticsearch
    • PRIVATE_KIBANA : liste blanche d'adresses IP privées pour Kibana
    • PUBLIC_KIBANA : liste blanche d'adresses IP publiques pour Kibana
    groupName String default

    Nom du groupe de liste blanche. Par défaut, la liste blanche par défaut est incluse.

    ips Array of String ["0.0.0.0", "127.0.XX.XX"]

    Adresses IP incluses dans la liste blanche d'adresses IP.

    kibanaConfiguration Object

    Configurations des nœuds Kibana.

    amount Integer 1

    Nombre de nœuds.

    spec String elasticsearch.n4.small

    Catégorie de spécification. Pour plus d'informations, consultez Spécifications du produit.

    disk Integer 20

    Capacité de stockage de chaque nœud. Unité : Go.

    specInfo String 1C 2G

    Description des spécifications du nœud
    masterConfiguration Object

    Configurations des nœuds maître dédiés.

    spec String elasticsearch.n4.small

    Catégorie de spécification. Pour plus d'informations, consultez Spécifications du produit.

    amount Integer 3

    Nombre de nœuds.

    disk Integer 40

    Capacité de stockage. Unité : Go.

    diskType String cloud_ssd

    Type de stockage. Seul cloud_ssd est pris en charge.

    specInfo String 1C 2G

    Description des spécifications du nœud
    clientNodeConfiguration Object

    Configurations des nœuds client.

    spec String elasticsearch.n4.small

    Catégorie de spécification. Pour plus d'informations, consultez Spécifications du produit.

    amount Integer 3

    Nombre de nœuds.

    disk Integer 40

    Capacité de stockage. Unité : Go.

    diskType String cloud_efficiency

    Type de stockage. Seul cloud_efficiency est pris en charge.

    specInfo String 1C 2G

    Description des spécifications du nœud
    warmNodeConfiguration Object

    Configurations des nœuds de stockage à froid (warm nodes).

    amount Integer 6

    Nombre de nœuds.

    spec String elasticsearch.n4.small

    Catégorie de spécification. Pour plus d'informations, consultez Spécifications du produit.

    disk Integer 500

    Capacité de stockage. Unité : Go.

    diskEncryption Boolean true

    Indique si le chiffrement du disque est activé. Valeurs possibles :

    • true : activé
    • false
    diskType String cloud_efficiency

    Type de stockage. Seul cloud_efficiency est pris en charge.

    specInfo String 1C 2G

    Description des spécifications du nœud
    advancedSetting Object

    Configurations avancées.

    gcName String CMS

    Nom du garbage collector (GC). Valeurs possibles : CMS et G1.

    elasticDataNodeConfiguration Object

    Configurations des nœuds élastiques.

    amount Integer 3

    Nombre de nœuds.

    spec String elasticsearch.sn2ne.large

    Catégorie de spécification. Pour plus d'informations, consultez Spécifications du produit.

    disk Integer 20

    Capacité de stockage. Unité : Go.

    diskEncryption Boolean true

    Indique si le chiffrement du disque est activé. Valeurs possibles :

    • true
    • false
    diskType String cloud_ssd

    Type de stockage. Valeurs possibles :

    • cloud_ssd : SSD standard
    • cloud_essd : disque ESSD (Enhanced SSD)
    • cloud_efficiency : disque ultra.
    specInfo String 1C 2G

    Description des spécifications du nœud.

    ikHotDicts Array of ikHotDicts

    Configurations des mises à jour progressives pour les dictionnaires IK.

    type String MAIN

    Type de dictionnaire à mettre à jour. Valeurs possibles :

    • MAIN : dictionnaire principal IK
    • STOP : liste de mots vides IK
    sourceType String OSS

    Type de source du fichier de dictionnaire. Valeurs possibles :

    • OSS
    • ORIGIN
    fileSize Integer 6

    Taille du fichier de dictionnaire. Unité : octets.

    name String deploy_0.dic

    Nom du fichier de dictionnaire.

    instanceCategory String advanced

    Édition du cluster Elasticsearch. Les valeurs renvoyées sont les suivantes :

    • x-pack : Édition Standard
    • advanced/IS : Édition Améliorée
    • community : Édition Basique
    endtime Long 1715826092044

    Date d'expiration de l'instance de réserve de cache.

    archType String public

    Mode de déploiement, type d'architecture :

    exclusive : gestion basique

    public : nouveau contrôle cloud-native
    kibanaPrivateDomain String es-cn-x0r3*********.elasticsearch.aliyuncs.com

    Endpoint privé de Kibana
    kibanaPrivatePort String 5601

    Port privé de Kibana
    Remarque

    Dans l'exemple de retour suivant, cet article garantit uniquement que les paramètres de la liste de données renvoyée sont inclus. Les paramètres non mentionnés sont fournis à titre indicatif uniquement. Le programme ne doit pas dépendre de l'obtention de ces paramètres.

    Exemples

    Exemples de requêtes

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

    Exemples de réponses réussies

    JSON format

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

{
  "Result" : {
    "instanceId" : "es-cn-3h4k3axh33th9****",
    "domain" : "es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com",
    "description" : "es-cn-3h4k3axh33th9****",
    "nodeAmount" : 2,
    "paymentType" : "postpaid",
    "status" : "active",
    "port" : 9200,
    "esVersion" : "6.3.2_with_X-Pack",
    "archType" : "exclusive",
    "instanceCategory" : "x-pack",
    "esConfig" : {
      "action.destructive_requires_name" : "true",
      "xpack.security.audit.outputs" : "index",
      "xpack.watcher.enabled" : "false",
      "xpack.security.audit.enabled" : "false",
      "action.auto_create_index" : "+.*,-*"
    },
    "esIPWhitelist" : [ "0.0.0.0/0" ],
    "esIPBlacklist" : [ ],
    "privateNetworkIpWhiteList" : [ "0.0.0.0/0" ],
    "kibanaIPWhitelist" : [ "0.0.0.0/0", "::/0" ],
    "publicIpWhitelist" : [ ],
    "kibanaDomain" : "es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com",
    "kibanaPort" : 5601,
    "enablePublic" : false,
    "haveKibana" : true,
    "nodeSpec" : {
      "spec" : "elasticsearch.sn1ne.large",
      "disk" : 21,
      "diskType" : "cloud_ssd"
    },
    "serviceVpc" : true,
    "networkConfig" : {
      "vpcId" : "vpc-bp13n1j3fcv1cqfkg****",
      "vswitchId" : "vsw-bp12q2vrqvko0ilg8****",
      "vsArea" : "cn-hangzhou-h",
      "type" : "vpc",
      "whiteIpGroupList" : [ {
        "groupName" : "default",
        "whiteIpType" : "PRIVATE_ES",
        "ips" : [ "0.0.0.0", "127.0.XX.XX" ]
      } ]
    },
    "createdAt" : "2019-08-28T07:48:59.736Z",
    "updatedAt" : "2019-08-28T08:11:33.229Z",
    "inited" : true,
    "dedicateMaster" : false,
    "advancedDedicateMaster" : false,
    "masterConfiguration" : { },
    "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" : 4722681600000,
    "dictList" : [ {
      "name" : "SYSTEM_MAIN.dic",
      "fileSize" : 2782602,
      "type" : "MAIN",
      "sourceType" : "ORIGIN"
    }, {
      "name" : "SYSTEM_STOPWORD.dic",
      "fileSize" : 132,
      "type" : "STOP",
      "sourceType" : "ORIGIN"
    } ],
    "synonymsDicts" : [ ],
    "ikHotDicts" : [ ],
    "aliwsDicts" : [ ],
    "clusterTasks" : [ ],
    "vpcInstanceId" : "es-cn-3h4k3axh33th9****-worker",
    "resourceGroupId" : "rg-acfm3ghp32r****",
    "zoneCount" : 1,
    "protocol" : "HTTP",
    "haveGrafana" : false,
    "haveCerebro" : false,
    "zoneInfos" : [ {
      "zoneId" : "cn-hangzhou-h",
      "status" : "NORMAL"
    } ],
    "enableKibanaPublicNetwork" : true,
    "advancedSetting" : {
      "gcName" : "CMS"
    }
  },
  "RequestId" : "68104CC2-DA27-446D-8049-A024F0D4EFEC"
}

    Codes d'erreur

    Pour obtenir la liste des codes d'erreur, consultez Codes d'erreur de service.