Retrieve Editing Job Details with GetEditingJobInfo - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Operation description

This operation allows you to query information about a video clip task for a specified CasterId and ShowId. Make sure that the parameters are set correctly when you call this operation.
If you specify the ShowId request parameter, the response returns the video clip task information for the specified show in the playlist.
If you do not specify the ShowId request parameter, the response returns the video clip task information for the entire playlist.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If this limit is exceeded, the API call is throttled, which may affect your business. Call this operation appropriately.

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

live:GetEditingJobInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
CasterId	string	Yes	The production studio ID. If you created the production studio by calling the CreateCaster operation, check the CasterId parameter in the response. If you created the production studio in the ApsaraVideo Live console, navigate to ApsaraVideo Live console > Production Studios > Cloud Production Studio to view the ID. Note The name of the production studio in the production studio list on the Cloud Production Studio page is the production studio ID. CasterId must be a production studio with NormType=6 (playlist mode). Using a production studio with other NormType values (such as 1 or 3) returns InvalidShowList.NotFound. You can filter by NormType=6 in the DescribeCasters response.	53200b81-b761-4c10-842a-a0726d97****
ShowId	string	No	The ID of the show to query. Note You can obtain the ShowId value from the response of the AddShowIntoShowList operation.	72200b81-b761-4c10-842a-a0726d97****

Response elements

Element	Type	Description	Example
	object
CasterId	string	The production studio ID.	53200b81-b761-4c10-842a-a0726d97****
EditingTasksInfo	string	The video clip task information. This includes: OutputVodId: The ID of the output video-on-demand file. TaskStatus: The status of the video clip task. (-1: failed. 0: task initialized. 1: clipping in progress. 2: uploading. 3: task succeeded.) StorageLocation: The video-on-demand storage address. FileName: The name of the clipped file. ShowId: The show ID.	"EditingTasksInfo": { "OutputVodId": "3e34733b40b9a96ccf5c1ff6f69**", "TaskStatus": 1, "StorageInfo": { "StorageLocation": "bucket", "FileName": "EditFile" }, "ShowId": "42200b81-b761-4c10-842a-a0726d97**" },
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidUserId.Malformed	%s, please check userId.	The userId passed in is invalid, please check.
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
400	InvalidCasterId.Malformed	%s, please check and try again later.	The parameter CasterId is invalid, please check and try again.
400	InvalidVodUrl.Malformed	%s, please check and try again later.	Parameter VodUrl is invalid, please check and try again.
400	MissingParameter	%s.	Missing parameter
401	IllegalOperation	%s, please check and try again later.	Operation not allowed, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
404	InvalidCaster.NotFound	%s, please check and try again later.	The guide station does not exist, please check and try again.
404	InvalidShowList.NotFound	%s, please check and try again later.	ShowList does not exist, please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.