UpdateCasterSceneConfig - ApsaraVideo Live - Alibaba Cloud Documentation Center

Modifies a scene, including the layout, without invalidating the previous configurations. This operation is more efficient than the SetCasterSceneConfig operation.

Operation description

You can call this operation to incrementally modify the configuration of a scene, including its layout. This operation preserves existing settings and is more efficient than a full update.

QPS limit

The queries per second (QPS) limit for this operation is 10 calls per second per user. Calls that exceed this limit are throttled, which may affect your business. We recommend that you 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:UpdateCasterSceneConfig

update

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-shanghai
ComponentId	array	No	A list of component IDs. The components in the array are layered from bottom to top. Note N indicates the sequence number. For example, ComponentId.1 is the ID of the first component and ComponentId.2 is the ID of the second component.	["98778372-c30f-4442-85ba-2e3e4e3d****"]
	string	No	A list of component IDs. The components in the array are layered from bottom to top. Note N indicates the sequence number. For example, ComponentId.1 is the ID of the first component and ComponentId.2 is the ID of the second component.	["98778372-c30f-4442-85ba-2e3e4e3d****"]
CasterId	string	Yes	The ID of the production studio. If you create a production studio by calling the CreateCaster operation, use the CasterId value from the response. If you create a production studio in the ApsaraVideo Live console, find the ID on the Cloud Production Studio page. Navigate to this page by choosing Production Studio > Cloud Production Studio in the ApsaraVideo Live console. Note The name of the production studio in the list is its ID.	80787064-1c94-4dc1-85ce-9409960a****
SceneId	string	Yes	The ID of the scene.	242b4e2c-c30f-4442-85ba-2e3e4e3d****
LayoutId	string	Yes	The ID of the layout. If you query the layout list for the production studio by calling the DescribeCasterLayouts operation, use the LayoutId value from the response.	eeab74fb-379d-4599-a93d-86d16a05****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	CF60DB6A-7FD6-426E-9288-122CC1A52FA7

Examples

Success response

JSON format

{
  "RequestId": "CF60DB6A-7FD6-426E-9288-122CC1A52FA7"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidCasterId.Malformed	%s
400	InvalidUserId.Malformed	%s
400	MissingParameter	%s
400	InvalidParameter.Malformed	%s
400	IncorrectSceneStatus.ConfigError	%s
400	ComponentNumberExceed	%s
400	SceneNumberExceed	%s
400	IncorrectSceneStatus.Waiting	%s
400	IncorrectSceneStatus.Idle	%s
400	InvalidCaptionResource	%s
400	IncorrectSceneStatus	%s
401	IllegalOperation	%s
412	ResourceInChannel.PreConditionFailed	%s
412	ResourceInChannel.Invalid	%s
500	InternalError	%s
404	InvalidCaster.NotFound	%s
404	InvalidScene.NotFound	%s
404	InvalidLayout.NotFound	%s
404	InvalidComponent.NotFound	%s
404	InvalidVideo.NotFound	%s
404	ResourceInChannel.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.