调用QueryPipelineList通过管道ID查询管道。
使用说明
- 本接口一次最多可查询10个管道。
- 当返回值为
"Code": "InvalidIdentity.ServiceDisabled","Message": "The request identity was not allowed operated.","Recommend"时,请检查您是否拥有MPS权限(是否授权AliyunMTSDefaultRole角色)、账号是否欠费。
QPS限制
本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | QueryPipelineList | 操作接口名,系统规定参数,取值: QueryPipelineList。 |
| PipelineIds | String | 是 | d1ce4d3efcb549419193f50f1fcd****,72dfa5e679ab4be9a3ed9974c736**** | 需要查询的管道ID列表,可通过MPS控制台 > 全局设置 > 管道获取。一次最多查询10个,用半角逗号(,)分隔。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 1C538EAA-ACAF-5AD8-B091-A72C63007149 | 请求ID。 |
| PipelineList | Array of Pipeline | 管道列表。 |
|
| Pipeline | |||
| Speed | String | Standard | 管道类型。默认值:Standard(标准管道)。可取值:
|
| State | String | Paused | 管道状态。
|
| SpeedLevel | Long | 2 | 管道级别。 |
| NotifyConfig | Object | 阿里云MNS通知配置。 |
|
| MqTopic | String | example1,example2 | 接收到的消息队列。 |
| QueueName | String | example-queue-**** | 阿里云消息服务中创建的队列名称。 |
| MqTag | String | mts-test | 标签。 |
| Topic | String | example-topic-**** | 阿里云消息服务中创建的主题名称。 |
| Role | String | AliyunMTSDefaultRole | 当前RAM用户关联的角色。 |
| Name | String | example-pipeline-**** | 管道名称。 |
| Id | String | d1ce4d3efcb549419193f50f1fcd**** | 管道ID。 |
| QuotaAllocate | Long | 10 | 管道配额分配。 |
| NonExistPids | Array of String | 72dfa5e679ab4be9a3ed9974c736**** | 不存在的管道ID列表,无数据时该参数不返回。 说明 如果输入的管道ID确认无误时返回此参数,请检查您提交请求的UID和管道所在UID是否为同一个。 |
示例
请求示例
http(s)://mts.cn-hangzhou.aliyuncs.com/?Action=QueryPipelineList
&PipelineIds=d1ce4d3efcb549419193f50f1fcd****,72dfa5e679ab4be9a3ed9974c736****
&<公共请求参数>
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<QueryPipelineListResponse>
<RequestId>1C538EAA-ACAF-5AD8-B091-A72C63007149</RequestId>
<PipelineList>
<Speed>Standard</Speed>
<State>Paused</State>
<SpeedLevel>2</SpeedLevel>
<NotifyConfig>
<MqTopic>example1,example2</MqTopic>
<QueueName>example-queue-****</QueueName>
<MqTag>mts-test</MqTag>
<Topic>example-topic-****</Topic>
</NotifyConfig>
<Role>AliyunMTSDefaultRole</Role>
<Name>example-pipeline-****</Name>
<Id>d1ce4d3efcb549419193f50f1fcd****</Id>
<QuotaAllocate>10</QuotaAllocate>
</PipelineList>
<NonExistPids>72dfa5e679ab4be9a3ed9974c736****</NonExistPids>
</QueryPipelineListResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "1C538EAA-ACAF-5AD8-B091-A72C63007149",
"PipelineList" : [ {
"Speed" : "Standard",
"State" : "Paused",
"SpeedLevel" : 2,
"NotifyConfig" : {
"MqTopic" : "example1,example2",
"QueueName" : "example-queue-****",
"MqTag" : "mts-test",
"Topic" : "example-topic-****"
},
"Role" : "AliyunMTSDefaultRole",
"Name" : "example-pipeline-****",
"Id" : "d1ce4d3efcb549419193f50f1fcd****",
"QuotaAllocate" : 10
} ],
"NonExistPids" : [ "72dfa5e679ab4be9a3ed9974c736****" ]
}
错误码
访问错误中心查看更多错误码。