AddCasterEpisodeGroupContent - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

Before you call this operation, you must create a production studio and an episode group. For more information, see Create a production studio.

QPS limit

The queries per second (QPS) limit for this operation is 4 for each user. If you exceed this limit, your API calls are throttled. This may impact 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:AddCasterEpisodeGroupContent

create

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
ClientToken	string	Yes	A client-generated token that is used to ensure the idempotence of the request. Note The client generates this value. Make sure that the value is unique among different requests. The value can be up to 64 ASCII characters in length.	8751ad99-2ddb-4aac-ad44-84b21102****
Content	string	Yes	The properties of the episode in the production studio. This parameter is a JSON string. The parameter names are in upper camel case. The properties are described as follows: CallbackUrl: The webhook address. SideOutputUrl: The custom bypass output URL. RepeatNum: The number of times to loop the episode. A value of 0 means the episode does not loop. A value of -1 means the episode loops indefinitely. StartTime: The start time in UTC. The format is yyyy-MM-ddTHH:mm:ssZ. DomainName: The domain name. Items: The list of items in the episode. ItemName: The item name. VodUrl: The URL of the video-on-demand (VOD) file. This parameter is required only when the resource is a video file that has not been imported to the Material Library. The MP4, FLV, and TS formats are supported.	{"CallbackUrl":"http://example.aliyundoc.com/callBackLive","SideOutputUrl":"rtmp://guide.aliyundoc.com/caster/4a82a3d1b7f0462ea37348366201**?auth_key=1608953344-0-0-ac8c628078541d7055a170ec59a5**","DomainName":"developer.aliyundoc.com ","StartTime":"2018-03-26T16:00:00Z","RepeatNum":-1,"Items":[{"ItemName":"节目1","VodUrl":"http://learn.aliyundoc.com"},{"ItemName":"节目2","VodUrl":"http://demo.aliyundoc.com"}]}

Response parameters

Parameter	Type	Description	Example
	object
ItemIds	object
ItemId	array	A list of item IDs.
	string	The item ID.	21926b36-7dd2-4fde-ae25-51b5bc8e****
ProgramId	string	The program ID. You can use this ID as a request parameter when you create, add, delete, or query program items. You can also use this ID to edit, delete, query, start, or stop a program.	16A96B9A-F203-4EC5-8E43-CB92E68X****
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Success response

JSON format

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

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.