ModifyCasterProgram - ApsaraVideo Live - Alibaba Cloud Documentation Center

This operation modifies the program list of a production studio.

Operation description

You can call the AddCasterProgram operation to add a program list for a production studio. Then, you can call this operation to modify the program list. This operation supports programs of the video source and component types.

QPS limit

The queries per second (QPS) limit for a single user is 4 calls per second. If you exceed this limit, API calls are throttled, which may 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:ModifyCasterProgram

update

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
Episode	array<object>	Yes	The program information.
	object	No	The program information.
ComponentId	array	No	The list of component IDs. The components are layered from bottom to top in the order they are listed. The components are switched in sync with the video source. This parameter is required and takes effect only when the node type is Component. If the node type is Resource, the components are attached to the video source and switched in sync.	["a2b8e671-2fe5-4642-a2ec-bf93888****" ]
	string	No	The list of component IDs. The components are layered from bottom to top in the order they are listed. The components are switched in sync with the video source. This parameter is required and takes effect only when the node type is Component. If the node type is Resource, the components are attached to the video source and switched in sync.	["a2b8e671-2fe5-4642-a2ec-bf93888****" ]
EndTime	string	No	The end time. The time is in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.	2016-06-29T10:04:00Z
EpisodeId	string	No	The program ID. If you add a program for the production studio by calling the AddCasterEpisode operation, use the value of the EpisodeId parameter that is returned in the response.	a2b8e671-2fe5-4642-a2ec-bf938887****
EpisodeName	string	No	The program name.	program_name_2
EpisodeType	string	No	The program type. Valid values: Resource: video source. Component: component.	Resource
ResourceId	string	No	The ID of the video source. If you add a video source for the production studio by calling the AddCasterVideoResource operation, use the value of the ResourceId parameter that is returned in the response.	a2b8e671-2fe5-4642-a2ec-bf938887****
StartTime	string	No	The start time. The time is in UTC. The format is yyyy-MM-ddTHH:mm:ssZ.	2016-06-29T09:02:00Z
SwitchType	string	No	The switch policy. This parameter is valid only when the node type is Resource. TimeFirst: time-first. This is the only valid policy for live stream video sources. ContentFirst: content-first.	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 in the response. If you create a production studio in the ApsaraVideo Live console, go to the Production Studio > Cloud Production Studio page to view the ID. Note The name of the production studio in the list on the Cloud Production Studio page is the production studio ID.	a2b8e671-2fe5-4642-a2ec-bf93880e****

A request must include at least one Episode property to specify the program content to be modified.

Note

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

Response elements

Element	Type	Description	Example
	object
CasterId	string	The ID of the production studio.	a2b8e671-2fe5-4642-a2ec-bf93880e****
RequestId	string	The request ID.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Examples

Success response

JSON format

{
  "CasterId": "a2b8e671-2fe5-4642-a2ec-bf93880e****",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

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	IncorrectEpisodeStatus	%s, please check and try again later.	The current status of the program is not operational, 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.
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	InvalidEpisode.NotFound	%s, please check and try again later.	Episode 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.