ValidateConnection
更新時間:
驗證提供X-Pack監(jiān)控的Elasticsearch實例的聯(lián)通性。
說明 開啟Logstash的X-Pack監(jiān)控需配置Elasticsearch實例。配置后,即可在對應(yīng)Elasticsearch實例的Kibana中監(jiān)控Logstash實例。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求頭
該接口使用公共請求頭,無特殊請求頭。請參見公共請求參數(shù)文檔。
請求語法
POST /openapi/logstashes/{InstanceId}/validate-connection HTTP/1.1
請求參數(shù)
名稱 |
類型 |
位置 |
是否必選 |
示例值 |
描述 |
InstanceId | String | Path | 是 | ls-cn-oew1qbgl**** | Logstash實例ID。 |
ClientToken | String | Query | 否 | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** | 用于保證請求的冪等性。由客戶端生成該參數(shù)值,要保證在不同請求間唯一,最大不超過64個ASCII字符。 |
String | Body | 否 | { "endpoints": [ "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200" ], "userName": "elastic", "password": "xxxx" } | 指定需要連通的Elasticsearch實例的信息。 |
RequestBody
RequestBody中還需填入以下參數(shù),用來指定需要連通的Elasticsearch實例的信息。
說明 Logstash實例和Elasticsearch實例需滿足兼容性要求,請參見產(chǎn)品兼容性。
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
endpoints |
List<String\> |
是 |
["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"] |
提供X-Pack監(jiān)控的Elasticsearch實例的訪問地址。 |
userName |
String |
是 |
elastic |
Elasticsearch實例的用戶名。 |
password |
String |
是 |
xxx |
Elasticsearch實例的密碼。 |
示例如下。
{
"endpoints": [
"http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"
],
"userName": "elastic",
"password": "xxxx"
}
返回數(shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
Result | Boolean | true | 返回結(jié)果:
|
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****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
文檔內(nèi)容是否對您有幫助?