All Products
Search
Document Center

ApsaraVideo Live:GetEditingJobInfo

Last Updated:Nov 14, 2024

Queries the information about one or more editing tasks.

Operation description

You can call this operation to query the information about one or more editing tasks by specifying the ID of the production studio or the ID of the episode. Make sure that the parameter settings are valid for calling this operation.

If you set the ShowId parameter in the request, the information about the editing task for the specified episode is returned.

If you do not set the ShowId parameter in the request, the information about the editing tasks for the entire episode list is returned.

Limits on QPS

You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.

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
live:GetEditingJobInfoget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CasterIdstringYes

The ID of the production studio.

  • If the production studio was created by calling the CreateCaster operation, check the value of the response parameter CasterId to obtain the ID of the production studio.
  • If the production studio was created in the ApsaraVideo Live console, obtain the ID of the production studio on the Production Studio Management page. To go to the Production Studio Management page, log on to the ApsaraVideo Live console and click Production Studios in the left-side navigation pane.
Note You can find the created production studio on the Production Studio Management page and view the ID in the Name column.
53200b81-b761-4c10-842a-a0726d97****
ShowIdstringNo

The ID of the episode for which you want to query the editing task.

Note You can obtain the episode ID by checking the value of the response parameter ShowId of the AddShowIntoShowList operation.
72200b81-b761-4c10-842a-a0726d97****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
CasterIdstring

The ID of the production studio.

53200b81-b761-4c10-842a-a0726d97****
EditingTasksInfostring

The information about one or more editing tasks. The following parameters are returned for each editing task:

  • OutputVodId: the ID of the output video-on-demand (VOD) file.
  • TaskStatus: the status of the editing task. Valid values: -1, 0, 1, 2, and 3. A value of -1 indicates that the editing task fails. A value of 0 indicates that the editing task is being initialized. A value of 1 indicates that the episode is being edited. A value of 2 indicates that the output VOD file is being uploaded. A value of 3 indicates that the editing task is successful.
  • StorageLocation: the storage location of ApsaraVideo VOD.
  • FileName: the name of the VOD file that is edited.
  • ShowId: the ID of the episode.
"EditingTasksInfo": { "OutputVodId": "3e34733b40b9a96ccf5c1ff6f69****", "TaskStatus": 1, "StorageInfo": { "StorageLocation": "***bucket***", "FileName": "EditFile****" }, "ShowId": "42200b81-b761-4c10-842a-a0726d97****" },

Examples

Sample success responses

JSONformat

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "CasterId": "53200b81-b761-4c10-842a-a0726d97****",
  "EditingTasksInfo": "\"EditingTasksInfo\": {     \"OutputVodId\": \"3e34733b40b9a96ccf5c1ff6f69****\",     \"TaskStatus\": 1,     \"StorageInfo\": {       \"StorageLocation\": \"***bucket***\",       \"FileName\": \"EditFile****\"     },     \"ShowId\": \"42200b81-b761-4c10-842a-a0726d97****\"   },"
}

Error codes

HTTP status codeError codeError message
400InvalidUserId.Malformed%s
400InvalidParameter.Malformed%s
400InvalidCasterId.Malformed%s
400InvalidVodUrl.Malformed%s
400MissingParameter%s
401IllegalOperation%s
404InvalidShowList.NotFound%s
500InternalError%s

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

Change history

Change timeSummary of changesOperation
No change history