RestartCaster - ApsaraVideo Live

Restarts a production studio.

Usage notes

Only product studios in playlist mode and general mode are supported. Virtual studios are not supported.
After you restart a production studio, the current settings such as the resolution and screen orientation are reloaded to restore the previous playback status.

QPS limit

You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

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

RestartCaster

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

CasterId

String

Yes

80787064-1c94-4dc1-85ce-9409960a****

The ID of the production studio.

If the production studio was created by calling the CreateCaster operation, check the value of the response parameter CasterId to obtain the ID.
If the production studio was created by using the ApsaraVideo Live console, obtain the ID on the Production Studio Management page. To go to the page, log on to the ApsaraVideo Live console and click Production Studios in the left-side navigation pane.

Note

You can find the ID of the production studio in the Instance Name column.

Response parameters

Parameter	Type	Example	Description
RequestId	String	6EBD1AC4-C34D-4AE1-963E-B688A228BE31	The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=RestartCaster
&CasterId=80787064-1c94-4dc1-85ce-9409960a****
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<RestartCasterResponse>
    <RequestId>6EBD1AC4-C34D-4AE1-963E-B688A228BE31</RequestId>
</RestartCasterResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "6EBD1AC4-C34D-4AE1-963E-B688A228BE31"
}

Error codes

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