DescribePipeline - Elasticsearch

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

要求標頭

該介面使用公用要求標頭，無特殊要求標頭。請參見公用請求參數文檔。

請求文法

GET /openapi/logstashes/{InstanceId}/pipelines/{PipelineId} HTTP/1.1

請求參數

名稱	類型	位置	是否必選	樣本值	描述
InstanceId	String	Path	是	ls-cn-oew1qbgl****	Logstash執行個體ID。
PipelineId	String	Path	是	pipeline_test	管道ID。

返回資料

名稱	類型	樣本值	描述
RequestId	String	829F38F6-E2D6-4109-90A6-888160BD1***	請求ID。
Result	Object		返回的管道資訊，更多詳細資料請參見logstash.yml。
pipelineId	String	pipeline_test	管道ID。
gmtUpdateTime	String	2020-06-20T07:26:47.000+0000	管道更新時間。
queueType	String	MEMORY	隊列類型。支援： MEMORY：基於記憶體的傳統隊列。 PERSISTED：基於磁碟的ACKed隊列（持久隊列）。
queueCheckPointWrites	Integer	1024	隊列檢查點寫入數。
queueMaxBytes	Integer	1024	隊列的總容量（以位元組數表示）。單位：MB。
config	String	input { } filter { } output { }	管道具體配置。
batchDelay	Integer	50	管道批延遲。單位：毫秒。
workers	Integer	2	管道背景工作執行緒數。
description	String	this is a test	管道描述。
gmtCreatedTime	String	2020-06-20T07:26:47.000+0000	管道建立時間。
batchSize	Integer	125	管道批大小。
pipelineStatus	String	RUNNING	管道狀態。支援： NOT_DEPLOYED：未部署 RUNNING：運行中 DELETED：已刪除（控制台不展示此狀態）

說明未配置的管道參數將使用系統預設值，不會在返回結果中顯示。

樣本

請求樣本

GET /openapi/logstashes/ls-cn-oew1qbgl****/pipelines/pipeline_test HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

正常返回樣本

JSON格式

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

{
  "Result" : {
    "pipelineId" : "test",
    "config" : "input {\n\n}\nfilter {\n\n}\noutput {\n\n}",
    "workers" : 2,
    "batchSize" : 100,
    "batchDelay" : 60,
    "queueType" : "MEMORY",
    "pipelineStatus" : "NOT_DEPLOYED",
    "queueMaxBytes" : 1024,
    "queueCheckPointWrites" : 1024,
    "gmtCreatedTime" : "2020-09-16T06:35:30.139Z",
    "gmtUpdateTime" : "2020-09-16T07:06:24.759Z"
  },
  "RequestId" : "49AEA9F3-B946-4102-8BD7-92E71C86****"
}

錯誤碼

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