文档

UpdatePipeline - 更新管道:名称、状态及通知设定

更新时间:

更新管道。

接口说明

  • 本接口可以修改指定管道的名称、状态及通知设定。
  • 暂停管道后,如果工作流或其他单任务(如视频审核、视频 DNA 等)中选择使用状态为已暂停的管道,会导致任务失败无法进行。

注意 暂停管道后,不会影响已经提交的任务。如果任务提交后关闭管道,已经进入处理排队的任务将无法取消,会正常执行并收取相应的费用。

QPS 限制

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

调试

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

授权信息

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

请求参数

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

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

d1ce4d3efcb549419193f50f1fcd****
Namestring

修改后的管道名称。支持中英文、数字、中划线(-)等,不能以特殊字符开头,最大长度 128 字节。

example-pipeline-****
Statestring

修改后的管道状态。

  • Active:管道开启。管道内的作业会被媒体转码服务调度转码执行。
  • Paused:管道暂停。管道内的作业不再会被媒体转码调度转码执行,并且所有作业状态维持在已提交状态。已经处于转码中的任务将继续转码,不受影响。
Paused
NotifyConfigstring

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

{"Topic":"example-topic-****"}
Rolestring

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

AliyunMTSDefaultRole
ExtendConfigstring

扩展配置

{\"IsBoostNew\":true,\"MultiSpeedDowngradePolicy\":\"NormalSpeed\",\"MaxMultiSpeed\":20}

返回参数

名称类型描述示例值
object

返回参数。

RequestIdstring

请求 ID。

1FE0F96B-544D-4244-9D83-DFCFB0E5A231
Pipelineobject

管道详细信息。

Speedstring

管道类型。默认值:Standard(标准管道)。可取值:

  • Boost:倍速转码管道。

  • Standard:标准管道。

  • NarrowBandHDV2:窄带高清 2.0 管道。

  • AIVideoCover:智能截图管道。

  • AIVideoFPShot:视频 DNA 管道。

  • AIVideoCensor:智能审核管道。

  • AIVideoMCU:智能标签管道。

  • AIVideoSummary:视频摘要管道。

  • AIVideoPorn:视频鉴黄管道。

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

  • AIAudioASR:语音转文字管道。

Standard
Statestring

管道状态。取值:

  • Active:管道开启。
  • Paused:管道暂停。
Paused
NotifyConfigobject

阿里云 MNS 通知配置。

MqTopicstring

接收到的消息队列。

example1,example2
QueueNamestring

MNS 中创建的队列。

example-queue-****
MqTagstring

标签。

mts-test
Topicstring

MNS 中创建的主题。

example-topic-****
Namestring

修改后的管道名称。

example-pipeline-****
Rolestring

当前 RAM 用户关联的角色。

AliyunMTSExampleRole
Idstring

管道 ID。

d1ce4d3efcb549419193f50f1fcd****
QuotaAllocatelong

管道配额分配。

10

示例

正常返回示例

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
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-06-13OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)