EditShowAndReplace - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

This operation adds a video editing job. You must specify a CasterId and a ShowId. You will not be notified when the video editing job is successfully added. To query the job status, call the GetEditingJobInfo operation.

QPS limit

The queries per second (QPS) limit for a single user is 10 calls per second. If you exceed this limit, API calls are throttled, which can affect your business. We recommend that you call this operation at a reasonable rate.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
CasterId	string	Yes	The ID of the production studio. If you create a production studio by calling the CreateCaster operation, use the CasterId value that is returned in the response. If you create a production studio in the ApsaraVideo Live console, go to the Production Studio > Cloud Production Studio page to view the ID. Note The name of a production studio in the list on the Cloud Production Studio page is its ID.	53200b81-b761-4c10-842a-a0726d97****
ShowId	string	Yes	The ID of the show that you want to edit. 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. Description: StorageLocation: The storage address for the video-on-demand (VOD) file. FileName: The custom file name. Note The storage address for the edited video must be a VOD storage address that is under the same account. To obtain a VOD storage address, see Storage management.	{ "StorageLocation":"*bucket", "FileName":"EditFile***.mp4" }
StartTime	number	No	The start time of the clip. Unit: seconds. Note The value must be between 0 and the total duration of the show. The default value is 0.0. This means the clip starts from the beginning of the VOD file. For example, to clip a VOD file from the 2-second mark to the 5-second mark, set StartTime to 2.0 and EndTime to 5.0.	2.0
EndTime	number	No	The end time of the clip. Unit: seconds. Note The value must be between 0 and the total duration of the show. By default, the clip ends at the end of the VOD file. The value cannot exceed the total duration of the show. For example, to clip a VOD file from the 2-second mark to the 5-second mark, set StartTime to 2.0 and EndTime to 5.0.	5.0

Response parameters

Parameter	Type	Description	Example
	object
JobInfo	string	The information about the job. It includes the following parameters: vodId: The ID of the VOD file. mediaid: The ID of the media file. jobId: The ID of the job.	{ "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
400	InvalidUserId.Malformed	%s
400	InvalidParameter.Malformed	%s
400	InvalidCasterId.Malformed	%s
400	InvalidVodUrl.Malformed	%s
400	MissingParameter	%s
401	IllegalOperation	%s
500	InternalError	%s
403	RequestForbiddenForIce	%s
404	InvalidCaster.NotFound	%s
404	InvalidShowList.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.