文档

SearchPipeline - 搜索管道

更新时间:

通过管道状态搜索管道。

接口说明

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

QPS 限制

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
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
PipelineListobject []

管道列表。

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

阿里云消息服务中创建的队列。

example-queue-****
MqTagstring

标签。

mts-test
Topicstring

阿里云消息服务中创建的主题。

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 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-07-13OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-06-08OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈