AddCasterEpisodeGroup - 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 obtain its configuration information. For more information, see Create a production studio.

QPS limit

The queries per second (QPS) limit for this operation is 4 calls per second per user. If you exceed the limit, your API calls are throttled. Throttling can affect your business. Plan your calls accordingly.

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 list of programs.
	object	No	The program object.
ItemName	string	No	The name of the program.	节目1
VodUrl	string	No	The URL of the video-on-demand (VOD) file. If you call the DescribeCasterVideoResources operation to query the video sources of the production studio, use the value of the returned VodUrl parameter. Note This parameter is used only when the resource is a video file that is not imported to the Material Library. Supported formats: MP4, FLV, and TS.	http://learn.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201**.flv?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f**
ClientToken	string	Yes	A client-generated token that is used to ensure the idempotence of the request. Important The token must be unique for each request. It can be up to 64 ASCII characters in length.	8751ad99-2ddb-4aac-ad44-84b21102****
DomainName	string	Yes	The streaming domain.	example.com
StartTime	string	Yes	The start time. Specify the time in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC.	2018-03-06T19:00:00Z
RepeatNum	integer	Yes	The number of times to repeat the program. Valid values: 0: The program does not loop. -1: The program loops indefinitely.	0
SideOutputUrl	string	Yes	The ingest URL for the custom bypass output of the production studio. If you do not specify this parameter, the system uses the ingest URL for the output URL that is automatically generated by Alibaba Cloud.	rtmp://guide.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201**?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f**
CallbackUrl	string	Yes	The webhook address. If you call the DescribeCasterConfig operation to query the configuration of the production studio, use the value of the returned CallbackUrl parameter.	http://developer.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201**?auth_key=1608953344-0-0-53f0758162964516ac850f2ddc3f**

Response parameters

Parameter	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 ID of the program list. This ID is used as a request parameter for other operations, such as deleting or editing a program list, or adding, deleting, or querying a program.	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
400	MissingParameter	%s
400	InvalidParameter.Malformed	%s
400	IncorrectStartTime	%s
401	IllegalOperation	%s
500	InternalError	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.