Stops a specified preview scene.

Usage note

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes StopCasterScene

The operation that you want to perform. Set the value to StopCasterScene.

CasterId String Yes 80787064-1c94-4dc1-85ce-9409960a****

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.
SceneId String Yes 242b4e2c-c30f-4442-85ba-2e3e4e3d****

The ID of the scene.

This operation is available only when the scene is a preview scene. For more information about the scene types, see Query the scenes of production studios.

RegionId String No cn-shanghai

The ID of the region.

Response parameters

Parameter Type Example Description
RequestId String CF60DB6A-7FD6-426E-9288-122CC1A52FA7

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=StopCasterScene
&CasterId=80787064-1c94-4dc1-85ce-9409960a****
&SceneId=242b4e2c-c30f-4442-85ba-2e3e4e3d****
&<Common request parameters>

Sample success responses

XML format 

<StopCasterSceneResponse>
      <RequestId>CF60DB6A-7FD6-426E-9288-122CC1A52FA7</RequestId>
</StopCasterSceneResponse>

JSON format 

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

Error codes

For a list of error codes, visit the API Error Center.