ListLogstash - Elasticsearch - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour votre 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

/openapi/logstashes

Syntaxe de la requête

GET /openapi/logstashes HTTP/1.1

Paramètres de requête

Paramètre	Type	Emplacement	Obligatoire	Exemple	Description
page	Integer	Query	Non	1	Le numéro de page des résultats renvoyés. Valeur par défaut : 1.
size	Integer	Query	Non	10	Le nombre d'entrées à renvoyer par page. Valeur par défaut : 20.
description	String	Query	Non	ls-cn-abc	Le nom de l'instance. Vous pouvez spécifier un mot-clé pour faire correspondre plusieurs instances. Par exemple, si vous interrogez une instance nommée abc, toutes les instances nommées abc, abcde, xyabc et xabcy peuvent être renvoyées.
instanceId	String	Query	Non	ls-cn-n6w1o5jq****	L'ID de l'instance.
version	String	Query	Non	5.5.3_with_X-Pack	La version de l'instance.
resourceGroupId	String	Query	Non	rg-acfm2h5vbzd****	L'ID du groupe de ressources.
tags	String	Query	Non	[{"tagKey":"key1","tagValue":"value1"}]	Le tag de l'instance. Valeurs valides :

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	AC442F2F-5068-4434-AA21-E78947A9****	L'ID de la requête.
Headers	Object		Détails de l'en-tête de la requête.
X-Total-Count	Integer	10	Le nombre d'entrées renvoyées par page.
Result	Array of Instance		Informations détaillées sur les instances correspondantes.
paymentType	String	postpaid	La méthode de facturation de l'instance. Pris en charge : prepaid (abonnement) et postpaid (paiement à l'utilisation).
nodeAmount	Integer	2	Le nombre de nœuds de données.
description	String	ls-cn-abc	Le nom du VPC.
createdAt	String	2018-07-13T03:58:07.253Z	L'heure de création de l'instance.
status	String	active	L'état de l'instance. Valeurs valides : Normal, Active, Inactive et Invalid.
updatedAt	String	2018-07-18T10:10:04.484Z	L'heure de la dernière mise à jour de l'instance.
instanceId	String	ls-cn-n6w1o5jq****	L'ID de l'instance.
version	String	6.7.0_with_X-Pack	La version de l'instance. Actuellement, seules les versions 6.7.0_with_X-Pack et 7.4.0_with_X-Pack sont prises en charge.
Tags	Array of tags		Le tag de l'instance. Valeurs valides :
TagValue	String	dev	La valeur du tag du disque cloud.
TagKey	String	env	La clé du tag du disque cloud.
nodeSpec	Object		Les informations de configuration du nœud de données.
spec	String	logstash.n4.small	Le type d'instance de l'instance ECS.
disk	Integer	50	La taille du disque du nœud.
diskEncryption	Boolean	false	Indique s'il faut utiliser le chiffrement de disque. Valeurs valides : true : active la fonctionnalité de requête simultanée pour les requêtes autres que les requêtes d'agrégation. false : désactive la fonctionnalité de requête simultanée pour les requêtes autres que les requêtes d'agrégation.
diskType	String	cloud_ssd	Le type de disque.
networkConfig	Object		Les configurations réseau.
vpcId	String	vpc-abc	L'ID du VPC.
vsArea	String	cn-hangzhou-*	La zone où réside le cluster.
type	String	vpc	Le type de réseau. Actuellement, seul Virtual Private Cloud (VPC) est pris en charge.
vswitchId	String	vsw-def	L'ID du vSwitch.

Les données renvoyées contiennent également les paramètres suivants.

**

Paramètre

**

Type

**

Exemple

**

Description

**

enablePublic

Boolean

false

Indique s'il faut activer l'accès Internet. Valeur par défaut : false.

commodityCode

String

elasticsearch_logstash_post

Le code du service.

endTime

Long

4749897600000

La dernière date d'expiration de l'instance d'abonnement.

clusterTasks

Array

[]

La liste des tâches de l'instance.

resourceGroupId

String

rg-acfm2h5vbzd****

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

zoneCount

Integer

1

Le nombre de zones dans lesquelles le cluster Elasticsearch est déployé.

protocol

String

HTTP

Le protocole d'accès de l'instance.

zoneInfos

Array

Les informations sur les zones.

└zoneId

String

cn-hangzhou-i

L'ID de zone du cluster.

└status

String

NORMAL

Le statut de la zone. Pris en charge : ISOLATION (hors ligne) et NORMAL (normal).

instanceType

String

logstash

L'édition de l'instance.

inited

Boolean

true

Indique si l'instance a été initialisée.

config

Array

[]

Configurez les instances ECS.

endpointList

Array

Les informations sur les nœuds.

└host

String

172.16.xx.xx

L'adresse IP du nœud.

└port

Integer

9200

Le numéro de port d'accès du nœud.

└zoneId

String

cn-hangzhou-i

L'ID de zone du nœud.

Remarque

└ indique un paramètre enfant.

Exemples

Exemples de requêtes

GET /openapi/logstashes?page=1&size=10&description=ls-cn-abc&instanceId=ls-cn-n6w1o5jq****&version=5.5.3_with_X-Pack&resourceGroupId=rg-acfm2h5vbzd****&tags=[{"tagKey":"key1","tagValue":"value1"}] 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" : "ls-cn-n6w1o5jq****",
    "version" : "6.7.0_with_X-Pack",
    "description" : "test",
    "nodeAmount" : 1,
    "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-27T01:30:15.947Z",
    "updatedAt" : "2020-05-27T01:40:51.333Z",
    "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" : { },
    "endpointList" : [ {
      "host" : "172.16.**.**",
      "port" : 9600,
      "zoneId" : "cn-hangzhou-i"
    } ]
  } ],
  "RequestId" : "918C05D8-4689-4A79-B6D5-D2500991****",
  "Headers" : {
    "X-Total-Count" : 1
  }
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez les codes d'erreur du service .