ListMediaConvertJobs-阿里云帮助中心

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

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 of the time range to filter jobs by creation time. The time must be in the `yyyy-MM-ddTHH:mm:ssZ` ISO 8601 format.	2022-07-01T00:00:00Z
EndOfCreateTime	string	No	The end of the time range to filter jobs by creation time. The time must be in the `yyyy-MM-ddTHH:mm:ssZ` ISO 8601 format.	2022-07-15T00:00:00Z
Status	string	No	The status of the job. Valid values: `Inited`: The job has been submitted. `Running`: The job is running. `Complete`: The job is complete. `Error`: The job failed due to an error.	Success
OrderBy	string	No	The sort order for the results. Valid values: `CreateTimeDesc` (descending by creation time) and `CreateTimeAsc` (ascending by creation time).	CreateTimeDesc
PageSize	integer	No	The page size. Valid values: 1 to 100. Default value: 20.	10
NextPageToken	string	No	The token for the next page of results. Leave this empty for the first request. To retrieve the next page, pass the `NextPageToken` value from the previous response.	ab4802364a2e49208c99efab82dfa8e8

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
NextPageToken	string	The token to retrieve the next page of results. This value is empty when there are no more results to return.	**cdb3e74639973036bc84**
Jobs	array	A list of media convert jobs.
	MediaConvertJobWithoutDetail	Job information, excluding the `Detail` field.

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.