ModifyCasterEpisode - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

You can call this operation to modify the configuration of a production studio episode. The episode type cannot be modified.

QPS limit

The queries per second (QPS) limit for a single user is 4 calls per second. If this limit is exceeded, API calls are throttled. This may affect your business. We recommend that you call this API 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:ModifyCasterEpisode

update

*Domain

acs:live:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-shanghai
ComponentId	array	No	The IDs of the components. The components are arranged from bottom to top and are switched in sync with the video source. This parameter is required and takes effect only if EpisodeType is set to Component. If EpisodeType is set to Resource, this parameter specifies the components that are attached to the video source and switched in sync. Note N specifies the Nth component ID. For example, ComponentId.1 specifies the first component ID and ComponentId.2 specifies the second component ID.	["16A96B9A-F203-4EC5-8E43-CB92E68F****"]
	string	No	A list of components.	["16A96B9A-F203-4EC5-8E43-CB92E68F****"]
CasterId	string	Yes	The ID of the production studio. If you created the production studio by calling the CreateCaster operation, use the CasterId value that is returned in the response. If you created the production studio in the LIVE console, find the ID on the Cloud Production Studio page. To go to the page, choose LIVE Console > Production Studio > Cloud Production Studio. Note The name of a production studio in the list on the Cloud Production Studio page is the production studio ID.	LIVEPRODUCER_POST-cn-0pp1czt****
EpisodeId	string	Yes	The ID of the episode.	a2b8e671-2fe5-4642-a2ec-bf938623****
EpisodeName	string	No	The name of the episode.	episode_name_1
ResourceId	string	No	The ID of the video source. This parameter is required and takes effect only if EpisodeType is set to Resource. This parameter is not available if EpisodeType is set to Component.	16A96B9A-F203-4EC5-8E43-CB92E683****
StartTime	string	No	The start time. The time must be in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.	2016-06-29T09:00:00Z
EndTime	string	No	The end time. The time must be in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.	2016-06-29T10:20:00Z
SwitchType	string	No	The switch policy. This parameter takes effect only if EpisodeType is set to Resource. TimeFirst: time-priority. This is the only policy available for live stream video sources. ContentFirst: content-priority.	TimeFirst

Response elements

Element	Type	Description	Example
	object
CasterId	string	The ID of the production studio. You can use this ID to perform operations on the scenario. These operations include copying, updating, querying, starting, and stopping the scenario. You can also use the ID to query the audio configuration of the scenario.	LIVEPRODUCER_POST-cn-0pp1czt****
EpisodeId	string	The ID of the episode. You can use this ID to manage the episode list and its items. For the episode list, you can perform operations such as query, edit, delete, start, and stop. For episode items, you can perform operations such as create, add, delete, and query.	a2b8e671-2fe5-4642-a2ec-bf938623****
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Success response

JSON format

{
  "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
500	InternalError	%s
404	InvalidCaster.NotFound	%s
404	InvalidResource.NotFound	%s
404	InvalidEpisode.NotFound	%s
404	InvalidComponent.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.