All Products
Search
Document Center

ApsaraVideo Media Processing:QueryMediaWorkflowList

Last Updated:Sep 27, 2024

Queries registered media workflows.

Operation description

You can call this operation to query up to 10 media workflows at a time.

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.

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:QueryMediaWorkflowListget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
MediaWorkflowIdsstringYes

The IDs of the media workflows that you want to query. To obtain the IDs of the media workflows, you can log on to the ApsaraVideo Media Processing (MPS) console and choose Workflows > Workflow Settings in the left-side navigation pane. You can query up to 10 media workflows at a time. Separate multiple IDs of media workflows with commas (,).

93ab850b4f6f44eab54b6e9181d4****,72dfa5e679ab4be9a3ed9974c736****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

NonExistMediaWorkflowIdsarray

The workflows that do not exist.

MediaWorkflowIdstring

The IDs of the media workflows that do not exist. This parameter is not returned if all specified media workflows are found.

72dfa5e679ab4be9a3ed9974c736****
MediaWorkflowListarray<object>

The media workflows.

MediaWorkflowobject

The detailed information about the media workflow.

CreationTimestring

The time when the media workflow was created.

2016-04-01T05:29:38Z
MediaWorkflowIdstring

The ID of the media workflow.

93ab850b4f6f44eab54b6e9181d4****
Statestring

The state of the media workflow. Valid values:

  • Inactive: The media workflow was deactivated.
  • Active: The media workflow was activated.
  • Deleted: The media workflow was deleted.
Active
TriggerModestring

The trigger mode of the media workflow. Valid values:

  • OssAutoTrigger: The media workflow is automatically triggered.
  • NotInAuto: The media workflow is not automatically triggered.
OssAutoTrigger
Namestring

The name of the media workflow.

example-mediaworkflow-****
Topologystring

The topology of the media workflow.

{mediaworkflow","State":"Active","Topology":"{\"Activities\":{\"Act-Start\":{\"Parameters\":{\"PipelineId\":\"130266f58161436a80bf07cb12c8****\",\"InputFile\":\"{\\\"Bucket\\\": \\\"example-bucket-****\\\",\\\"Location\\\": \\\"cn-shanghai\\\"}\"},\"Type\":\"Start\"},\"Act-Report\":{\"Parameters\":{},\"Type\":\"Report\"},\"Act-Transcode-M3U8\":{\"Parameters\":{\"Outputs\":\"[{\\\"Object\\\":\\\"transcode/{ObjectPrefix}{FileName}\\\",\\\"TemplateId\\\": \\\"957d1719ee85ed6527b90cf62726****\\\"}]\",\"OutputBucket\":\"example-bucket-****\",\"OutputLocation\":\"cn-shanghai\"},\"Type\":\"Transcode\"}},\"Dependencies\":{\"Act-Start\":[\"Act-Transcode-M3U8\"],\"Act-Report\":[],\"Act-Transcode-M3U8\":[\"Act-Report\"]}}","MediaWorkflowId":"93ab850b4f6f44eab54b6e91d24d****"}]},"RequestId":"16CD0CDD-457E-420D-9755-8385075A1234"}
RequestIdstring

The ID of the request.

16CD0CDD-457E-420D-1234-8385075A618B

Examples

Sample success responses

JSONformat

{
  "NonExistMediaWorkflowIds": {
    "MediaWorkflowId": [
      "72dfa5e679ab4be9a3ed9974c736****"
    ]
  },
  "MediaWorkflowList": {
    "MediaWorkflow": [
      {
        "CreationTime": "2016-04-01T05:29:38Z",
        "MediaWorkflowId": "93ab850b4f6f44eab54b6e9181d4****",
        "State": "Active",
        "TriggerMode": "OssAutoTrigger",
        "Name": "example-mediaworkflow-****",
        "Topology": "{mediaworkflow\",\"State\":\"Active\",\"Topology\":\"{\\\"Activities\\\":{\\\"Act-Start\\\":{\\\"Parameters\\\":{\\\"PipelineId\\\":\\\"130266f58161436a80bf07cb12c8****\\\",\\\"InputFile\\\":\\\"{\\\\\\\"Bucket\\\\\\\": \\\\\\\"example-bucket-****\\\\\\\",\\\\\\\"Location\\\\\\\": \\\\\\\"cn-shanghai\\\\\\\"}\\\"},\\\"Type\\\":\\\"Start\\\"},\\\"Act-Report\\\":{\\\"Parameters\\\":{},\\\"Type\\\":\\\"Report\\\"},\\\"Act-Transcode-M3U8\\\":{\\\"Parameters\\\":{\\\"Outputs\\\":\\\"[{\\\\\\\"Object\\\\\\\":\\\\\\\"transcode/{ObjectPrefix}{FileName}\\\\\\\",\\\\\\\"TemplateId\\\\\\\": \\\\\\\"957d1719ee85ed6527b90cf62726****\\\\\\\"}]\\\",\\\"OutputBucket\\\":\\\"example-bucket-****\\\",\\\"OutputLocation\\\":\\\"cn-shanghai\\\"},\\\"Type\\\":\\\"Transcode\\\"}},\\\"Dependencies\\\":{\\\"Act-Start\\\":[\\\"Act-Transcode-M3U8\\\"],\\\"Act-Report\\\":[],\\\"Act-Transcode-M3U8\\\":[\\\"Act-Report\\\"]}}\",\"MediaWorkflowId\":\"93ab850b4f6f44eab54b6e91d24d****\"}]},\"RequestId\":\"16CD0CDD-457E-420D-9755-8385075A1234\"}"
      }
    ]
  },
  "RequestId": "16CD0CDD-457E-420D-1234-8385075A618B"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history