调用CreatePipelines，创建Logstash管道。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

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

请求参数

名称 类型 位置 是否必选 示例值 描述
InstanceId String Path 是 ls-cn-oew1qbgl****

Logstash实例ID。
trigger Boolean Query 否 false

是否保存并部署管道。可选值：

  • true：保存并部署
  • false（默认）：仅保存
ClientToken String Query 否 5A2CFF0E-5718-45B5-9D4D-70B3FF****

用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。
Array Body 否

请求体参数，用来指定管道信息，更多详细信息请参见logstash.yml。
pipelineId String Body 是 pipeline-test

管道ID。
description String Body 否 this is a test

管道描述。
config String Body 是 input { } filter { } output { }

管道具体配置。
workers Integer Body 否 2

管道工作线程数。默认值：实例的CPU核数。
batchSize Integer Body 否 125

管道批大小。默认值：125。
batchDelay Integer Body 否 50

管道批延迟。单位：毫秒，默认值：50。
queueType String Body 否 MEMORY

队列类型。可选值：

  • MEMORY：基于内存的传统队列。
  • PERSISTED：基于磁盘的ACKed队列（持久队列）。
queueMaxBytes Integer Body 否 1024

队列的总容量（以字节数表示）。单位：MB，默认值：1024。
queueCheckPointWrites Integer Body 否 1024

队列检查点写入数。默认值：1024。

返回数据

名称 类型 示例值 描述
Result Boolean true

管道是否创建成功：

  • true：创建成功
  • false：创建失败
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

请求ID。

示例

请求示例

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

正常返回示例

JSON格式

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

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

错误码

访问错误中心查看更多错误码。