調(diào)用ListPipelineIds，設(shè)置Kibana管道管理時，測試Logstash與Kibana連通性，并獲取目標(biāo)Kibana上創(chuàng)建的管道ID列表。

說明 管道管理方式分為配置文件管理和Kibana管道管理，部分區(qū)域控制臺不開放Kibana管道管理。

調(diào)試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求頭

該接口使用公共請求頭，無特殊請求頭。請參見公共請求參數(shù)文檔。

請求語法

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

請求參數(shù)

名稱 類型 位置 是否必選 示例值 描述
InstanceId String Path 是 ls-cn-7g1umu96oit2e****

Logstash實例ID。
String Body 否 { "userName":"elastic", "password":"xxxxxx" }

請求體參數(shù)，詳情請參見下文的RequestBody章節(jié)。

RequestBody

RequestBody中還需填入以下參數(shù)，用來驗證管理管道的Kibana信息。

名稱

類型

是否必選

示例值

描述

userName

String

是

elastic

登錄Kibana控制臺的用戶名，默認為elastic。

password

String

是

xxxxxx

登錄Kibana控制臺的密碼。

返回數(shù)據(jù)

名稱 類型 示例值 描述
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

請求ID。
Result Array of Result

返回結(jié)果列表。
pipelineId String testKibanaManagement

Kibana上創(chuàng)建的管道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"
}

錯誤碼

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