更新管道。
接口說明
- 本接口可以修改指定管道的名稱、狀態及通知設定。
- 暫停管道后，如果工作流或其他單任務（如視頻審核、視頻 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 返回結構發生變更 | 查看變更詳情 |