edit-icon download-icon

SearchPipeline

Last Updated: Mar 15, 2018

Description

The SearchPipeline API searches for MPS queues by MPS queue status.

Request parameters

Parameter Type Required or not Description
Action String Yes API of the action, system required parameter. Set this parameter to SearchPipeline.
PageNumber Long No Current page number, which starts from 1. The default value is 1.
PageSize Long No When querying by page, this parameter indicates the size of each page (number of lines per page). The default value is 10, and the maximum value is 100.
State String No MPS queue status, which has the following options: All, Active, Paused, and Deleted. The default value is All.

Return parameters

Name Type Description
PipelineList AliyunPipeline[ ] MPS queue list

Example

Request example

  1. http://mts.cn-hangzhou.aliyuncs.com/?Action=SearchPipeline&<Public parameter>

Return example

XML

  1. <SearchPipelineResponse>
  2. <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>
  3. <TotalCount>1</TotalCount>
  4. <PageNumber>1</PageNumber>
  5. <PageSize>10</PageSize>
  6. <PipelineList list="true">
  7. <Pipeline>
  8. <Id>31fa3c9ca8134f9cec2b4b0b0f787830</Id>
  9. <Name>example-pipeline</Name>
  10. <State>Active</State>
  11. <NotifyConfig>
  12. <Topic>mts-topic-1</Topic>
  13. </NotifyConfig>
  14. <Role>AliyunMTSDefaultRole</Role>
  15. </Pipeline>
  16. </PipelineList>
  17. </SearchPipeline>

JSON

  1. {
  2. "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  3. "TotalCount": 1,
  4. "PageNumber": 1,
  5. "PageSize": 10,
  6. "PipelineList": {
  7. "Pipeline ": [{
  8. "Id": "31fa3c9ca8134f9cec2b4b0b0f787830",
  9. "Name": "example-pipeline",
  10. "State": "Active",
  11. "NotifyConfig":{
  12. "Topic":"mts-topic-1"
  13. },
  14. "Role":"AliyunMTSDefaultRole"
  15. }]
  16. }
  17. }
Thank you! We've received your feedback.