CreatePipelines - Criar pipelines do Logstash - Elasticsearch: Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura e gera exemplos de código SDK. Recomendamos chamar esta operação no OpenAPI Explorer.

Cabeçalhos da requisição

Esta operação usa apenas cabeçalhos de requisição comuns. Consulte a seção Cabeçalhos de requisição comuns em Parâmetros comuns.

Sintaxe da requisição

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

Parâmetros da requisição

Parâmetro	Tipo	Localização	Obrigatório	Exemplo	Descrição
InstanceId	String	Path	Sim	ls-cn-oew1qbgl****	ID do cluster Logstash.
trigger	Boolean	Query	Não	false	Define se o pipeline será implantado imediatamente. Valores válidos: true: salva e implanta o pipeline. false (padrão): apenas salva.
ClientToken	String	Query	Não	5A2CFF0E-5718-45B5-9D4D-70B3FF****	Token gerado pelo cliente para garantir idempotência. Deve ser único entre requisições, conter apenas caracteres ASCII e não exceder 64 caracteres.
	Array	Body	Não		Configuração do pipeline. Consulte logstash.yml para obter detalhes dos parâmetros.
pipelineId	String	Body	Sim	pipeline-test	ID do pipeline.
description	String	Body	Não	this is a test	Descrição do pipeline.
config	String	Body	Sim	input { } filter { } output { }	Configuração do pipeline.
workers	Integer	Body	Não	2	Número de threads de trabalho do pipeline. O valor padrão corresponde ao número de vCPUs.
batchSize	Integer	Body	Não	125	Tamanho do lote do pipeline. Padrão: 125.
batchDelay	Integer	Body	Não	50	Atraso do lote do pipeline em milissegundos. Padrão: 50.
queueType	String	Body	Não	MEMORY	Tipo de fila. Valores válidos: MEMORY: fila tradicional baseada em memória. PERSISTED: fila persistente baseada em disco (com ACK).
queueMaxBytes	Integer	Body	Não	1024	Capacidade total da fila em MB. Padrão: 1024.
queueCheckPointWrites	Integer	Body	Não	1024	Contagem de gravações de ponto de verificação da fila. Padrão: 1024.

Parâmetros da resposta

Parâmetro

Tipo

Exemplo

Descrição

Result

Boolean

true

Indica se o pipeline foi criado. Valores válidos:

true
false

RequestId

String

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

ID da requisição.

Exemplos

Exemplos de requisição

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
} ]

Exemplos de resposta de sucesso

Formato JSON

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

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

Códigos de erro

Consulte os Códigos de erro do serviço.