ValidateConnection - Elasticsearch

說明開啟Logstash的X-Pack監控需配置Elasticsearch執行個體。配置後，即可在對應Elasticsearch執行個體的Kibana中監控Logstash執行個體。

調試

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

要求標頭

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

請求文法

POST /openapi/logstashes/{InstanceId}/validate-connection HTTP/1.1

請求參數

名稱	類型	位置	是否必選	樣本值	描述
InstanceId	String	Path	是	ls-cn-oew1qbgl****	Logstash執行個體ID。
ClientToken	String	Query	否	5A2CFF0E-5718-45B5-9D4D-70B3FF****	用於保證請求的等冪性。由用戶端產生該參數值，要保證在不同請求間唯一，最大不超過64個ASCII字元。
	String	Body	否	{ "endpoints": [ "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200" ], "userName": "elastic", "password": "xxxx" }	指定需要連通的Elasticsearch執行個體的資訊。

RequestBody

RequestBody中還需填入以下參數，用來指定需要連通的Elasticsearch執行個體的資訊。

說明 Logstash執行個體和Elasticsearch執行個體需滿足相容性要求，請參見產品相容性。

名稱	類型	是否必選	樣本值	描述
endpoints	List<String\>	是	["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]	提供X-Pack監控的Elasticsearch執行個體的訪問地址。
userName	String	是	elastic	Elasticsearch執行個體的使用者名稱。
password	String	是	xxx	Elasticsearch執行個體的密碼。

樣本如下。

{
    "endpoints": [
        "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"
    ],
    "userName": "elastic",
    "password": "xxxx"
}

返回資料

名稱

類型

樣本值

描述

Result

Boolean

true

返回結果：

true：驗證成功
false：驗證失敗

RequestId

String

5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

請求ID。

樣本

請求樣本

POST /openapi/logstashes/ls-cn-oew1qbgl****/validate-connection HTTP/1.1
公用要求標頭
{
    "endpoints": [
        "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"
    ],
    "userName": "elastic",
    "password": "xxxx"
}

正常返回樣本

JSON格式

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

{
  "Result" : true,
  "RequestId" : "D5B41051-FE06-4986-9D87-3779E627****"
}

錯誤碼

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