ListMediaProducingJobs - Intelligent Media Services - Alibaba Cloud Documentation Center

Queries a list of media editing and production jobs that meet the specified conditions. You can query the jobs based on the job state and type.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ice:ListMediaProducingJobs	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Status	string	No	The job state. Valid values: Init: The job is initialized. Failed: The job failed. Success: The job is successful. Processing: The job is in progress.	Success
JobType	string	No	The job type. Valid values: LiveEditingJob: live editing job. EditingJob: regular template-based editing job VETemplateJob: advanced template-based editing job.	EditingJob
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2017-01-11T12:00:00Z
EndTime	string	No	The end of the time range to query. The maximum time range between EndTime and StartTime cannot exceed 30 days. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2022-02-02T23:59:59Z
Keyword	string	No	The search keyword. For example, you can use a job ID as the keyword to search for jobs.	**20b48fb04483915d4f2cd8ac**
ProjectId	string	No	The ID of the online editing project.	****927cfb53d05b96c1bfe1****
MasterJobId	string	No	The ID of the quick video production job. If this parameter is specified, the subjobs of the quick video production job are queried.	****8750b54e3c976a47da6f****
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results.	8EqYpQbZ6Eh7+Zz8DxVYoQ==
MaxResults	integer	No	The maximum number of entries to return. Default value: 10. Valid values: 1 to 100.	100
SortBy	string	No	The sorting parameter. By default, the query results are sorted by creation time in descending order. Valid values: CreationTime:Asc: sorted by creation time in ascending order. CreationTime:Desc: sorted by creation time in descending order.	CreationTime:Desc

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	****11-DB8D-4A9A-875B-275798****
MediaProducingJobList	array<object>	The queried media editing and production jobs.
MediaProducingJob	object	The queried media editing and production job.
JobId	string	The ID of the online editing job.	****8750b54e3c976a47da6f****
ProjectId	string	The ID of the online editing project.	****faa3b542f5a6135217e3****
MediaId	string	The media asset ID of the output file.	0ce4ea70f52471edab61f7e7d6786302
MediaURL	string	The URL of the output file.	http://your-bucket.oss-cn-shanghai.aliyuncs.com/your-video.mp4
TemplateId	string	The ID of the online editing template.	cb786a39c5d44cecb23d8c864facffc1
ClipsParam	string	The template material parameters.	{"Text1":"text","Text0":"text","Media1":"mediaId","Media0":"mediaId"}
Duration	float	The duration of the output file. Unit: seconds.	15.5
CreateTime	string	The time when the job was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-03-21T16:40:00Z
CompleteTime	string	The time when the job was complete. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2022-03-21T16:40:30Z
ModifiedTime	string	The time when the job was last modified.	2022-03-21T16:41:00Z
Status	string	The job state.	Sucess
Code	string	The response code.	Success
Message	string	The returned message. Note: Pay attention to this parameter if the job failed.	The resource operated InputFile is bad
UserData	string	The user-defined data in the JSON format.	{"key":"value"}
MaxResults	string	The maximum number of entries returned. Default value: 10. Valid values: 1 to 100.	100
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	8EqYpQbZ6Eh7+Zz8DxVYoQ==

Examples

Sample success responses

JSONformat

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "MediaProducingJobList": [
    {
      "JobId": "******8750b54e3c976a47da6f******",
      "ProjectId": "******faa3b542f5a6135217e3******",
      "MediaId": "0ce4ea70f52471edab61f7e7d6786302",
      "MediaURL": "http://your-bucket.oss-cn-shanghai.aliyuncs.com/your-video.mp4",
      "TemplateId": "cb786a39c5d44cecb23d8c864facffc1",
      "ClipsParam": "{\"Text1\":\"text\",\"Text0\":\"text\",\"Media1\":\"mediaId\",\"Media0\":\"mediaId\"}",
      "Duration": 15.5,
      "CreateTime": "2022-03-21T16:40:00Z",
      "CompleteTime": "2022-03-21T16:40:30Z",
      "ModifiedTime": "2022-03-21T16:41:00Z",
      "Status": "Sucess",
      "Code": "Success",
      "Message": "The resource operated InputFile is bad",
      "UserData": "{\"key\":\"value\"}"
    }
  ],
  "MaxResults": "100",
  "NextToken": "8EqYpQbZ6Eh7+Zz8DxVYoQ=="
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-08-14	The request parameters of the API has changed	View Change Details