すべてのプロダクト
Search
ドキュメントセンター

Elasticsearch:ListPipelineIds

最終更新日:Mar 17, 2025

Kibana パイプライン管理を設定するために ListPipelineIds を呼び出す場合は、Logstash と Kibana 間の接続性をテストし、ターゲット Kibana で作成されたパイプライン ID のリストを取得します。

説明 パイプライン管理は、構成ファイル管理と Kibana パイプライン管理に分かれています。一部のリージョンのコンソールでは、Kibana パイプライン管理は公開されていません。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

リクエストヘッダー

この操作では、共通リクエストヘッダーのみを使用します。詳細については、「共通リクエストパラメーター」をご参照ください。

リクエスト構文


     POST /openapi/instances/[InstanceId]/pipeline-ids HTTP/1.1 
   

リクエストパラメーター

パラメーター タイプ 位置 必須 説明
InstanceId String Path はい ls-cn-7g1umu96oit2e****

Logstash インスタンス ID。

リクエスト本文

管理パイプラインの Kibana 情報を確認するには、リクエスト本文に次のパラメーターを入力する必要があります。

パラメーター

タイプ

必須

説明

userName

String

はい

elastic

Kibana コンソールにログインするために使用されるユーザー名。デフォルト値:elastic。

password

String

はい

xxxxxx

Kibana コンソールにログインするために使用されるパスワード。

レスポンスパラメーター

パラメーター タイプ 説明
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

リクエストの ID。

Result Result の配列

結果のリストを返します。

available ブール値 true

パイプラインが使用可能かどうか。値は次のとおりです。

  • true:使用可能。
  • false:使用不可。
code String OK

パイプラインはエラーコードのために使用できません。

message String OK

パイプラインが使用できないエラーメッセージ。

pipelineId String testKibanaManagement

Kibana で作成されたパイプラインの ID。

リクエストの例


     POST /openapi/instances/ls-cn-7g1umu96oit2e ****/pipeline-ids HTTP/1.1 public request header {"userName":"elastic", "password":"xxxxxx"} 
   

正常なレスポンスの例

JSON 形式


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

エラーコード

エラーコードのリストについては、 API エラーセンター をご覧ください。