ListLogstashPlugins - Elasticsearch - Centre de documentation Alibaba Cloud

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 des exemples de code 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}/plugins HTTP/1.1

Paramètres de requête

Parameter	Type	Location	Required	Remarks	Description
InstanceId	String	Path	Yes	ls-cn-oew1qbgl****	ID de l’instance.
name	String	Query	No	logstash-filter-clone	Nom du plug-in.
page	Integer	Query	No	10	Numéro de page de la liste des plug-ins. Valeur par défaut : 1. Valeur minimale : 1. Valeur maximale : 200.
size	Integer	Query	No	3	Nombre d’entrées à renvoyer par page. Valeur minimale : 1. Valeur maximale : 200.
source	String	Query	No	USER	Source du plug-in. Valeurs possibles : USER : plug-ins personnalisés SYSTEM : plug-in prédéfini par le système

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	99407AB-2FA9-489E-A259-40CF6DCC****	ID de la requête.
Result	Array of Result		Résultats renvoyés.
description	String	The clone filter is for duplicating events.	Description du plug-in.
specificationUrl	String	https://xxx.html	URL de la documentation du plug-in.
state	String	INSTALLED	État du plug-in. Valeurs possibles : INSTALLED : Installé UNINSTALLED : Non installé INSTALLING : Installation en cours UNINSTALLING : Désinstallation en cours UPGRADING : Mise à niveau en cours FAILED : Échec de l’installation UNKNOWN : Cluster introuvable
source	String	SYSTEM	Source du plug-in.
name	String	logstash-filter-clone	Nom du plug-in.

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

Parameter	Type	Example	Description
Headers	Struct		En-tête de la réponse.
└X-Total-Count	Integer	131	Nombre de plug-ins renvoyés.

Remarque

└ indique un paramètre enfant.

Exemples

Exemple de requête

GET /openapi/logstashes/ls-cn-oew1qbgl****/plugins?name=logstash-filter-clone&page=10&size=3&source=USER 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" : [ {
    "name" : "logstash-filter-clone",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "The clone filter is for duplicating events. A clone will be created for each type in the clone list.",
    "specificationUrl" : "https://www.elastic.co/guide/en/logstash/6.7/plugins-filters-clone.html"
  }, {
    "name" : "logstash-filter-csv",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "The CSV filter takes an event field containing CSV data, parses it, and stores it as individual fields (can optionally specify the names). This filter can also parse data with any separator, not just commas.",
    "specificationUrl" : "https://www.elastic.co/guide/en/logstash/6.7/plugins-filters-csv.html"
  }, {
    "name" : "logstash-filter-date",
    "state" : "INSTALLED",
    "source" : "SYSTEM",
    "description" : "The date filter is used for parsing dates from fields, and then using that date or timestamp as the logstash timestamp for the event.",
    "specificationUrl" : "https://www.elastic.co/guide/en/logstash/6.7/plugins-filters-date.html"
  } ],
  "RequestId" : "40C0570B-AB40-48BA-8CAE-66EA230A****",
  "Headers" : {
    "X-Total-Count" : 131
  }
}

Codes d’erreur

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