edit-icon download-icon

UpdatePipeline

Last Updated: Feb 08, 2018

Description

The UpdatePipeline API updates an MPS queue. You can modify the name and notification settings and change the status of an MPS queue.

Request parameters

Parameter Type Required or not Description
Action String Yes API of the action, system required parameter. Set this parameter to UpdatePipeline.
PipelineId String Yes MPS queue ID.
Name String Yes MPS queue name, up to 128 characters.
State String Yes MPS queue status, which has the following options: Active and Paused.
- Active: tasks in the MPS queue will be scheduled, transcoded, and executed by Media Processing.
- Paused: The MPS queue is paused, and tasks in the MPS queue will not be scheduled, transcoded, and executed by Media Processing. The status of all tasks in the MPS queue is Submitted. Ongoing transcoding tasks are not paused.
NotifyConfig String No Message Service configuration, for example, {"Topic":"mts-topic-1"}.
Role String No Role

Return parameters

Name Type Description
Pipeline String MPS queue

Example

Request example

  1. http://mts.cn-hangzhou.aliyuncs.com/?PipelineId=5efb0fa33836432e9488ed56eb0075c8&Name=example-watermark&State=Paused&Action=UpdatePipeline&NotifyConfig=%7b&quot%3btopic&quot%3b%3a&quot%3bmts-topic-1&quot%3b%2c+&quot%3brole&quot%3b%3a&quot%3brole1&quot%3b%7d<Publib parameter>

Return example

XML

  1. <UpdatePipelineResponse>
  2. <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>
  3. <Pipeline>
  4. <Id>31fa3c9ca8134f9cec2b4b0b0f787830</Id>
  5. <Name>qupai-pipeline</Name>
  6. <State>Active</State>
  7. <Speed>Standard</Speed>
  8. <NotifyConfig>
  9. <Topic>mts-topic-1</Topic>
  10. </NotifyConfig>
  11. <Role>AliyunMTSDefaultRole</Role>
  12. </Pipeline>
  13. </UpdatePipelineResponse>

JSON

  1. {
  2. "RequestId":"25818875-5F78-4A13-BEF6-D7393642CA58",
  3. "Pipeline":{
  4. "Id":"31fa3c9ca8134f9cec2b4b0b0f787830",
  5. "Name":"qupai-pipeline",
  6. "State":"Active",
  7. "Speed":"Standard",
  8. "NotifyConfig":{
  9. "Topic":"mts-topic-1"
  10. },
  11. "Role":"AliyunMTSDefaultRole"
  12. }
  13. }
Thank you! We've received your feedback.