Use EditShowAndReplace to Add Video Editing Jobs - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Adds a video clip task.

Operation description

This operation allows you to add a video clip task by specifying CasterId and ShowId. After a video clip task is added, no automatic notification is sent. You can call the GetEditingJobInfo operation to query the task status.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If this limit is exceeded, the API calls are 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:EditShowAndReplace

none

*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, go to ApsaraVideo Live console > Production Studios > Cloud Production Studio to view the ID. Note The production studio name in the production studio list on the Cloud Production Studio page is the production studio ID.	53200b81-b761-4c10-842a-a0726d97****
ShowId	string	Yes	The ID of the show to be clipped. The referenced show must be of the video-on-demand material type (ResourceInfo.ResourceType=vod with a valid resourceId). Note Obtain the ShowId value from the response parameters 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. This parameter is required. Description: StorageLocation: the video-on-demand storage address of the user. FileName: the custom file name. Note The video clip storage address must be a video-on-demand storage address under the same account. To obtain the video-on-demand storage address, see Storage management.	{ "StorageLocation":"*bucket", "FileName":"EditFile***.mp4" }
StartTime	number	No	The start time of the video clip. Unit: seconds. Note The valid range of the clip time is 0 to the total duration of the show. - By default, the clip starts from the beginning of the video-on-demand file. Value: 0.0. For example, to clip a video-on-demand file from the 2nd second to the 5th second, set StartTime to 2.0 and EndTime to 5.0. You must specify at least one of StartTime and EndTime.	2.0
EndTime	number	No	The end time of the video clip. Unit: seconds. Note The valid range of the clip time is 0 to the total duration of the show. The default value is the end time of the video-on-demand file. The value cannot exceed the total duration of the show. For example, to clip a video-on-demand file from the 2nd second to the 5th second, set StartTime to 2.0 and EndTime to 5.0. You must specify at least one of StartTime and EndTime.	5.0

Response elements

Element	Type	Description	Example
	object
JobInfo	string	The task information, which contains: vodId: the video-on-demand file ID. mediaid: the media file ID. jobId: the task ID.	{ "vodId": "3e34733b40b9a96ccf5c1ff6f69**", "mediaid": "eb1861d2c9a842340e989dd56", "jobId": "7d2fbc380b0e08e55fe98733764**" }
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Success response

JSON format

{
  "JobInfo": "{         \"vodId\": \"3e34733b40b9a96ccf5c1ff6f69****\",         \"mediaid\": \"eb1861d2c9a842340e989dd56****\",         \"jobId\": \"7d2fbc380b0e08e55fe98733764****\"     }",
  "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.
403	RequestForbiddenForIce	%s, 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.