ValidateConnection - Elasticsearch - Alibaba Cloud ドキュメントセンター

Logstash クラスターの X-Pack Monitoring 機能を構成する際に、Logstash クラスターとその関連 Elasticsearch クラスター間の接続性をテストします。

説明 Logstash の X-Pack monitoring を有効にするには、Elasticsearch インスタンスを構成する必要があります。構成後、対応する Elasticsearch インスタンスの Kibana で Logstash インスタンスを監視できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、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****	リクエストのべき等性を確保するために使用されます。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。
	String	Body	いいえ	{ "endpoints": [ "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200" ], "userName": "elastic", "password": "xxxx" }	接続される Elasticsearch インスタンスに関する情報。

リクエスト本文

関連付けられた 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

ブール値

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****"
}

エラーコード

エラーコードのリストについては、「サービスエラーコード」をご参照ください。