更新管道。
接口说明
- 本接口可以修改指定管道的名称、状态及通知设定。
- 暂停管道后，如果工作流或其他单任务（如视频审核、视频 DNA 等）中选择使用状态为已暂停的管道，会导致任务失败无法进行。
注意 暂停管道后，不会影响已经提交的任务。如果任务提交后关闭管道，已经进入处理排队的任务将无法取消，会正常执行并收取相应的费用。
QPS 限制
本接口的单用户 QPS 限制为 100 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| mts:UpdatePipeline | update |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PipelineId | string | 是 | 需要更新的管道 ID。可以通过 MPS 控制台 > 全局设置 > 管道获取。 | d1ce4d3efcb549419193f50f1fcd**** |
| Name | string | 是 | 修改后的管道名称。支持中英文、数字、中划线（-）等，不能以特殊字符开头，最大长度 128 字节。 | example-pipeline-**** |
| State | string | 是 | 修改后的管道状态。
| Paused |
| NotifyConfig | string | 否 | 阿里云轻量消息队列（原 MNS） 配置，即 MNS 队列或主题信息。更多信息，请参见 NotifyConfig 详情。 | {"Topic":"example-topic-****"} |
| Role | string | 否 | 当前 RAM 用户关联的角色。可以通过 RAM 控制台 > 身份管理 > 角色获取。 | AliyunMTSDefaultRole |
| ExtendConfig | string | 否 | 扩展配置 | {\"IsBoostNew\":true,\"MultiSpeedDowngradePolicy\":\"NormalSpeed\",\"MaxMultiSpeed\":20} |
返回参数
示例
正常返回示例
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-13 | OpenAPI 返回结构发生变更 | 查看变更详情 |