Modifies the configurations of an episode in a production studio.

Usage note

You cannot change the episode type using this operation.

QPS limit

A single user can perform a maximum of 4 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyCasterEpisode

The operation that you want to perform. Set the value to ModifyCasterEpisode.

CasterId String Yes 9ff2d96b-37ef-40a3-8cb0-4c7b1e2e****

The ID of the production studio.

If you create a production studio through the CreateCaster interface, check the value of the CasterId parameter in the response.

If you create a production studio through the ApsaraVideo Live Console, log in to the console, then check the ID of the production studio through the following path:

Production Studios > Production Studio Management

Note The CasterId is reflected in the Name column on the Production Studio Management page.
EpisodeId String Yes a2b8e671-2fe5-4642-a2ec-bf938623****

The ID of the episode. It is included in the response when you call the AddCasterEpisode operation.

RegionId String No cn-shanghai

The ID of the region.
EpisodeName String No episode_name_1

The name of the episode.
ResourceId String No 16A96B9A-F203-4EC5-8E43-CB92E683****

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.
ComponentId.N RepeatList No ["16A96B9A-F203-4EC5-8E43-CB92E68F****"]

The ID of the component. It is included in the response when you call the AddCasterComponent operation.

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 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 with and switched together with video resources.
    Note The variable N indicates the sequence number of the component. For example, the ComponentId.1 parameter specifies the ID of the first component. The ComponentId.2 parameter specifies the ID of the second component.
StartTime String No 2016-06-29T09:00:00Z

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.

EndTime String No 2016-06-29T10:20:00Z

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.

SwitchType String No TimeFirst

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.

Response parameters

Parameter Type Example Description
CasterId String 9ff2d96b-37ef-40a3-8cb0-4c7b1e2e****

The ID of the production studio.
EpisodeId String a2b8e671-2fe5-4642-a2ec-bf938623****

The ID of the episode.
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=ModifyCasterEpisode
&CasterId=9ff2d96b-37ef-40a3-8cb0-4c7b1e2e****
&EpisodeId=a2b8e671-2fe5-4642-a2ec-bf938623****
&<Common request parameters>

Sample success responses

XML format 

<ModifyCasterEpisodeResponse>
      <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
      <EpisodeId>a2b8e671-2fe5-4642-a2ec-bf938623****</EpisodeId>
      <CasterId>9ff2d96b-37ef-40a3-8cb0-4c7b1e2e****</CasterId>
</ModifyCasterEpisodeResponse>

JSON format 

{
    "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
    "EpisodeId": "a2b8e671-2fe5-4642-a2ec-bf938623****",
    "CasterId": "9ff2d96b-37ef-40a3-8cb0-4c7b1e2e****"
}

Error codes

For a list of error codes, visit the API Error Center.