调用UpdatePipeline更新管道。

使用说明

本接口可以修改指定管道的名称、状态及通知设定。

QPS限制

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

调试

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

请求参数

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

操作接口名，系统规定参数，取值：UpdatePipeline。

PipelineId String 是 d1ce4d3efcb549419193f50f1fcd****

需要更新的管道ID。可以通过MPS控制台 > 全局设置 > 管道获取。

Name String 是 example-pipeline-****

修改后的管道名称。支持中英文、数字、中划线（-）等，不能以特殊字符开头，最大长度128字节。
State String 是 Paused

修改后的管道状态。

  • Active：管道开启。管道内的作业会被媒体转码服务调度转码执行。
  • Paused：管道暂停。管道内的作业不再会被媒体转码调度转码执行，并且所有作业状态维持在已提交状态。已经处于转码中的任务将继续转码，不受影响。
NotifyConfig String 否 {"Topic":"example-topic-****"}

阿里云消息服务配置，即MNS队列或主题信息。更多信息，请参见NotifyConfig详情。

Role String 否 AliyunMTSDefaultRole

当前RAM用户关联的角色。可以通过RAM控制台 > 身份管理 > 角色获取。

返回数据

名称 类型 示例值 描述
RequestId String 1FE0F96B-544D-4244-9D83-DFCFB0E5A231

请求ID。
Pipeline Object

管道详细信息。
Speed String Standard

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

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

管道状态。取值：

  • Active：管道开启。
  • Paused：管道暂停。
NotifyConfig Object

阿里云MNS通知配置。
MqTopic String example1,example2

接收到的消息队列。
QueueName String example-queue-****

MNS中创建的队列。
MqTag String mts-test

标签。
Topic String example-topic-****

MNS中创建的主题。
Name String example-pipeline-****

修改后的管道名称。
Role String AliyunMTSExampleRole

当前RAM用户关联的角色。
Id String d1ce4d3efcb549419193f50f1fcd****

管道ID。
QuotaAllocate Long 10

管道配额分配。

示例

请求示例

http(s)://mts.cn-hangzhou.aliyuncs.com/?Action=UpdatePipeline
&PipelineId=d1ce4d3efcb549419193f50f1fcd****
&Name=example-pipeline-****
&State=Paused
&NotifyConfig={"Topic":"example-topic-****"}
&Role=AliyunMTSDefaultRole
&<公共请求参数>

正常返回示例

XML格式 

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

<UpdatePipelineResponse>
    <RequestId>1FE0F96B-544D-4244-9D83-DFCFB0E5A231</RequestId>
    <Pipeline>
        <Speed>Standard</Speed>
        <State>Paused</State>
        <NotifyConfig>
            <MqTopic>example1,example2</MqTopic>
            <QueueName>example-queue-****</QueueName>
            <MqTag>mts-test</MqTag>
            <Topic>example-topic-****</Topic>
        </NotifyConfig>
        <Name>example-pipeline-****</Name>
        <Role>AliyunMTSExampleRole</Role>
        <Id>d1ce4d3efcb549419193f50f1fcd****</Id>
        <QuotaAllocate>10</QuotaAllocate>
    </Pipeline>
</UpdatePipelineResponse>

JSON格式 

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

{
  "RequestId" : "1FE0F96B-544D-4244-9D83-DFCFB0E5A231",
  "Pipeline" : {
    "Speed" : "Standard",
    "State" : "Paused",
    "NotifyConfig" : {
      "MqTopic" : "example1,example2",
      "QueueName" : "example-queue-****",
      "MqTag" : "mts-test",
      "Topic" : "example-topic-****"
    },
    "Name" : "example-pipeline-****",
    "Role" : "AliyunMTSExampleRole",
    "Id" : "d1ce4d3efcb549419193f50f1fcd****",
    "QuotaAllocate" : 10
  }
}

错误码

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