ListPipelineIds - Elasticsearch

調用ListPipelineIds，設定Kibana管道管理時，測試Logstash與Kibana連通性，並擷取目標Kibana上建立的管道ID列表。

說明管道管理方式分為設定檔管理和Kibana管道管理，部分地區控制台不開放Kibana管道管理。

調試

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

要求標頭

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

請求文法

POST /openapi/instances/{InstanceId}/pipeline-ids HTTP/1.1

請求參數

名稱	類型	位置	是否必選	樣本值	描述
InstanceId	String	Path	是	ls-cn-7g1umu96oit2e****	Logstash執行個體ID。
	String	Body	否	{ "userName":"elastic", "password":"xxxxxx" }	請求體參數，詳情請參見下文的RequestBody章節。

RequestBody

RequestBody中還需填入以下參數，用來驗證管理管道的Kibana資訊。

名稱	類型	是否必選	樣本值	描述
userName	String	是	elastic	登入Kibana控制台的使用者名稱，預設為elastic。
password	String	是	xxxxxx	登入Kibana控制台的密碼。

返回資料

名稱	類型	樣本值	描述
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***	請求ID。
Result	Array of Result		返回結果清單。
pipelineId	String	testKibanaManagement	Kibana上建立的管道ID。
available	Boolean	true	管道是否可用，取值含義如下： true：可用。 false：不可用。
code	String	OK	管道不可用錯誤碼。
message	String	OK	管道不可用錯誤資訊。

樣本

請求樣本

POST /openapi/instances/ls-cn-7g1umu96oit2e****/pipeline-ids HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

{
    "userName":"elastic",
    "password":"xxxxxx"
}

正常返回樣本

JSON格式

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

{
  "Result" : [ {
    "pipelineId" : "testKibanaManagement",
    "available" : true,
    "code" : "OK",
    "message" : "OK"
  } ],
  "RequestId" : "E50BC6C3-23B5-4CA0-983C-066098FB8E34"
}

錯誤碼

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