全部产品
Search
文档中心

媒体处理:QueryPipelineList - 查询管道

更新时间:Dec 26, 2024

通过管道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代码示例。

授权信息

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

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

请求参数

名称类型必填描述示例值
PipelineIdsstring

需要查询的管道 ID 列表,可通过 MPS 控制台 > 全局设置 > 管道获取。一次最多查询 10 个,用半角逗号(,)分隔。

d1ce4d3efcb549419193f50f1fcd****,72dfa5e679ab4be9a3ed9974c736****

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

1C538EAA-ACAF-5AD8-B091-A72C63007149
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

管道级别。

2
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
NonExistPidsarray

不存在的管道 ID 列表。

Stringstring

不存在的管道 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****"
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史