All Products
Search
Document Center

Intelligent Media Services:GetBatchMediaProducingJob

Last Updated:Dec 16, 2024

Queries the information about a quick video production job, including the input parameters, job state, and the IDs and URLs of the output media assets. You can call this operation to query only quick video production jobs created within the past year.

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.

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
ice:GetBatchMediaProducingJobget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdstringNo

The ID of the quick video production job.

****b4549d46c88681030f6e****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

****36-3C1E-4417-BDB2-1E034F****
EditingBatchJobobject

The information about the quick video production job.

JobIdstring

The job ID.

****b6b2750d4308892ac3330238****
InputConfigstring

The input configurations. For more information, see InputConfig .

EditingConfigstring

The editing configurations. For more information, see EditingConfig .

{ "MediaConfig": { "Volume": 0 }, "SpeechConfig": { "Volume": 1 }, "BackgroundMusicConfig": { "Volume": 0.3 } }
OutputConfigstring

The output configurations. For more information, see OutputConfig .

{ "MediaURL": "http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4", "Count": 20, "MaxDuration": 15, "Width": 1080, "Height": 1920, "Video": {"Crf": 27} }
Statusstring

The job state. Valid values:

Init: The job is initialized.

Processing: The job is in progress.

Finished: The job is complete.

Finished
UserDatastring

The user-defined data, including the business and callback configurations. For more information, see UserData .

{"NotifyAddress":"http://xx.xx.xxx"}
Extendstring

The extended information. This parameter contains the following fields:

ErrorCode: the error code of the main job.

ErrorMessage: the error message of the main job.

{ "ErrorCode": "InvalidMaterial.NotFound", "ErrorMessage": "The specified clips id not found:[\"****30d0b5e871eebb2ff7f6c75a****\"]" }
CreateTimestring

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.

2024-06-13T08:47:07Z
ModifiedTimestring

The time when the job was last modified.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2024-06-13T08:57:07Z
CompleteTimestring

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.

2024-06-13T08:57:07Z
SubJobListarray<object>

The quick video production subjobs.

SubJobListobject

The information about the quick video production subjob.

MediaIdstring

The ID of the output media asset.

****1470b11171ee9d19e7e6c66a****
JobIdstring

The subjob ID.

****8e81933d44e3ae69e2f81485****
MediaURLstring

The URL of the output file.

http:/xxx.oss-cn-shanghai.aliyuncs.com/xxx_0.mp4
Statusstring

The subjob state. Valid values:

Init: The subjob is initialized.

Processing: The subjob is in progress.

Success: The subjob is successful.

Failed: The subjob failed.

Success
ErrorCodestring

The error code that is returned if the subjob failed. This parameter is not returned if the subjob is successful.

InvalidMaterial.NotFound
ErrorMessagestring

The error message that is returned if the subjob failed. This parameter is not returned if the subjob is successful.

The specified clips id not found:["****30d0b5e871eebb2ff7f6c75a****"]
ProjectIdstring

The ID of the online editing project.

****7cc47fe04eaa81bd853acb6a****

Examples

Sample success responses

JSONformat

{
  "RequestId": "****36-3C1E-4417-BDB2-1E034F****",
  "EditingBatchJob": {
    "JobId": "****b6b2750d4308892ac3330238****",
    "InputConfig": "",
    "EditingConfig": "{\n  \"MediaConfig\": {\n      \"Volume\": 0\n  },\n  \"SpeechConfig\": {\n      \"Volume\": 1\n  },\n \"BackgroundMusicConfig\": {\n      \"Volume\": 0.3\n  }\n}",
    "OutputConfig": "{\n  \"MediaURL\": \"http://xxx.oss-cn-shanghai.aliyuncs.com/xxx_{index}.mp4\",\n  \"Count\": 20,\n  \"MaxDuration\": 15,\n  \"Width\": 1080,\n  \"Height\": 1920,\n  \"Video\": {\"Crf\": 27}\n}",
    "Status": "Finished",
    "UserData": "{\"NotifyAddress\":\"http://xx.xx.xxx\"}",
    "Extend": "{\n\t\"ErrorCode\": \"InvalidMaterial.NotFound\",\n\t\"ErrorMessage\": \"The specified clips id not found:[\\\"****30d0b5e871eebb2ff7f6c75a****\\\"]\"\n}",
    "CreateTime": "2024-06-13T08:47:07Z",
    "ModifiedTime": "2024-06-13T08:57:07Z\n",
    "CompleteTime": "2024-06-13T08:57:07Z\n",
    "JobType": "",
    "SubJobList": [
      {
        "MediaId": "****1470b11171ee9d19e7e6c66a****",
        "JobId": "****8e81933d44e3ae69e2f81485****",
        "MediaURL": "http:/xxx.oss-cn-shanghai.aliyuncs.com/xxx_0.mp4",
        "Status": "Success",
        "ErrorCode": "InvalidMaterial.NotFound",
        "ErrorMessage": "The specified clips id not found:[\"****30d0b5e871eebb2ff7f6c75a****\"]",
        "ProjectId": "****7cc47fe04eaa81bd853acb6a****"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-07-22The response structure of the API has changedView Change Details
2024-07-03The request parameters of the API has changedView Change Details
2024-04-28The response structure of the API has changedView Change Details