通过管道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代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
mts:QueryPipelineList |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PipelineIds |
string |
是 |
需要查询的管道 ID 列表,可通过 MPS 控制台 > 全局设置 > 管道获取。一次最多查询 10 个,用半角逗号(,)分隔。 |
d1ce4d3efcb549419193f50f1fcd****,72dfa5e679ab4be9a3ed9974c736**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数。 |
||
| RequestId |
string |
请求 ID。 |
1C538EAA-ACAF-5AD8-B091-A72C63007149 |
| PipelineList |
object |
||
| Pipeline |
array<object> |
管道列表。 |
|
|
array<object> |
返回参数。 |
||
| Speed |
string |
管道类型。默认值:Standard(标准管道)。可取值:
|
Standard |
| State |
string |
管道状态。
|
Paused |
| SpeedLevel |
integer |
管道级别。 |
2 |
| NotifyConfig |
object |
阿里云 MNS 通知配置。 |
|
| MqTopic |
string |
接收到的消息队列。 |
example1,example2 |
| QueueName |
string |
阿里云轻量消息队列(原 MNS) 中创建的队列名称。 |
example-queue-**** |
| MqTag |
string |
标签。 |
mts-test |
| Topic |
string |
阿里云轻量消息队列(原 MNS) 中创建的主题名称。 |
example-topic-**** |
| Role |
string |
当前 RAM 用户关联的角色。 |
AliyunMTSDefaultRole |
| Name |
string |
管道名称。 |
example-pipeline-**** |
| Id |
string |
管道 ID。 |
d1ce4d3efcb549419193f50f1fcd**** |
| QuotaAllocate |
integer |
管道配额分配。 |
10 |
| ExtendConfig |
object |
||
| IsBoostNew |
boolean |
||
| MaxMultiSpeed |
integer |
||
| MultiSpeedDowngradePolicy |
string |
||
| NonExistPids |
object |
||
| String |
array |
不存在的管道 ID 列表。 |
|
|
string |
不存在的管道 ID 列表,无数据时该参数不返回。 说明
如果输入的管道 ID 确认无误时返回此参数,请检查您提交请求的 UID 和管道所在 UID 是否为同一个。 |
72dfa5e679ab4be9a3ed9974c736**** |
示例
正常返回示例
JSON格式
{
"RequestId": "1C538EAA-ACAF-5AD8-B091-A72C63007149",
"PipelineList": {
"Pipeline": [
{
"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,
"ExtendConfig": {
"IsBoostNew": true,
"MaxMultiSpeed": 0,
"MultiSpeedDowngradePolicy": ""
}
}
]
},
"NonExistPids": {
"String": [
"72dfa5e679ab4be9a3ed9974c736****"
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。