Queries the detailed information of a pipeline in a Logstash cluster.
Debugging
Request headers
This operation uses only common request headers. For more information, see Common request headers.
Request syntax
GET /openapi/logstashes/{InstanceId}/pipelines/{PipelineId} HTTP/1.1
Request parameters
Parameter | Type | Location | Required | Example value | Message |
---|---|---|---|---|---|
InstanceId | String | Path | Yes | ls-cn-oew1qbgl**** | The ID of the Logstash instance. |
PipelineId | String | Path | Yes | pipeline_test | The ID of the ApsaraVideo Media Processing (MPS) queue that is used to run the job. |
Response parameters
Parameter | Type | Example | Message |
---|---|---|---|
RequestId | String | 829F38F6-E2D6-4109-90A6-888160BD1*** | The ID of the request. |
Result | Object | The information about the returned pipeline. For more information, see logstash.yml. |
|
pipelineId | String | pipeline_test | The ID of the ApsaraVideo Media Processing (MPS) queue that is used to run the job. |
gmtUpdateTime | String | 2020-06-20T07:26:47.000+0000 | The time when the pipeline was updated. |
queueType | String | MEMORY | The type of the queue. Valid values:
|
queueCheckPointWrites | Integer | 1024 | Number of queue checkpoint writes. |
queueMaxBytes | Integer | 1024 | The total capacity of the queue in bytes. Unit: MB. |
config | String | input { } filter { } output { } | The specific configuration of the pipeline. |
batchDelay | Integer | 50 | Pipeline batch delay. Unit: milliseconds. |
workers | Integer | 2 | The number of pipeline workers. |
description | String | this is a test | The description of the pipeline. |
gmtCreatedTime | String | 2020-06-20T07:26:47.000+0000 | The time when the pipeline was created. |
batchSize | Integer | 125 | The size of the pipeline batch. |
pipelineStatus | String | RUNNING | The state of the MPS queue. Valid values:
|
Examples
Sample requests
GET /openapi/logstashes/ls-cn-oew1qbgl****/pipelines/pipeline_test HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
Sample success responses
JSON
format
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****"
}
Error code
For a list of error codes, see Service error codes.