AddCasterProgram - ApsaraVideo Live - Alibaba Cloud Documentation Center

Adds a program list to a production studio.

Operation description

Before you call this operation, you must create a production studio and add video resources to it. This operation supports only video source and component nodes. To create a production studio by calling an API, see CreateCaster.

QPS limits

The queries per second (QPS) limit for a single user is 10 calls per second. If you exceed this limit, API calls are throttled. This can affect your business. We recommend that you call this operation within this limit.

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	A list of component IDs. The components are layered from bottom to top in the order of the elements in the list. Important This parameter is required and takes effect only when Episode.N.EpisodeType is set to Component. If the node type is Resource, the components are attached to the video source and switched in sync.	[ "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. The time is in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.	2016-06-29T10:02:00Z
EpisodeName	string	No	The program name.	program_name_1
EpisodeType	string	No	The node type. Resource: a video source. If you set this parameter to Resource, you must also set the Episode.N.ResourceId and Episode.N.SwitchType parameters. Component: a component. If you set this parameter to Component, you must also set the Episode.N.ComponentId.N parameter.	Resource
ResourceId	string	No	The video source ID. Important This parameter is required and takes effect only when Episode.N.EpisodeType is set to Resource. This parameter is not available when Episode.N.EpisodeType is set to Component. If you call the AddCasterVideoResource operation to add a video source to the production studio, use the value of the ResourceId parameter that is returned.	a2b8e671-2fe5-4642-a2ec-bf93880e****
StartTime	string	No	The start time. The time is in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.	2016-06-29T09:00:00Z
SwitchType	string	No	The switch policy. Valid values: Important This parameter takes effect only when Episode.N.EpisodeType is set to Resource. TimeFirst: time-based priority. This is the only policy allowed for live video sources. ContentFirst: content-based priority.	TimeFirst
CasterId	string	Yes	The ID of the production studio. If you create a production studio by calling the CreateCaster operation, use the value of the CasterId parameter that is returned. If you create a production studio in the LIVE console, you can find the name of the production studio by choosing LIVE Console > Production Studio > Cloud Production Studio. Note The name of the production studio in the list on the Cloud Production Studio page is the production studio ID.	LIVEPRODUCER_POST-cn-0pp1czt****

Note

In the request parameters, N indicates the sequence number. For example, Episode.1.EpisodeName specifies the name of the first program and Episode.2.EpisodeName specifies the name of the second program.

Response parameters

Parameter	Type	Description	Example
	object
EpisodeIds	object
EpisodeId	array<object>	A list of program IDs. The order of elements in the list is the same as the order of the programs in the request.
	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
400	MissingParameter	%s
400	InvalidParameter.Malformed	%s
400	SwitchTypeInvalid.Malformed	%s
400	IncorrectStartTime	%s
400	IncorrectEndTime	%s
400	EpisodeConflict.Malformed	%s
400	InvalidCasterId.Malformed	%s
400	InvalidParameter.EndTime	%s
401	IllegalOperation	%s
500	InternalError	%s
404	InvalidCaster.NotFound	%s
404	InvalidResource.NotFound	%s
404	InvalidComponent.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.