调用SearchPipeline搜索管道。

使用说明

本接口通过管道状态搜索管道,如果不指定管道状态则默认搜索全部管道。

QPS限制

本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String SearchPipeline

操作接口名,系统规定参数,取值: SearchPipeline

PageSize Long 10

分页查询时设置的每页行数大小。

  • 上限值:100
  • 默认值:10
PageNumber Long 1

当前页号。默认值:1

State String Paused

需要搜索的管道状态。如果为空则默认搜索所有管道。

  • All:全部管道。
  • Active:已启用。
  • Paused:已暂停。
  • 默认值:All

返回数据

名称 类型 示例值 描述
TotalCount Long 1

总条数。

PageSize Long 10

每页行数大小。

RequestId String 338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5

请求ID。

PageNumber Long 1

当前页码。

PipelineList Array of Pipeline

管道列表。

Pipeline
Speed String Standard

管道类型。默认值:Standard(标准管道)。可取值:

  • Boost:倍速转码管道。
  • Standard:标准管道。
  • NarrowBandHDV2:窄带高清2.0管道。
  • AIVideoCover:智能截图管道。
  • AIVideoFPShot:视频DNA管道。
  • AIVideoCensor:智能审核管道。
  • AIVideoMCU:智能标签管道。
  • AIVideoSummary:视频摘要管道。
  • AIVideoPorn:视频鉴黄管道。
  • AIAudioKWS:音频关键字识别管道。
  • AIAudioASR:语音转文字管道。
State String Paused

管道状态。可取值:

  • Active:使用中。
  • Paused:已暂停。
SpeedLevel Long 1

管道级别。

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

管道配额分配。

示例

请求示例

http(s)://mts.cn-shanghai.aliyuncs.com/?Action=SearchPipeline
&PageSize=10
&PageNumber=1
&State=Paused
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<SearchPipelineResponse>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5</RequestId>
    <PageNumber>1</PageNumber>
    <PipelineList>
        <Speed>Standard</Speed>
        <State>Paused</State>
        <SpeedLevel>1</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>
</SearchPipelineResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "PageSize" : 10,
  "RequestId" : "338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5",
  "PageNumber" : 1,
  "PipelineList" : [ {
    "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
  } ]
}

错误码

访问错误中心查看更多错误码。