EffectCasterUrgent - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

You can call this operation to urgently switch a specified scene to the standby video. This operation applies only to Program (PGM) scenes.

QPS limit

The queries per second (QPS) limit for this operation is 10 per user. If you exceed this limit, API calls are throttled, which may impact your business.

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

get

*Caster

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-shanghai
CasterId	string	Yes	The ID of the production studio. If you created a production studio by calling the CreateCaster operation, use the returned CasterId value. If you created a production studio in the ApsaraVideo Live console, go to the Production Studio > Cloud Production Studio page to obtain the ID. Note The name of the production studio in the list on the Cloud Production Studio page is the production studio ID.	80787064-1c94-4dc1-85ce-9409960a****
SceneId	string	Yes	The ID of the scene. This parameter is valid only for PGM scenes. Call the DescribeCasterScenes operation to query the scene ID of the production studio.	242b4e2c-c30f-4442-85ba-2e3e4e3d****

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	InvalidSceneId.Malformed	%s
400	IncorrectSceneStatus	%s
400	IncorrectSceneStatus.Idle	%s
400	IncorrectChannel.Disable	%s
400	InvalidParameter.Malformed	%s
401	IllegalOperation	%s
500	InternalError	%s
404	InvalidCaster.NotFound	%s
404	InvalidUrgentMaterial.NotFound	%s
404	InvalidScene.NotFound	%s
404	InvalidResource.NotFound	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.