All Products
Search
Document Center

ApsaraVideo Media Processing:AddPipeline

Last Updated:Sep 27, 2024

Adds an ApsaraVideo Media Processing (MPS) queue.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
mts:AddPipelinecreate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NamestringYes

The name of the MPS queue. The name can be up to 128 bytes in size.

test-pipeline
SpeedstringNo

The type of the MPS queue. 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.
  • AIVideoTag: MPS queue for video tagging. The supported regions are China (Shanghai), China (Beijing), and China (Hangzhou).

Default value: Standard.

Standard
SpeedLevellongNo

The level of the MPS queue. Valid values: 1 to 3.

1
NotifyConfigstringNo

The Message Service (MNS) configuration.

{"Topic":"mts-topic-1"}
RolestringNo

The role.

AliyunMTSDefaultRole

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

CFEA608A-5A1C-4C83-A54B-6197BC250D23
Pipelineobject

The MPS queue.

Speedstring

The type of the MPS queue.

Standard
Statestring

The state of the MPS queue.

  • Active: The MPS queue is active. The jobs in the MPS queue are scheduled and transcoded by MPS.
  • Paused: The MPS queue is paused. Jobs in the MPS queue are no longer scheduled for transcoding by MPS. All of the jobs in the MPS queue remain in the Submitted state. Jobs that are being transcoded are not affected.
Active
SpeedLevellong

The level of the MPS queue.

1
NotifyConfigobject

The MNS configuration.

MqTopicstring

The queue of messages that are received.

example1
QueueNamestring

The name of the queue.

mts-queue-1
MqTagstring

The tag string.

mts-test
Topicstring

The name of the topic.

mts-topic-1
Rolestring

The role.

AliyunMTSDefaultRole
Namestring

The name of the MPS queue.

Media Fingerprint
Idstring

The ID of the MPS queue.

ed450ea0bfbd41e29f80a401fb4d****
QuotaAllocatelong

The quota that is allocated to the MPS queue.

10

Examples

Sample success responses

JSONformat

{
  "RequestId": "CFEA608A-5A1C-4C83-A54B-6197BC250D23",
  "Pipeline": {
    "Speed": "Standard",
    "State": "Active",
    "SpeedLevel": 1,
    "NotifyConfig": {
      "MqTopic": "example1",
      "QueueName": "mts-queue-1",
      "MqTag": "mts-test",
      "Topic": "mts-topic-1"
    },
    "Role": "AliyunMTSDefaultRole",
    "Name": "Media Fingerprint\n",
    "Id": "ed450ea0bfbd41e29f80a401fb4d****",
    "QuotaAllocate": 10,
    "ExtendConfig": {
      "IsBoostNew": true,
      "MaxMultiSpeed": 0,
      "MultiSpeedDowngradePolicy": ""
    }
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-09-21The response structure of the API has changedView Change Details
2023-09-21The request parameters of the API has changedView Change Details