通过管道状态搜索管道。
接口说明
本接口通过管道状态搜索管道,如果不指定管道状态则默认搜索全部管道。
QPS限制
本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PageSize | long | 否 | 分页查询时设置的每页行数大小。
| 10 |
PageNumber | long | 否 | 当前页号。默认值:1。 | 1 |
State | string | 否 | 需要搜索的管道状态。如果为空则默认搜索所有管道。
| Paused |
返回参数
示例
正常返回示例
JSON
格式
{
"TotalCount": 1,
"PageSize": 10,
"RequestId": "338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5",
"PageNumber": 1,
"PipelineList": {
"Pipeline": [
{
"Speed": "Standard",
"State": "Paused",
"SpeedLevel": 1,
"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": ""
}
}
]
}
}
错误码
访问错误中心查看更多错误码。