調(diào)用DescribePipeline，獲取Logstash實例的管道信息。

調(diào)試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求頭

該接口使用公共請求頭，無特殊請求頭。請參見公共請求參數(shù)文檔。

請求語法

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

請求參數(shù)

名稱 類型 位置 是否必選 示例值 描述
InstanceId String Path 是 ls-cn-oew1qbgl****

Logstash實例ID。
PipelineId String Path 是 pipeline_test

管道ID。

返回數(shù)據(jù)

名稱 類型 示例值 描述
RequestId String 829F38F6-E2D6-4109-90A6-888160BD1***

請求ID。
Result Object

返回的管道信息，更多詳細(xì)信息請參見logstash.yml。
pipelineId String pipeline_test

管道ID。
gmtUpdateTime String 2020-06-20T07:26:47.000+0000

管道更新時間。
queueType String MEMORY

隊列類型。支持：

  • MEMORY：基于內(nèi)存的傳統(tǒng)隊列。
  • PERSISTED：基于磁盤的ACKed隊列（持久隊列）。
queueCheckPointWrites Integer 1024

隊列檢查點寫入數(shù)。
queueMaxBytes Integer 1024

隊列的總?cè)萘浚ㄒ宰止?jié)數(shù)表示）。單位：MB。
config String input { } filter { } output { }

管道具體配置。
batchDelay Integer 50

管道批延遲。單位：毫秒。
workers Integer 2

管道工作線程數(shù)。
description String this is a test

管道描述。
gmtCreatedTime String 2020-06-20T07:26:47.000+0000

管道創(chuàng)建時間。
batchSize Integer 125

管道批大小。
pipelineStatus String RUNNING

管道狀態(tài)。支持：

  • NOT_DEPLOYED：未部署
  • RUNNING：運行中
  • DELETED：已刪除（控制臺不展示此狀態(tài)）
說明 未配置的管道參數(shù)將使用系統(tǒng)默認(rèn)值，不會在返回結(jié)果中顯示。

示例

請求示例

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。