StopPlaylist - ApsaraVideo Live - Alibaba Cloud Documentation Center

Usage notes

You can call the AddPlaylistItems operation to add episodes to an episode list and then call this operation to stop playing the episode list.

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	StopPlaylist	The operation that you want to perform. Set the value to StopPlaylist.
ProgramId	String	Yes	445409ec-7eaa-461d-8f29-4bec2eb9****	The ID of the episode list. If you call the AddPlaylistItems operation to add episodes to an episode list, you can obtain the ID of the episode list from the ProgramId parameter in the response.

Response parameters

Parameter	Type	Example	Description
ProgramId	String	445409ec-7eaa-461d-8f29-4bec2eb9****	The ID of the episode list.
RequestId	String	5c6a2a0d-f228-4a64-af62-20e91b96****	The request ID.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=StopPlaylist
&ProgramId=445409ec-7eaa-461d-8f29-4bec2eb9****
&<Common request parameters>

Sample success responses

XML format

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

<?xml version="1.0" encoding="UTF-8" ?>
<StopPlaylistResponse>
<RequestId>5c6a2a0d-f228-4a64-af62-20e91b96****</RequestId>
<ProgramId>445409ec-7eaa-461d-8f29-4bec2eb9****</ProgramId>
</StopPlaylistResponse>

JSON format

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

{
  "StopPlaylistResponse" : {
    "RequestId" : "5c6a2a0d-f228-4a64-af62-20e91b96****",
    "ProgramId" : "445409ec-7eaa-461d-8f29-4bec2eb9****"
  }
}

Error codes

For a list of error codes, see Service error codes.