Configure Caster Program Lists with AddCasterEpisodeGroup - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Adds a program list to a production studio.

Operation description

Create a production studio and obtain its configuration information before calling this operation to add a program list to the production studio. To create a production studio by using an API operation, see Create a production studio.

QPS limit

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

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

create

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
Item	array<object>	Yes	The program list.
	object	No	The program object.
ItemName	string	No	The program name.	节目1
VodUrl	string	No	The video-on-demand file URL. If you query the video sources of a production studio by calling the DescribeCasterVideoResources operation, check the VodUrl parameter value returned by the DescribeCasterVideoResources operation. Note This parameter is used only when the resource is a file video and the video file has not been imported to the media library. Supported formats: MP4, FLV, and TS.	http://learn.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201**.flv?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f**
ClientToken	string	Yes	The request token generated by the user. This parameter is used to ensure the idempotence of the request. Important This parameter value is generated by the client. Ensure that the value is unique across different requests. The maximum length is 64 ASCII characters.	8751ad99-2ddb-4aac-ad44-84b21102****
DomainName	string	Yes	The primary streaming domain.	example.com
StartTime	string	Yes	The start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2018-03-06T19:00:00Z
RepeatNum	integer	Yes	The number of repetitions. Valid values: 0: no loop. -1: infinite loop.	0
SideOutputUrl	string	Yes	The ingest URL corresponding to the custom bypass output address of the production studio.	rtmp://guide.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201**?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f**
CallbackUrl	string	Yes	The callback URL. The URL must be a valid URL that complies with RFC 2396. The host must be a real domain name or IP address that can be resolved by DNS. If you query the production studio configuration by calling the DescribeCasterConfig operation, check the CallbackUrl parameter value returned by the DescribeCasterConfig operation.	http://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201**?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f**

Response elements

Element	Type	Description	Example
	object
ItemIds	object
ItemId	array	The list of program IDs.
	string	The program ID.	21926b36-7dd2-4fde-ae25-51b5bc98****
ProgramId	string	The program list ID. This ID can be used as a request parameter for deleting a production studio program list, creating or adding program list items, deleting program list items, querying program list items, editing a program list, deleting a program list, querying a program list, starting a program list, or stopping a program list.	16A96B9A-F203-4EC5-8E43-CB92E68X****
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F****

Examples

Success response

JSON format

{
  "ItemIds": {
    "ItemId": [
      "21926b36-7dd2-4fde-ae25-51b5bc98****"
    ]
  },
  "ProgramId": "16A96B9A-F203-4EC5-8E43-CB92E68X****",
  "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	IncorrectStartTime	%s, please check and try again later.	The parameter StartTime 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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.