Update an MPS queue by using UpdatePipeline - ApsaraVideo Media Processing - Alibaba Cloud - ApsaraVideo Media Processing

Update an MPS queue.

Operation description

This API allows you to modify the name, status, and notification settings of a specified MPS queue.
If an MPS queue is paused, any pipeline or individual job (such as automated review or media fingerprint) that uses this paused queue will fail and cannot proceed.

Queries per second (QPS) limit

The QPS limit for this API is 100 requests per second per user. If this limit is exceeded, API calls will be rate-limited, which may impact your business operations. Please invoke the API appropriately. For more information, see QPS limits.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mts:UpdatePipeline

update

*All Resource

*

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
ExtendConfig	string	No	Extension configuration	{\"IsBoostNew\":true,\"MultiSpeedDowngradePolicy\":\"NormalSpeed\",\"MaxMultiSpeed\":20}

Response elements

Element	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	integer	The quota that is allocated to the MPS queue.	10

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.