edit-icon download-icon

QueryPipelineList

Last Updated: Feb 09, 2018

Description

The QueryPipelineList API queries MPS queues and returns the name and status of the specified MPS queues.

Request parameters

Parameter Type Required or not Description
Action String Yes API of the action, system required parameter. Set this parameter to QueryPipelineList.
PipelineIds String Yes List of MPS queue IDs separated by commas (,). A maximum of 10 MPS queues IDs can be entered.

Return parameters

Name Type Description
PipelineList AliyunPipeline[ ] MPS queue list
NonExistPids String[ ] List of non-existing MPS queue IDs. If no data exists, this structure is not returned.

Example

Request example

  1. http://mts.cn-hangzhou.aliyuncs.com/?PipelineIds=31fa3c9ca8134f9cec2b4b0b0f787830&Action=QueryPipelineList&<Public parameter>

Return example

XML

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

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. "Speed":"Standard",
  12. "NotifyConfig":{
  13. "Topic":"mts-topic-1"
  14. },
  15. "Role":"AliyunMTSDefaultRole"
  16. }]
  17. }
  18. }
Thank you! We've received your feedback.