Starts a specified preview scene.
Operation description
This operation is only applicable to the PVW scenes.
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
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| live:StartCasterScene | update | *Caster acs:live:*:{#accountId}:caster/{#CasterId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| CasterId | string | Yes | 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**** |
| SceneId | string | Yes | The ID of the scene. This parameter takes effect only when the scene is a preview scene. For more information about the scenes, see Query the scenes of production studios. | 242b4e2c-c30f-4442-85ba-2e3e4e3d**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"StreamUrl": "http://live/caster/example.org",
"RequestId": "CF60DB6A-7FD6-426E-9288-122CC1A52FA7"
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | IncorrectSceneStatus | %s |
| 400 | IncorrectSceneStatus.Inuse | %s |
| 400 | IncorrectCasterStatus.Idle | %s |
| 400 | InvalidCasterId.Malformed | %s |
| 400 | InvalidSceneId.Malformed | %s |
| 401 | IllegalOperation | %s |
| 403 | UserQuotaExceed | %s |
| 404 | InvalidCaster.NotFound | %s |
| 404 | InvalidScene.NotFound | %s |
| 404 | InvalidLayout.NotFound | %s |
| 404 | InvalidConfiguration.NotFound | %s |
| 404 | InvalidCasterTemplate.NotFound | %s |
| 500 | InternalError | %s |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|