CreatePipelines - Créer des pipelines Logstash - Elasticsearch

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature et génère des exemples de code SDK. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer.

En-têtes de requête

Cette opération utilise uniquement les en-têtes de requête communs. Consultez la section En-têtes de requête communs dans Paramètres communs.

Syntaxe de la requête

POST /openapi/logstashes/{InstanceId}/pipelines HTTP/1.1

Paramètres de requête

Parameter	Type	Location	Required	Example	Description
InstanceId	String	Path	Yes	ls-cn-oew1qbgl****	ID du cluster Logstash.
trigger	Boolean	Query	No	false	Indique s'il faut déployer le pipeline immédiatement. Valeurs possibles : true : enregistre et déploie le pipeline. false (par défaut) : enregistre uniquement.
ClientToken	String	Query	No	5A2CFF0E-5718-45B5-9D4D-70B3FF****	Jeton généré par le client pour l'idempotence. Il doit être unique pour toutes les requêtes, contenir uniquement des caractères ASCII et ne pas dépasser 64 caractères.
	Array	Body	No		Configuration du pipeline. Consultez logstash.yml pour plus de détails sur les paramètres.
pipelineId	String	Body	Yes	pipeline-test	ID du pipeline.
description	String	Body	No	this is a test	Description du pipeline.
config	String	Body	Yes	input { } filter { } output { }	Configuration du pipeline.
workers	Integer	Body	No	2	Nombre de threads de travail du pipeline. La valeur par défaut correspond au nombre de vCPU.
batchSize	Integer	Body	No	125	Taille du lot du pipeline. Valeur par défaut : 125.
batchDelay	Integer	Body	No	50	Délai du lot du pipeline en millisecondes. Valeur par défaut : 50.
queueType	String	Body	No	MEMORY	Type de file d'attente. Valeurs possibles : MEMORY : file d'attente traditionnelle basée sur la mémoire. PERSISTED : file d'attente persistante basée sur le disque (ACKed).
queueMaxBytes	Integer	Body	No	1024	Capacité totale de la file d'attente en Mo. Valeur par défaut : 1024.
queueCheckPointWrites	Integer	Body	No	1024	Nombre d'écritures de points de contrôle de la file d'attente. Valeur par défaut : 1024.

Paramètres de réponse

Parameter

Type

Example

Description

Result

Boolean

true

Indique si le pipeline a été créé. Valeurs possibles :

true
false

RequestId

String

5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

ID de la requête.

Exemples

Exemples de requêtes

POST /openapi/logstashes/ls-cn-oew1qbgl****/pipelines?trigger=false&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

[ {
  "pipelineId" : "pipeline-test",
  "description" : "this is a test",
  "config" : "input { } filter { } output { }",
  "workers" : 2,
  "batchSize" : 125,
  "batchDelay" : 50,
  "queueType" : "MEMORY",
  "queueMaxBytes" : 1024,
  "queueCheckPointWrites" : 1024
} ]

Exemples de réponses réussies

JSON format

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

{
  "Result" : true,
  "RequestId" : "732A60FB-1899-4466-83D2-E96DA455****"
}

Codes d'erreur

Voir les Codes d'erreur de service.