Queries the information about one or more editing tasks.

Usage notes

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetEditingJobInfo

The operation that you want to perform. Set the value to GetEditingJobInfo.

CasterId String Yes 53200b81-b761-4c10-842a-a0726d97****

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.
ShowId String No 72200b81-b761-4c10-842a-a0726d97****

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.

Response parameters

Parameter Type Example Description
CasterId String 53200b81-b761-4c10-842a-a0726d97****

The ID of the production studio.

EditingTasksInfo String "EditingTasksInfo": { "OutputVodId": "3e34733b40b9a96ccf5c1ff6f69****", "TaskStatus": 1, "StorageInfo": { "StorageLocation": "***bucket***", "FileName": "EditFile****" }, "ShowId": "42200b81-b761-4c10-842a-a0726d97****" },

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.
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=GetEditingJobInfo
&CasterId=53200b81-b761-4c10-842a-a0726d97****
&<Common request parameters>

Sample success responses

XML format 

<GetEditingJobInfoResponse>
  <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
  <EditingTasksInfo>
        <OutputVodId>3e34733b40b9a96ccf5c1ff6f69****</OutputVodId>
        <TaskStatus>1</TaskStatus>
        <StorageInfo>
              <StorageLocation>***bucket***</StorageLocation>
              <FileName>EditFile****</FileName>
        </StorageInfo>
        <ShowId>42200b81-b761-4c10-842a-a0726d97****</ShowId>
  </EditingTasksInfo>
  <CasterId>53200b81-b761-4c10-842a-a0726d97****</CasterId>
</GetEditingJobInfoResponse>

JSON format 

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

Error codes

For a list of error codes, visit the API Error Center.