ListPipeline - Elasticsearch

調試

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

要求標頭

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

請求文法

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

請求參數

名稱	類型	位置	是否必選	樣本值	描述
InstanceId	String	Path	是	ls-cn-oew1qbgl****	Logstash執行個體ID。
pipelineId	String	Query	否	pipeline_test	管道ID。
page	Integer	Query	否	1	分頁查詢時，設定當前頁面的頁碼。取值範圍：1~200，預設值：1。
size	Integer	Query	否	15	分頁查詢時，設定每頁包含管道的數量。取值範圍：1~200。

返回資料

名稱	類型	樣本值	描述
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****	請求ID。
Headers	Object		返回頭資訊。
X-Total-Count	Integer	2	總記錄數。
Result	Array of Result		返回結果。
pipelineId	String	pipeline_test	管道ID。
gmtUpdateTime	String	2020-08-05T08:43:31.757Z	管道更新時間。
gmtCreatedTime	String	2020-08-05T03:10:38.188Z	管道建立時間。
pipelineStatus	String	NOT_DEPLOYED	管道狀態，支援： NOT_DEPLOYED：未部署 RUNNING：運行中 DELETED：已刪除（控制台不展示此狀態）

樣本

請求樣本

GET /openapi/logstashes/ls-cn-oew1qbgl****/pipelines?pipelineId=pipeline_test&page=1&size=15 HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

正常返回樣本

JSON格式

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

{
  "Result" : [ {
    "pipelineId" : "datahub_test",
    "pipelineStatus" : "RUNNING",
    "gmtCreatedTime" : "2020-09-09T02:21:28.844Z",
    "gmtUpdateTime" : "2020-09-09T06:09:43.796Z"
  }, {
    "pipelineId" : "test",
    "pipelineStatus" : "NOT_DEPLOYED",
    "gmtCreatedTime" : "2020-09-16T06:35:30.139Z",
    "gmtUpdateTime" : "2020-09-16T07:06:24.759Z"
  }, {
    "pipelineId" : "test_1",
    "pipelineStatus" : "NOT_DEPLOYED",
    "gmtCreatedTime" : "2020-09-16T06:33:05.290Z",
    "gmtUpdateTime" : "2020-09-16T06:33:05.290Z"
  } ],
  "RequestId" : "AA6771E2-4007-4F1F-ADCB-16DAABB9****",
  "Headers" : {
    "X-Total-Count" : 3
  }
}

錯誤碼

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