ModifyCasterEpisode - ApsaraVideo Live - Alibaba Cloud Documentation Center

Modifies the configurations of an episode in a production studio. You cannot change the episode type.

Operation description

You can call this operation to modify the configurations of an episode in a production studio. You cannot change the episode type.

QPS limit

You can call this operation up to 4 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:ModifyCasterEpisode	update	Domain `acs:live::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
ComponentId	array	No	The components. Components in the production studio are listed from the bottom to the top in an array. When the production studio switches to another video resource, the components are also switched. This parameter takes effect and is required only when the EpisodeType parameter is set to Component. This parameter is optional when the EpisodeType parameter is set to Resource. In this case, if this parameter is specified, the components are bound to and switched together with video resources. Note The variable N specifies the sequence number of the component. For example, ComponentId.1 specifies the ID of the first component and ComponentId.2 specifies the ID of the second component.
	string	No	The ID of the component.	["16A96B9A-F203-4EC5-8E43-CB92E68F****"]
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.	LIVEPRODUCER_POST-cn-0pp1czt****
EpisodeId	string	Yes	The ID of the episode. It is included in the response when you call the AddCasterEpisode operation.	a2b8e671-2fe5-4642-a2ec-bf938623****
EpisodeName	string	No	The name of the episode.	episode_name_1
ResourceId	string	No	The ID of the video resource. It is included in the response when you call the AddCasterVideoResource operation. This parameter takes effect and is required only when the EpisodeType is set to Resource. If the EpisodeType parameter is set to Component, this parameter is invalid.	16A96B9A-F203-4EC5-8E43-CB92E683****
StartTime	string	No	The time when the episode starts. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2016-06-29T09:00:00Z
EndTime	string	No	The time when the episode ends. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2016-06-29T10:20:00Z
SwitchType	string	No	The policy for switching episodes. This parameter takes effect only when the EpisodeType parameter is set to Resource. Valid values: TimeFirst: The episode starts when the preceding episode ends and ends when the next episode starts. If no next episode exists, the episode keeps repeating until a new episode is added or the production studio stops. This parameter must be set to TimeFirst when the video resource is a live stream. ContentFirst: The episode starts and ends as scheduled.	TimeFirst

Response parameters

Parameter	Type	Description	Example
	object
CasterId	string	The ID of the production studio. You can use the ID as a request parameter in the API operation that is used to copy the configurations of a scene, update the configurations of a scene, query the scenes of a production studio, query the audio configurations of a scene, start a scene in the production studio, or stop a scene in the production studio.	LIVEPRODUCER_POST-cn-0pp1czt****
EpisodeId	string	The ID of the episode. You can use the ID as a request parameter in the API operation that is used to delete an episode list from a production studio, add episodes to an episode list, remove episodes from an episode list, query the information about episodes in an episode list, update episodes in an episode list, delete an episode list, query the information about an episode list, start an episode list, or stop an episode list.	a2b8e671-2fe5-4642-a2ec-bf938623****
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Sample success responses

JSONformat

{
  "CasterId": "LIVEPRODUCER_POST-cn-0pp1czt****",
  "EpisodeId": "a2b8e671-2fe5-4642-a2ec-bf938623****",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

Error codes

HTTP status code	Error code	Error message
400	MissingParameter	%s
400	InvalidParameter.Malformed	%s
400	SwitchTypeInvalid.Malformed	%s
400	IncorrectStartTime	%s
400	IncorrectEndTime	%s
400	IncorrectEpisodeStatus	%s
400	EpisodeConflict.Malformed	%s
400	InvalidCasterId.Malformed	%s
401	IllegalOperation	%s
404	InvalidCaster.NotFound	%s
404	InvalidResource.NotFound	%s
404	InvalidEpisode.NotFound	%s
404	InvalidComponent.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