ListMediaConvertJobs

Updated at:

Queries a list of media conversion jobs.

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

ice:ListMediaConvertJobs

none

*All Resource

*

None None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

JobId

string

No

Filters the results by job ID.

88c6ca184c0e47098a5b665e2****

StartOfCreateTime

string

No

The start time of the creation time filter. Format: yyyy-MM-ddTHH:mm:ssZ.

2022-07-01T00:00:00Z

EndOfCreateTime

string

No

The end time of the creation time filter. Format: yyyy-MM-ddTHH:mm:ssZ.

2022-07-15T00:00:00Z

Status

string

No

The job status. Valid values:

  • Inited: Submitted.

  • Running: Running.

  • Complete: Completed.

  • Error: Error.

Success

OrderBy

string

No

The sort order. Valid values:

  • CreateTimeDesc: Descending order by creation time.

  • CreateTimeAsc: Ascending order by creation time.

CreateTimeDesc

PageSize

integer

No

The number of entries per page. Valid values: 0 to 100. Default value: 20.

10

NextPageToken

string

No

The paging token for the next page in a continuous paged query (not present for the first page).

ab4802364a2e49208c99efab82dfa8e8

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

Id of the request

******11-DB8D-4A9A-875B-275798******

NextPageToken

string

The read position returned by the current call. An empty value indicates that all data has been read.

****cdb3e74639973036bc84****

Jobs

array

The list of jobs.

MediaConvertJobWithoutDetail

The job information, excluding details.

Examples

Success response

JSON format

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "NextPageToken": "****cdb3e74639973036bc84****\n",
  "Jobs": [
    {
      "RequestId": "******11-DB8D-4A9A-875B-275798******",
      "ClientToken": "****12e8864746a0a398****",
      "JobId": "****d80e4e4044975745c14b****",
      "Config": {
        "Inputs": [
          {
            "Name": "InputVideo",
            "InputFile": {
              "Type": "OSS",
              "Media": "http://bucket.loction.aliyuncs.com/path/to/video.mp4"
            }
          }
        ],
        "Outputs": [
          {
            "Name": "output-video",
            "OutputFile": {
              "Type": "OSS",
              "Media": "http://bucket.loction.aliyuncs.com/path/to/video.mp4"
            },
            "TemplateId": "****96e8864746a0b6f3****",
            "Priority": 6,
            "Features": "{}",
            "OverrideParams": "{}"
          }
        ],
        "OutputGroups": [
          {
            "Name": "hls-group",
            "GroupConfig": {
              "ManifestName": "manifest",
              "Type": "Hls",
              "OutputFileBase": {
                "Type": "OSS",
                "Media": "http://bucket.loction.aliyuncs.com/path/to/video.mp4"
              }
            },
            "Outputs": [
              {
                "Name": "group-output",
                "OutputFileName": "720p.mp4",
                "TemplateId": "****96e8864746a0b6f3****\n",
                "Priority": 6,
                "Features": "{}",
                "OverrideParams": "{}"
              }
            ]
          }
        ],
        "JobName": "Name"
      },
      "PipelineId": "688c2a8bfa4e44ddbba0c8730db91b0c",
      "UserData": "{\"info\": \"xxx\"}",
      "Code": "InvalidParameter.ResourceNotFound",
      "Message": "The resource operated \"%s\" cannot be found",
      "State": "Inited",
      "CreateTime": "2024-12-07T13:01:07Z\n",
      "FinishTime": "2024-12-07T13:01:07Z"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.