Tous les produits
Search
Centre de documentation

Elasticsearch:DescribeLogstash

Dernière mise à jour :Aug 09, 2026

Récupère les informations détaillées d’un cluster Logstash spécifié.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de la 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 utilise uniquement des en-têtes de requête communs. Pour plus d’informations, consultez la section En-têtes de requête communs.

Syntaxe de la requête

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

Paramètres de requête

Paramètre

Type

Emplacement

Obligatoire

Exemple

Description

InstanceId

String

Path

Oui

ls-cn-s9dsk3k4k****

ID de l’instance.

Paramètres de réponse

Paramètre Type Exemple Description
RequestId String C9334241-4837-46C2-B24B-9BDC517318DE

ID de la requête.

Result Object

Informations détaillées sur l’instance.

config Map

Configurations de l’instance.

paymentType String prepaid

Méthode de facturation de l’instance. Valeurs valides :

  • prepaid : abonnement
  • postpaid : paiement à l’utilisation
ResourceGroupId String rg-aekzvowej3i****

ID du groupe de ressources auquel l’instance appartient.

nodeAmount Integer 2

Nombre de nœuds de données.

description String ls-cn-abc

Nom de l’instance.

createdAt String 2020-02-06T14:12:03.672Z

Date et heure de création de l’instance.

status String active

État de l’instance. Quatre états sont pris en charge :

  • Normal : actif
  • Active : en cours d’activation
  • Freeze : inactif
  • Invalid : non valide
vpcInstanceId String vpc-bp16k1dvzxtmagcva****

ID du réseau privé virtuel (VPC) auquel appartiennent les instances de conteneur élastique.

updatedAt String 2020-02-06T14:22:36.850Z

Date et heure de la dernière mise à jour de l’instance.

version String 7.4.0_with_X-Pack

Édition de l’instance Logstash dédiée.

instanceId String ls-cn-abc

ID de l’instance.

endpointList Array of endpoint

Informations d’accès au nœud.

zoneId String cn-hangzhou-b

ID de la zone où réside le nœud.

port String 9600

Numéro de port.

host String 172.16.**.**

Adresse IP du nœud.

Tags Array of tags

Tags ajoutés à l’instance Logstash.

tagKey String env

Clé du tag.

tagValue String dev

Valeur du tag.

ZoneInfos Array of zoneInfos

Informations sur les zones.

status String NORMAL

Statut de la zone. Valeurs valides :

  • ISOLATION : hors ligne
  • NORMAL
zoneId String cn-hangzhou-b

ID de la zone de la nouvelle instance.

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

Configuration des paramètres d’extension du cluster.

nodeSpec Object

Informations de configuration du nœud.

spec String elasticsearch.sn1ne.large

Spécifications du nœud.

disk Integer 20

Taille du disque du nœud.

diskEncryption Boolean true

Indique si le chiffrement du disque est utilisé :

  • true
  • false
diskType String cloud_ssd

Type de disque du nœud.

networkConfig Object

Configurations réseau.

vpcId String vpc-bp16k1dvzxtmagcva****

ID du réseau privé virtuel (VPC).

vsArea String cn-hangzhou-*

Zone où réside le cluster.

type String vpc

Type de réseau de l’instance. Valeurs valides : actuellement, seul le réseau privé virtuel (VPC) est pris en charge.

vswitchId String vsw-bp1k4ec6s7sjdbudw****

ID du vSwitch auquel l’instance est connectée.

Pour plus d’informations, consultez la rubrique ListLogstash.

Exemples

Exemples de requêtes

GET /openapi/logstashes/ls-cn-s9dsk3k4k**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

Exemples de réponses

Format JSON

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

{
  "Result" : {
    "instanceId" : "ls-cn-m7r1o6cl****",
    "version" : "6.7.0_with_X-Pack",
    "description" : "ls-cn-abc",
    "nodeAmount" : 2,
    "paymentType" : "postpaid",
    "status" : "active",
    "enablePublic" : false,
    "nodeSpec" : {
      "spec" : "elasticsearch.sn1ne.large",
      "disk" : 20,
      "diskType" : "cloud_ssd"
    },
    "networkConfig" : {
      "vpcId" : "vpc-bp16k1dvzxtmagcva****",
      "vswitchId" : "vsw-bp1k4ec6s7sjdbudw****",
      "vsArea" : "cn-hangzhou-i",
      "type" : "vpc"
    },
    "createdAt" : "2020-05-27T11:53:43.104Z",
    "updatedAt" : "2020-05-27T11:53:43.104Z",
    "commodityCode" : "elasticsearch_logstash_post",
    "extendConfigs" : [ ],
    "endTime" : 4746268800000,
    "clusterTasks" : [ ],
    "resourceGroupId" : "rg-acfm2h5vbzd****",
    "zoneCount" : 1,
    "protocol" : "HTTP",
    "zoneInfos" : [ {
      "zoneId" : "cn-hangzhou-i",
      "status" : "NORMAL"
    } ],
    "instanceType" : "logstash",
    "inited" : true,
    "tags" : [ ],
    "config" : {
      "slowlog.threshold.warn" : "2s",
      "slowlog.threshold.info" : "1s",
      "slowlog.threshold.debug" : "500ms",
      "slowlog.threshold.trace" : "100ms"
    },
    "endpointList" : [ {
      "host" : "172.16.**.**",
      "port" : 9600,
      "zoneId" : "cn-hangzhou-i"
    }, {
      "host" : "172.16.**.**",
      "port" : 9600,
      "zoneId" : "cn-hangzhou-i"
    } ]
  },
  "RequestId" : "C9334241-4837-46C2-B24B-9BDC517318DE"
}

Codes d’erreur

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