All Products
Search

This Product

    ApsaraVideo Live:PlayChoosenShow

    Document Center

    ApsaraVideo Live:PlayChoosenShow

    Last Updated:Jul 17, 2026

    Manually switches a show.

    Operation description

    After you add a show and start live streaming, you can call this operation to switch the show. To add a show by using an API operation, see Add a show to the show list.

    QPS limit

    The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation appropriately.

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

    none

    *Caster

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    No

    The region ID.

    cn-shanghai
    CasterId

    string

    Yes

    The production studio ID.

    • If you created the production studio by calling the CreateCaster operation, check the CasterId parameter in the response.

    • If you created the production studio in the ApsaraVideo Live console, navigate to ApsaraVideo Live console > Production Studio > Cloud Production Studio to view the production studio name.

    Note

    • The production studio name in the production studio list on the Cloud Production Studio page is the production studio ID.

    • The production studio must be in the running (Status=1) state. Otherwise, the IncorrectCasterStatus error is returned. For a production studio in the idle state, call StartCaster to start the production studio first.

    LIVEPRODUCER_POST-cn-0pp1czt****
    ShowId

    string

    Yes

    The ID of the show to switch to.

    Note

    You can obtain the ShowId value from the response parameters of the AddShowIntoShowList or DescribeShowList operation.

    a2b8e671-2fe5-4642-a2ec-bf93880e****

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
    ShowId

    string

    The show ID.

    a2b8e671-2fe5-4642-a2ec-bf93880e****

    Examples

    Success response

    JSON format

    {
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "ShowId": "a2b8e671-2fe5-4642-a2ec-bf93880e****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidUserId.Malformed %s, please check userId. The userId passed in is invalid, please check.
    400 InvalidParameter.Malformed There are invalid parameters: %s. There are invalid parameters: %s.
    400 InvalidCasterId.Malformed %s, please check and try again later. The parameter CasterId is invalid, please check and try again.
    400 IncorrectCasterStatus %s, please check and try again later. Guide station status error, please check and try again.
    400 MissingParameter %s. Missing parameter
    401 IllegalOperation %s, please check and try again later. Operation not allowed, please check and try again.
    500 InternalError %s, please try again later. Internal error, please try again later.
    404 InvalidCaster.NotFound %s, please check and try again later. The guide station does not exist, please check and try again.
    404 InvalidShowList.NotFound %s, please check and try again later. ShowList does not exist, please check and try again.
    404 InvalidShow.NotFound %s, please check and try again later. Show does not exist, please check and try again.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.