EditShowAndReplace - ApsaraVideo Live - Alibaba Cloud Documentation Center

Creates an editing task.

Operation description

You can call this operation to create an editing task by specifying the production studio ID and the episode ID. You will not receive a notification after the editing task is created. You can call the GetEditingJobInfo operation to query the status of the editing task.

QPS limit

You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

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
live:EditShowAndReplace	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
CasterId	string	Yes	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. If the production studio was created by using the ApsaraVideo Live console, obtain the ID on the Production Studio Management page. To go to the page, log on to the ApsaraVideo Live console and click Production Studios in the left-side navigation pane. Note You can find the ID of the production studio in the Instance ID/Name column.	53200b81-b761-4c10-842a-a0726d97****
ShowId	string	Yes	The ID of the episode to be edited. Note You can obtain the ID from the response parameter ShowId of the AddShowIntoShowList operation.	42200b81-b761-4c10-842a-a0726d97****
UserData	string	No	The user information.	900a2b2r8-13c2-****-88f2-75e4a07c1ed9
StorageInfo	string	No	The storage information of the episode. The following fields are included: StorageLocation: the storage location of ApsaraVideo VOD. FileName: the custom file name. Note Editing outputs must be stored in the VOD bucket within the same account that is used to access both ApsaraVideo VOD and ApsaraVideo Live. For more information about how to obtain the storage location, see Manage VOD resources.	{ "StorageLocation":"*bucket", "FileName":"EditFile***.mp4" }
StartTime	float	No	The start time of the editing task. Unit: seconds. Note The valid values range from 0 to the value indicated by the total length of the episode. By default, the editing task starts from the beginning of the episode. Default value: 0.0. If you want to edit a VOD file from the 2nd second to the 5th second, set the StartTime parameter to 2.0 and the EndTime parameter to 5.0.	2.0
EndTime	float	No	The end time of the editing task. Unit: seconds. Note The valid values range from 0 to the value indicated by the total length of the episode. By default, this parameter is set to the value that indicates the total length of the episode. The editing period cannot exceed the total length of the episode. If you want to edit a VOD file from the 2nd second to the 5th second, set the StartTime parameter to 2.0 and the EndTime parameter to 5.0.	5.0

Response parameters

Parameter	Type	Description	Example
	object
JobInfo	string	The information about the editing task. The following fields are included: vodId: the ID of the VOD file. mediaid: the ID of the media file. jobId: the ID of the editing task.	{ "vodId": "3e34733b40b9a96ccf5c1ff6f69**", "mediaid": "eb1861d2c9a842340e989dd56", "jobId": "7d2fbc380b0e08e55fe98733764**" }
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Sample success responses

JSONformat

{
  "JobInfo": "{         \"vodId\": \"3e34733b40b9a96ccf5c1ff6f69****\",         \"mediaid\": \"eb1861d2c9a842340e989dd56****\",         \"jobId\": \"7d2fbc380b0e08e55fe98733764****\"     }",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidUserId.Malformed	%s
400	InvalidParameter.Malformed	%s
400	InvalidCasterId.Malformed	%s
400	InvalidVodUrl.Malformed	%s
400	MissingParameter	%s
401	IllegalOperation	%s
403	RequestForbiddenForIce	%s
404	InvalidCaster.NotFound	%s
404	InvalidShowList.NotFound	%s
500	InternalError	%s

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

Change history

Change time	Summary of changes	Operation

No change history