调用QueryPipelineList接口通过管道ID查询管道,并返回指定管道的名称、状态。

调试

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

请求参数

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

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

PipelineIds String d1ce4d3efcb549419193f50f1fcd****

管道ID列表。最多一次查询10个,用英文逗号(,)分隔。

返回数据

名称 类型 示例值 描述
RequestId String 3C281F1B-8EDC-470A-9D42-498B139D****

请求ID。

PipelineList Array of Pipeline

管道列表。

Pipeline
Speed String Standard

管道类型。

  • 取值:Boost、Standard、NarrowBandHDV2、AIVideoCover、AIVideoRecogni、AIVideoSummary、AIVideoPorn、AIAudioKWS、AIAudioASR。
  • 默认值:Standard
State String Paused

管道状态。

  • Active:表示管道内的作业会被调度给转码系统转码。
  • Paused:表示管道暂停,作业不再会被调度到转码系统,管道内的所有作业状态维持在已提交状态,正在执行的作业不受影响,继续进行。
NotifyConfig Object

MNS通知配置。

QueueName String mts-queue-1

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

Topic String mts-topic-1

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

Role String AliyunMTSDefaultRole

角色。

Name String example-pipeline

管道名称。

Id String d1ce4d3efcb549419193f50f1fcd****

管道ID。

NonExistPids Array of String

不存在的管道ID列表,无数据时该结构不返回。

示例

请求示例

http(s)://[Endpoint]/?Action=QueryPipelineList
&PipelineIds=d1ce4d3efcb549419193f50f1fcd****
&公共请求参数

正常返回示例

XML格式

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

<QueryPipelineListResponse>
    <RequestId>3C281F1B-8EDC-470A-9D42-498B139D****</RequestId>
    <PipelineList>
        <Speed>Standard</Speed>
        <State>Paused</State>
        <NotifyConfig>
            <QueueName>mts-queue-1</QueueName>
            <Topic>mts-topic-1</Topic>
        </NotifyConfig>
        <Role>AliyunMTSDefaultRole</Role>
        <Name>example-pipeline</Name>
        <Id>d1ce4d3efcb549419193f50f1fcd****</Id>
    </PipelineList>
    <NonExistPids>无</NonExistPids>
</QueryPipelineListResponse>

JSON格式

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

{
  "RequestId" : "3C281F1B-8EDC-470A-9D42-498B139D****",
  "PipelineList" : [ {
    "Speed" : "Standard",
    "State" : "Paused",
    "NotifyConfig" : {
      "QueueName" : "mts-queue-1",
      "Topic" : "mts-topic-1"
    },
    "Role" : "AliyunMTSDefaultRole",
    "Name" : "example-pipeline",
    "Id" : "d1ce4d3efcb549419193f50f1fcd****"
  } ],
  "NonExistPids" : [ "无" ]
}

错误码

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