UpdatePipeline - 更新管道：名称、状态及通知设定 - 媒体处理

更新管道。

接口说明

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

QPS限制

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
PipelineId	string	是	需要更新的管道ID。可以通过MPS控制台 > 全局设置 > 管道获取。	d1ce4d3efcb549419193f50f1fcd****
Name	string	是	修改后的管道名称。支持中英文、数字、中划线（-）等，不能以特殊字符开头，最大长度128字节。	example-pipeline-****
State	string	是	修改后的管道状态。 Active：管道开启。管道内的作业会被媒体转码服务调度转码执行。 Paused：管道暂停。管道内的作业不再会被媒体转码调度转码执行，并且所有作业状态维持在已提交状态。已经处于转码中的任务将继续转码，不受影响。	Paused
NotifyConfig	string	否	阿里云消息服务配置，即MNS队列或主题信息。更多信息，请参见NotifyConfig详情。	{"Topic":"example-topic-****"}
Role	string	否	当前RAM用户关联的角色。可以通过RAM控制台 > 身份管理 > 角色获取。	AliyunMTSDefaultRole

返回参数

名称	类型	描述	示例值
	object	返回参数。
RequestId	string	请求ID。	1FE0F96B-544D-4244-9D83-DFCFB0E5A231
Pipeline	object	管道详细信息。
Speed	string	管道类型。默认值：Standard（标准管道）。可取值： Boost：倍速转码管道。 Standard：标准管道。 NarrowBandHDV2：窄带高清2.0管道。 AIVideoCover：智能截图管道。 AIVideoFPShot：视频DNA管道。 AIVideoCensor：智能审核管道。 AIVideoMCU：智能标签管道。 AIVideoSummary：视频摘要管道。 AIVideoPorn：视频鉴黄管道。 AIAudioKWS：音频关键字识别管道。 AIAudioASR：语音转文字管道。	Standard
State	string	管道状态。取值： Active：管道开启。 Paused：管道暂停。	Paused
NotifyConfig	object	阿里云MNS通知配置。
MqTopic	string	接收到的消息队列。	example1,example2
QueueName	string	MNS中创建的队列。	example-queue-****
MqTag	string	标签。	mts-test
Topic	string	MNS中创建的主题。	example-topic-****
Name	string	修改后的管道名称。	example-pipeline-****
Role	string	当前RAM用户关联的角色。	AliyunMTSExampleRole
Id	string	管道ID。	d1ce4d3efcb549419193f50f1fcd****
QuotaAllocate	long	管道配额分配。	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,
    "ExtendConfig": {
      "IsBoostNew": true,
      "MaxMultiSpeed": 0,
      "MultiSpeedDowngradePolicy": ""
    }
  }
}

错误码

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