Add Program Lists to Production Studios with AddCasterProgram - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Adds a program list to a production studio.

Operation description

Create a production studio and add video resources to it before calling this operation to add a program list. This operation currently supports only two node types: video source and component. To create a production studio by using an API operation, see CreateCaster.

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation appropriately.

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:AddCasterProgram

create

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
Episode	array<object>	Yes	The program list information.
	object	No	The program list information.
ComponentId	array	No	The component list. Elements are arranged from bottom to top in order. Important This parameter is valid and required when Episode.N.EpisodeType is set to Component. When the node type is Resource, this indicates that the component is bound to the video source and switches synchronously.	[ "a2b8e671-2fe5-4642-a2ec-bf931826**", "a2b8e671-2fe5-4642-a2ec-28374657**"]
	string	No	The component ID.	a2b8e671-2fe5-4642-a2ec-bf931826****
EndTime	string	No	The end time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC). This parameter is required. If not specified, MissingParameter is returned.	2016-06-29T10:02:00Z
EpisodeName	string	No	The program name.	program_name_1
EpisodeType	string	No	The node type. Valid values: Resource: video source. If you select Resource, you must also set the request parameters Episode.N.ResourceId and Episode.N.SwitchType. Component: component. If you select Component, you must also set the request parameter Episode.N.ComponentId.N. Note When Resource is selected and the referenced resource contains a VodUrl (video-on-demand file), EndTime - StartTime cannot exceed the actual playback duration (in seconds) of the VOD file. Otherwise, InvalidParameter.EndTime is returned.	Resource
ResourceId	string	No	The video source ID. Important This parameter is valid and required when Episode.N.EpisodeType is set to Resource. This parameter is not applicable when Episode.N.EpisodeType is set to Component. If you added the video source by calling the AddCasterVideoResource operation, check the ResourceId value returned by the AddCasterVideoResource operation.	a2b8e671-2fe5-4642-a2ec-bf93880e****
StartTime	string	No	The start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC). This parameter is required. If not specified, MissingParameter is returned.	2016-06-29T09:00:00Z
SwitchType	string	No	The switch policy. Valid values: Important This parameter is valid only when Episode.N.EpisodeType is set to Resource. TimeFirst: time first. Live video sources can only use the time first policy. ContentFirst: content first.	TimeFirst
CasterId	string	Yes	The production studio ID. If you created the production studio by calling the CreateCaster operation, check the CasterId value returned by the CreateCaster operation. If you created the production studio in the ApsaraVideo Live console, navigate to ApsaraVideo Live console > Production Studio > Cloud Production Studio to view the production studio name. Note The production studio name in the production studio list on the Cloud Production Studio page is the production studio ID.	LIVEPRODUCER_POST-cn-0pp1czt****

Note

N in the request parameters indicates the sequence number. For example:
Episode.N.EpisodeName indicates the Nth program name. Episode.1.EpisodeName indicates the first program name, and Episode.2.EpisodeName indicates the second program name.

Response elements

Element	Type	Description	Example
	object
EpisodeIds	object
EpisodeId	array<object>	The list of program IDs. The order of elements in the list is consistent with the order of the programs passed in.
	object
EpisodeId	string	The program group ID. You can use this ID as a request parameter to modify the program list, query the program list, delete a program, or modify a program.	16A96B9A-F203-4EC5-8E43-CB92E68F****
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F****

Examples

Success response

JSON format

{
  "EpisodeIds": {
    "EpisodeId": [
      {
        "EpisodeId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
      }
    ]
  },
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	%s.	Missing parameter
400	InvalidParameter.Malformed	There are invalid parameters: %s.	There are invalid parameters: %s.
400	SwitchTypeInvalid.Malformed	%s, please check and try again later.	The parameter SwitchType is invalid, please check and try again.
400	IncorrectStartTime	%s, please check and try again later.	The parameter StartTime is invalid, please check and try again.
400	IncorrectEndTime	%s, please check and try again later.	The parameter EndTime is invalid, please check and try again.
400	EpisodeConflict.Malformed	%s, please check and try again later.	There is a conflict with the program time, please check and try again.
400	InvalidCasterId.Malformed	%s, please check and try again later.	The parameter CasterId is invalid, please check and try again.
400	InvalidParameter.EndTime	%s, please check and try again later.	The parameter EndTime is invalid, please check and try again.
401	IllegalOperation	%s, please check and try again later.	Operation not allowed, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
404	InvalidCaster.NotFound	%s, please check and try again later.	The guide station does not exist, please check and try again.
404	InvalidResource.NotFound	%s, please check and try again later.	The resource does not exist. Please check and try again.
404	InvalidComponent.NotFound	%s, please check and try again later.	The component to be operated does not exist. Please check and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.