PlayChoosenShow - ApsaraVideo Live - Alibaba Cloud Documentation Center

Switches to a specified episode.

Operation description

After you add episodes to an episode list and start a live stream, you can call this operation to switch between episodes. For information about how to add episodes to an episode list, see AddShowIntoShowList .

QPS limit

You can send up to 10 requests per second to call this operation by using your Alibaba Cloud account. If the number of the calls per second exceeds the limit, throttling is triggered. This may affect your business. We recommend that you take note of the limit when you call this operation. For more information, 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
live:PlayChoosenShow	get	Caster `acs:live::{#accountId}:caster/{#CasterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
CasterId	string	Yes	The ID of the production studio instance. If the instance was created by calling the CreateCaster operation, check the value of the response parameter CasterId to obtain the instance ID. If the instance was created in the ApsaraVideo Live console, obtain the instance 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 The value displayed in the Name column for an instance on the Production Studio Management page is the ID of the instance.	LIVEPRODUCER_POST-cn-0pp1czt****
ShowId	string	Yes	The ID of the episode to be switched to. Note You can obtain the episode ID from the response parameters of AddShowIntoShowList or DescribeShowList .	a2b8e671-2fe5-4642-a2ec-bf93880e****

Response parameters

Parameter	Type	Description	Example
	object
ShowId	string	The ID of the episode.	a2b8e671-2fe5-4642-a2ec-bf93880e****
RequestId	string	The ID of the request.	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

Sample code

public static DefaultAcsClient initClient(String accessKeyId, String accessKeySecret) throws ClientException {
        String regionId = "cn-shanghai"; 
        DefaultProfile profile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
        DefaultAcsClient client = new DefaultAcsClient(profile);
        return client;
    }

private static void playChoosenShow(DefaultAcsClient client, String casterId, String showId) throws ClientException {
        CommonRequest playChoosenShow = new CommonRequest();
        playChoosenShow.setSysDomain("live.aliyuncs.com");
        playChoosenShow.setSysVersion("2016-11-01");
        playChoosenShow.setSysAction("playChoosenShow");
        playChoosenShow.putQueryParameter("CasterId", casterId);
        playChoosenShow.putQueryParameter("ShowId", showId);
        CommonResponse playChoosenShowResponse = client.getCommonResponse(playChoosenShow);
        System.out.println("Manual switching of showId: "+showId+" completed");
    }

public void playChooseShow() throws ClientException {
        DefaultAcsClient client = initClient(ACCESS_KEY_ID, ACCESS_KEY_SECRET);
        String showId= "";
        playChoosenShow(client,testCasterId,showId);
    }

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
400	InvalidUserId.Malformed	%s
400	InvalidParameter.Malformed	%s
400	InvalidCasterId.Malformed	%s
400	IncorrectCasterStatus	%s
400	MissingParameter	%s
401	IllegalOperation	%s
404	InvalidShowList.NotFound	%s
404	InvalidShow.NotFound	%s
500	InternalError	%s

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

Change history

Change time	Summary of changes	Operation

No change history