InstallLogstashSystemPlugin - Elasticsearch - Centre de documentation Alibaba Cloud

Avant d'appeler cette opération, tenez compte des points suivants :

Les plug-ins à installer doivent figurer dans la liste des Plug-ins système par défaut d'Alibaba Cloud Logstash. Les plug-ins open source externes ne sont pas pris en charge.

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

L'opération GetLogs ne comporte pas d'en-têtes de requête spécifiques et utilise uniquement les en-têtes communs. Pour plus d'informations, consultez la section « En-têtes de requête communs » de la rubrique « En-têtes HTTP communs » dans la référence API.

Syntaxe de la requête

POST /openapi/logstashes/{InstanceId}/plugins/system/actions/install HTTP/1.1

Paramètres de requête

Paramètre

Type

Position

Obligatoire

Exemple

Description

InstanceId

String

Path

Oui

ls-cn-oew1qbgl****

L'ID de l'instance.

clientToken

String

Query

Non

5A2CFF0E-5718-45B5-9D4D-70B3FF****

Le jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer la valeur, mais assurez-vous qu'elle est unique pour chaque requête. Le jeton ne peut contenir que des caractères ASCII et sa longueur ne peut pas dépasser 64 caractères.

RequestBody

Dans le corps de la requête (RequestBody), saisissez également le nom du plug-in à installer au format ["pluginName1","pluginName2",.."pluginNamen"]. Exemple :


[
    "logstash-input-datahub",
    "logstash-input-maxcompute"
]

Paramètres de réponse

Paramètre

Type

Exemple

Description

RequestId

String

F99407AB-2FA9-489E-A259-40CF6DCC4****

L'ID de la requête.

Result

Array of String

["logstash-input-datahub", "logstash-input-maxcompute"]

La liste des plug-ins installés avec succès.

Les données renvoyées contiennent également les paramètres Headers, indiquant que les informations d'en-tête sont renvoyées.

Exemples

Exemple de requête

POST /openapi/logstashes/ls-cn-oew1qbgl****/plugins/system/actions/install?clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
[
    "logstash-input-datahub",
    "logstash-input-maxcompute"
]

Exemple de réponse réussie

Format JSON

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

{
  "Result" : [ "logstash-input-datahub", "logstash-input-maxcompute" ],
  "RequestId" : "93DE9165-49A9-455E-AD7E-64B6694F****",
  "Headers" : { }
}

Codes d'erreur

HttpCode	Code d'erreur	Message d'erreur	Description
400	InstanceActivating	Instance is activating.	L'instance est en cours d'activation.
400	InstanceNotFound	The instanceId provided does not exist.	L'instance est introuvable. Vérifiez l'état de l'instance.

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs API.