全部产品
Search

搜索本产品

    媒体处理：SearchPipeline - 搜索管道

    文档中心

    媒体处理：SearchPipeline - 搜索管道

    更新时间：Nov 08, 2024

    通过管道状态搜索管道。

    接口说明

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

    QPS 限制

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

    调试

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

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    mts:SearchPipelineget
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    PageSizelong否

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

    • 上限值：100。

    • 默认值：10。

    		10
    PageNumberlong否

    当前页号。默认值：1。

    		1
    Statestring否

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

    • All：全部管道。

    • Active：管道开启。

    • Paused：管道暂停。

    • 默认值：All。

    		Paused

    返回参数

    名称类型描述示例值
    object

    返回参数。

    TotalCountlong

    总条数。

    		1
    PageSizelong

    每页行数大小。

    		10
    RequestIdstring

    请求 ID。

    		338CA33A-AE83-5DF4-B6F2-C6D3ED8143F5
    PageNumberlong

    当前页码。

    		1
    PipelineListarray<object>

    管道列表。

    Pipelineobject

    管道详细信息。

    Speedstring

    管道类型。默认值：Standard（标准管道）。可取值：

    • Boost：倍速转码管道。

    • Standard：标准管道。

    • NarrowBandHDV2：窄带高清 2.0 管道。

    • AIVideoCover：智能截图管道。

    • AIVideoFPShot：视频 DNA 管道。

    • AIVideoCensor：智能审核管道。

    • AIVideoMCU：智能标签管道。

    • AIVideoSummary：视频摘要管道。

    • AIVideoPorn：视频鉴黄管道。

    • AIAudioKWS：音频关键字识别管道。

    • AIAudioASR：语音转文字管道。

    		Standard
    Statestring

    管道状态。可取值：

    • Active：管道开启。
    • Paused：管道暂停。
    		Paused
    SpeedLevellong

    管道级别。

    		1
    NotifyConfigobject

    MNS 通知配置。

    MqTopicstring

    接收到的消息队列。

    		example1,example2
    QueueNamestring

    阿里云轻量消息队列（原 MNS）中创建的队列。

    		example-queue-****
    MqTagstring

    标签。

    		mts-test
    Topicstring

    阿里云轻量消息队列（原 MNS）中创建的主题。

    		example-topic-****
    Rolestring

    当前 RAM 用户关联的角色。

    		AliyunMTSDefaultRole
    Namestring

    管道名称。

    		example-pipeline-****
    Idstring

    管道 ID。

    		d1ce4d3efcb549419193f50f1fcd****
    QuotaAllocatelong

    管道配额分配。

    		10
    CreationTimestring

    管道创建时间。

    		 2021-03-04T06:44:43Z

    示例

    正常返回示例

    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,
        "CreationTime": " 2021-03-04T06:44:43Z"
      }
    ]
  }
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-09-21OpenAPI 返回结构发生变更查看变更详情
    2023-07-13OpenAPI 返回结构发生变更查看变更详情
    2023-06-08OpenAPI 返回结构发生变更查看变更详情