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

Elasticsearch:パイプライン管理構成の更新

最終更新日:Mar 17, 2025

Logstash クラスター内のパイプラインの管理方法を更新します。

説明 パイプラインは、プロファイル管理と Kibana パイプライン管理の 2 つの方法で管理できます。 Kibana パイプライン管理はコンソールではサポートされていません。この機能は、API オペレーションを呼び出すことによってのみ使用できます。

デバッグ

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

リクエストヘッダー

DescribeEniMonitorData オペレーションには、操作固有のリクエストヘッダーはなく、共通のリクエストヘッダーのみを使用します。 詳細については、共通リクエストパラメーターのドキュメントをご参照ください。

リクエスト構文

POST /openapi/logstashes/{InstanceId}/pipeline-management-config HTTP/1.1

リクエストパラメーター

パラメーター

タイプ

位置

必須

説明

InstanceId String Path はい ls-cn-oew1qbgl****

Logstash クラスターの ID。

clientToken String Query いいえ 5A2CFF0E-5718-45B5-9D4D-70B3FF****

リクエストのべき等性を確保するために使用されます。クライアントを使用してトークンを生成できますが、トークンが異なるリクエスト間で一意であることを確認する必要があります。 トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。

Object Body いいえ

関連付けられている Elasticsearch クラスターに関する情報。

endpoints String の配列 Body いいえ ["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]

Kibana ベースのパイプライン管理を有効にした後、Kibana サービスを提供する Elasticsearch クラスターのアクセスアドレス。

userName String Body いいえ elastic

Kibana コンソールにログインするために使用されるユーザー名。

password String Body いいえ ******

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

pipelineIds String の配列 Body いいえ ["testKibanaManagement"]

Kibana を使用して管理するパイプライン。

pipelineManagementType String Body いいえ ES

パイプライン管理方法。有効な値:

  • ES: Kibana ベースのパイプライン管理
  • MULTIPLE_PIPELINE: 構成ファイルベースのパイプライン管理

レスポンスパラメーター

パラメーター

タイプ

サンプル値

説明

Result ブール値 true

次の結果が返されます。

  • true: 更新は成功しました。
  • false: 更新は失敗しました。
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

リクエストの ID。

サンプルリクエスト

POST /openapi/logstashes/ls-cn-oew1qbgl****/pipeline-management-config?clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

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

サンプルの成功レスポンス

JSON 形式

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

{
  "Result" : true,
  "RequestId" : "135E9F19-277D-4E34-85AC-EB394AA2****"
}

エラーコード

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