All Products
Search
Document Center

ApsaraVideo Live:AddCasterEpisodeGroupContent

Last Updated:Nov 14, 2024

Adds information about an episode list in a production studio.

Operation description

You need to create a production studio and add an episode list to the production studio before you call this operation to add information about the episode list in the production studio. For information about how to create a production studio, see CreateCaster .

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
live:AddCasterEpisodeGroupContentcreate
*Domain
acs:live:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringYes

The client token that is used to ensure the idempotence of the request.

You can use the client to generate a token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

8751ad99-2ddb-4aac-ad44-84b21102****
ContentstringYes

The information about the episode list. The value is a JSON string. Use upper camel case for fields of the string. This parameter contains the following fields:

  • CallbackUrl: the callback URL.

  • SideOutputUrl: the custom standby URL.

  • RepeatNum: the number of times the episode list repeats after the first playback is complete. A value of 0 indicates that the episode list is played only once. A value of -1 indicates that the episode list is played in loop mode.

  • DomainName: the domain name.

  • StartTime: the time when the episode list starts to play. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

  • Items: the information about the episode list. It is an array of ItemName and VodUrl.

    • ItemName: the name of the episode.
    • VodUrl: the URL of the VOD file. This field takes effect only when the video resource is a video file that is not from the media library. The video file must be in the MP4, FLV, or TS format.
CallbackUrl

Response parameters

ParameterTypeDescriptionExample
object
ItemIdsarray

The IDs of the episodes.

ItemIdstring

The ID of the episode.

21926b36-7dd2-4fde-ae25-51b5bc8e****
ProgramIdstring

The ID of the episode list. You can use the ID as a request parameter in the API operation that is used to create or add episodes, remove episodes, query episodes, edit an episode list, delete an episode list, query the information about an episode list, start playing an episode list, or stop playing an episode list.

16A96B9A-F203-4EC5-8E43-CB92E68X****
RequestIdstring

The request ID.

16A96B9A-F203-4EC5-8E43-CB92E68F****

Examples

Sample success responses

JSONformat

{
  "ItemIds": {
    "ItemId": [
      "21926b36-7dd2-4fde-ae25-51b5bc8e****"
    ]
  },
  "ProgramId": "16A96B9A-F203-4EC5-8E43-CB92E68X****",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}

Error codes

HTTP status codeError codeError message
400MissingParameter%s
400InvalidParameter.Malformed%s
400IncorrectStartTime%s
400InvalidClientToken.Malformed%s
401IllegalOperation%s
500InternalError%s

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history