ListPipeline - Elasticsearch

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request syntax

GET /openapi/logstashes/{InstanceId}/pipelines 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	Query	No	pipeline_test	The ID of the ApsaraVideo Media Processing (MPS) queue that is used to run the job.
page	Integer	Query	No	1	The page number of the returned page. Valid values: 1 to 200. Default value: 1.
size	Integer	Query	No	15	Specifies the number of pipelines on each page. Valid values: 1 to 200.

Response parameters


Parameter	Type	Example	Message
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****	The ID of the request.
Headers	Object		The header of the response.
X-Total-Count	Integer	2	The total number of returned entries.
Result	Array of Result		The response.
pipelineId	String	pipeline_test	The ID of the ApsaraVideo Media Processing (MPS) queue that is used to run the job.
gmtUpdateTime	String	2020-08-05T08:43:31.757Z	The time when the pipeline was updated.
gmtCreatedTime	String	2020-08-05T03:10:38.188Z	The time when the pipeline was created.
pipelineStatus	String	NOT_DEPLOYED	The status of the pipeline. Supported: NOT_DEPLOYED: The node is not deployed. RUNNING DELETED: Deleted. The console does not display this status.

Examples

Sample requests

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

Sample success responses

JSON format

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

Error code

For a list of error codes, see Service error codes.