调用CreatePipelines,创建Logstash管道。

调试

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

请求头

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

请求语法

POST /openapi/logstashes/[InstanceId]/pipelines HTTPS|HTTP

请求参数

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

Logstash实例ID。

trigger Boolean false

是否立即部署。

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

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

RequestBody

RequestBody中还需填入以下参数,用来指定管道信息。

名称

类型

是否必选

示例值

描述

pipelineId

String

pipeline-test

管道ID。

description

String

this is a test

管道描述。

config

String

input { } filter { } output { }

管道具体配置。

workers

Integer

2

管道工作线程数。

batchSize

Integer

125

管道批大小。

batchDelay

Integer

50

管道批延迟。

queueType

String

MEMORY

队列类型,支持:MEMORY、PERSISTED。

pipelineStatus

String

RUNNING

管道状态,支持:NOT_DEPLOYED、RUNNING、DELETED。trigger为true时,必填。

queueMaxBytes

Integer

1024

队列最大字节数。

queueCheckPointWrites

Integer

1024

队列检查点写入数。

示例如下。


[{
    "pipelineId":"test",
    "config":"input {\n\n}\nfilter {\n\n}\noutput {\n\n}"
}]

返回数据

名称 类型 示例值 描述
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

请求ID。

Result Boolean true

返回结果:

  • true:创建成功
  • false:创建失败

示例

请求示例

POST /openapi/logstashes/logstashes/ls-cn-oew1qbgl****/pipelines?trigger=false HTTP/1.1
公共请求头
 [{
    "pipelineId":"test",
    "config":"input {\n\n}\nfilter {\n\n}\noutput {\n\n}"
}]

正常返回示例

XML 格式

<Result>true</Result>
<RequestId>732A60FB-1899-4466-83D2-E96DA455****</RequestId>

JSON 格式

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

错误码

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