すべてのプロダクト
Search

このプロダクト

    Elasticsearch:DescribePipeline

    ドキュメントセンター

    Elasticsearch:DescribePipeline

    最終更新日:Mar 17, 2025

    Logstash クラスター内のパイプラインの詳細情報を照会します。

    デバッグ

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

    リクエストヘッダー

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

    リクエスト構文

    GET /openapi/logstashes/{InstanceId}/pipelines/{PipelineId} HTTP/1.1

    リクエストパラメーター

    パラメーター タイプ 場所 必須 値の例 メッセージ
    InstanceId String Path Yes ls-cn-oew1qbgl****

    Logstash インスタンスの ID。
    PipelineId String Path Yes pipeline_test

    ジョブの実行に使用する ApsaraVideo Media Processing (MPS) キューの ID。

    レスポンスパラメーター

    パラメーター タイプ 例 メッセージ
    RequestId String 829F38F6-E2D6-4109-90A6-888160BD1***

    リクエストの ID。
    Result Object

    返されたパイプラインに関する情報。 詳細については、「logstash.yml」をご参照ください。
    pipelineId String pipeline_test

    ジョブの実行に使用する ApsaraVideo Media Processing (MPS) キューの ID。
    gmtUpdateTime String 2020-06-20T07:26:47.000+0000

    パイプラインが更新された時刻。
    queueType String MEMORY

    キューのタイプ。有効な値：

    • MEMORY: 従来のメモリベースのキュー。
    • PERSISTED: ディスクベースの ACKed キュー (永続キュー)。
    queueCheckPointWrites Integer 1024

    キューチェックポイントの書き込み回数。
    queueMaxBytes Integer 1024

    キューの合計容量 (バイト単位)。単位：MB。
    config String input { } filter { } output { }

    パイプラインの具体的な構成。
    batchDelay Integer 50

    パイプラインバッチ遅延。単位：ミリ秒。
    workers Integer 2

    パイプラインワーカーの数。
    description String this is a test

    パイプラインの説明。
    gmtCreatedTime String 2020-06-20T07:26:47.000+0000

    パイプラインが作成された時刻。
    batchSize Integer 125

    パイプラインバッチのサイズ。
    pipelineStatus String RUNNING

    MPS キューの状態。有効な値：

    • NOT_DEPLOYED: ノードはデプロイされていません。
    • RUNNING
    • DELETED: 削除済み。コンソールにはこのステータスは表示されません。
    説明 構成されていないパイプラインパラメーターは、システムのデフォルト値が使用され、レスポンスには表示されません。

    例

    リクエストの例

    GET /openapi/logstashes/ls-cn-oew1qbgl****/pipelines/pipeline_test HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

    正常なレスポンスの例

    JSON 形式

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

{
  "Result" : {
    "pipelineId" : "test",
    "config" : "input {\n\n}\nfilter {\n\n}\noutput {\n\n}",
    "workers" : 2,
    "batchSize" : 100,
    "batchDelay" : 60,
    "queueType" : "MEMORY",
    "pipelineStatus" : "NOT_DEPLOYED",
    "queueMaxBytes" : 1024,
    "queueCheckPointWrites" : 1024,
    "gmtCreatedTime" : "2020-09-16T06:35:30.139Z",
    "gmtUpdateTime" : "2020-09-16T07:06:24.759Z"
  },
  "RequestId" : "49AEA9F3-B946-4102-8BD7-92E71C86****"
}

    エラーコード

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