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

Logstash クラスターのパイプラインをクエリします。

デバッグ

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

リクエストヘッダー

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

リクエスト構文

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

リクエストパラメーター

パラメーター	タイプ	場所	必須	値の例	メッセージ
InstanceId	String	Path	はい	ls-cn-oew1qbgl****	Logstash インスタンスの ID。
pipelineId	String	Query	いいえ	pipeline_test	ジョブの実行に使用する ApsaraVideo Media Processing (MPS) キューの ID。
page	Integer	Query	いいえ	1	返されるページのページ番号。有効な値：1 ～ 200。デフォルト値：1。
size	Integer	Query	いいえ	15	各ページに表示するパイプラインの数を指定します。有効な値：1 ～ 200。

レスポンスパラメーター

パラメーター	タイプ	例	メッセージ
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****	リクエストの ID。
Headers	Object		レスポンスのヘッダー。
X-Total-Count	Integer	2	返されたエントリの総数。
Result	Result の配列		レスポンス。
pipelineId	String	pipeline_test	ジョブの実行に使用する ApsaraVideo Media Processing (MPS) キューの ID。
gmtUpdateTime	String	2020-08-05T08:43:31.757Z	パイプラインが更新された日時。
gmtCreatedTime	String	2020-08-05T03:10:38.188Z	パイプラインが作成された日時。
pipelineStatus	String	NOT_DEPLOYED	パイプラインのステータス。以下をサポート: NOT_DEPLOYED: ノードはデプロイされていません。 RUNNING DELETED: 削除済み。コンソールにはこのステータスは表示されません。

例

リクエストの例

GET /openapi/logstashes/ls-cn-oew1qbgl****/pipelines?pipelineId=pipeline_test&page=1&size=15 HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

成功レスポンスの例

JSON 形式

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

{
  "Result" : [ {
    "pipelineId" : "datahub_test",
    "pipelineStatus" : "RUNNING",
    "gmtCreatedTime" : "2020-09-09T02:21:28.844Z",
    "gmtUpdateTime" : "2020-09-09T06:09:43.796Z"
  }, {
    "pipelineId" : "test",
    "pipelineStatus" : "NOT_DEPLOYED",
    "gmtCreatedTime" : "2020-09-16T06:35:30.139Z",
    "gmtUpdateTime" : "2020-09-16T07:06:24.759Z"
  }, {
    "pipelineId" : "test_1",
    "pipelineStatus" : "NOT_DEPLOYED",
    "gmtCreatedTime" : "2020-09-16T06:33:05.290Z",
    "gmtUpdateTime" : "2020-09-16T06:33:05.290Z"
  } ],
  "RequestId" : "AA6771E2-4007-4F1F-ADCB-16DAABB9****",
  "Headers" : {
    "X-Total-Count" : 3
  }
}

エラーコード

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