CreatePipelines - Elasticsearch

調試

您可以在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****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。