更新管道。
接口说明
本接口可以修改指定管道的名称、状态及通知设定。
暂停管道后,如果工作流或其他单任务(如视频审核、视频 DNA 等)中选择使用状态为已暂停的管道,会导致任务失败无法进行。
QPS 限制
本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
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} |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数。 |
||
| RequestId |
string |
请求 ID。 |
1FE0F96B-544D-4244-9D83-DFCFB0E5A231 |
| Pipeline |
object |
管道详细信息。 |
|
| Speed |
string |
管道类型。默认值:Standard(标准管道)。可取值:
|
Standard |
| State |
string |
管道状态。取值:
|
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 |
integer |
管道配额分配。 |
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
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。