UpdatePipeline - ApsaraVideo Media Processing

Updates an ApsaraVideo Media Processing (MPS) queue.

Operation description

You can call this operation to modify the name, status, and notification settings of the specified MPS queue.
If a paused MPS queue is selected in a workflow or a job, such as a video review or media fingerprint job, the workflow or job fails.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mts:UpdatePipeline	update	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
PipelineId	string	Yes	The ID of the MPS queue that you want to update. To view the MPS queue ID, log on to the MPS console and choose Global Settings > Pipelines in the left-side navigation pane.	d1ce4d3efcb549419193f50f1fcd****
Name	string	Yes	The new name of the MPS queue. The value can contain letters, digits, and special characters such as hyphens (-) and can be up to 128 bytes in size. The value cannot start with a special character.	example-pipeline-****
State	string	Yes	The new state of the MPS queue. Active: The MPS queue is active. Jobs in the MPS queue can be scheduled and run by MPS. Paused: The MPS queue is paused. Jobs in the MPS queue cannot be scheduled or run by MPS, and all jobs remain in the Submitted state. Jobs that are running will not be affected.	Paused
NotifyConfig	string	No	The Message Service (MNS) configuration, such as the information about the MNS queue or topic. For more information, see the "NotifyConfig" section of the Parameter details topic.	{"Topic":"example-topic-****"}
Role	string	No	The role that is assigned to the current RAM user. To obtain the role, you can log on to the Resource Access Management (RAM) console and choose Identities > Roles in the left-side navigation pane.	AliyunMTSDefaultRole

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	1FE0F96B-544D-4244-9D83-DFCFB0E5A231
Pipeline	object	The details of the MPS queue.
Speed	string	The type of the MPS queue. Default value: Standard. Valid values: Boost: MPS queue with transcoding speed boosted Standard: standard MPS queue NarrowBandHDV2: MPS queue that supports Narrowband HD 2.0 AIVideoCover: MPS queue for intelligent snapshot capture AIVideoFPShot: MPS queue for media fingerprinting AIVideoCensor: MPS queue for automated review AIVideoMCU: MPS queue for smart tagging AIVideoSummary: MPS queue for video synopsis AIVideoPorn: MPS queue for pornography detection in videos AIAudioKWS: MPS queue for keyword recognition in audio AIAudioASR: MPS queue for speech-to-text conversion	Standard
State	string	The state of the MPS queue. Valid values: Active: The MPS queue is active. Paused: The MPS queue is paused.	Paused
NotifyConfig	object	The MNS configuration.
MqTopic	string	The queue of messages that are received.	example1,example2
QueueName	string	The queue that is created in MNS.	example-queue-****
MqTag	string	The tags of the messages.	mts-test
Topic	string	The topic that is created in MNS.	example-topic-****
Name	string	The new name of the MPS queue.	example-pipeline-****
Role	string	The role that is assigned to the current RAM user.	AliyunMTSExampleRole
Id	string	The ID of the MPS queue.	d1ce4d3efcb549419193f50f1fcd****
QuotaAllocate	long	The quota that is allocated to the MPS queue.	10

Examples

Sample success responses

JSONformat

{
  "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": ""
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-06-13	The response structure of the API has changed	View Change Details