All Products
Search
Document Center

ApsaraVideo Live:EffectCasterVideoResource

Last Updated:Nov 14, 2024

Updates the standby video resource in a specified scene.

Operation description

Make sure that the video resource is referenced by the scene.

QPS limit

A single user can perform a maximum of 10 queries per second (QPS). Throttling is triggered when the number of calls per second exceeds the QPS limit. The throttling may affect your business. Thus, we recommend that you observe the QPS limit on this operation. For more information about what a single user means and the QPS details, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
live:EffectCasterVideoResourceget
*Domain
acs:live:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CasterIdstringYes

The ID of the production studio.

If you create a production studio through the CreateCaster interface, check the value of the CasterId parameter in the response.

If you create a production studio through the ApsaraVideo Live Console, log in to the console, then check the ID of the production studio through the following path:

Production Studios > Production Studio Management

Note The CasterId is reflected in the Name column on the Production Studio Management page.
80787064-1c94-4dc1-85ce-9409960a****
SceneIdstringYes

The ID of the scene. You can call the DescribeCasterScenes operation to get the ID.

05ab713c-676e-49c0-96ce-cc408da1****
ResourceIdstringYes

The ID of the video resource.

f096e8d6-0319-4c96-82bc-ecbc79cf****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CF60DB6A-7FD6-426E-9288-122CC1A52FA7

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400IncorrectSceneStatus.Idle%s
400IncorrectSceneStatus.ConfigError%s
400InvalidResourceId.Malformed%s
400InvalidCasterId.Malformed%s
400InvalidSceneId.Malformed%s
401IllegalOperation%s
404InvalidCaster.NotFound%s
404InvalidResource.NotFound%s
404InvalidScene.NotFound%s
404InvalidLayout.NotFound%s
500InternalError%s

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history