ListPlaylist - ApsaraVideo Live

Usage note

If the ProgramId is specified in the request, the server returns information about the specific program. If it is not specified, the server returns all the programs.

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	ListPlaylist	The operation that you want to perform. Set the value to ListPlaylist.
ProgramId	String	No	c09f3d63-eacf-4fbf-bd48-a07a6ba7****	The IDs of the episode lists that you want to query. If you set this parameter, only the information about the specified episode lists is returned. If you do not set this parameter, the information about all episode lists that belong to the current account is returned.
Page	Integer	No	1	The number of the page to return.
PageSize	Integer	No	20	The number of entries to return on each page.

Response parameters


Parameter	Type	Example	Description
ProgramList	Array of ProgramInfo		The information about the queried episode lists.
CasterId	String	casdfasdfasfdasdflkasjdflaj****	The ID of the streaming panel to which the episode list belongs.
DomainName	String	example.com	The main streaming domain.
ProgramId	String	c09f3d63-eacf-4fbf-bd48-a07a6ba7****	The ID of the episode list that was queried.
ProgramName	String	playlist1	The name of the episode list that was queried.
RepeatNumber	Integer	1	The number of times the episode list repeats after the first playback is complete. Valid values: 0: indicates that the episode list is played only once. This is the default value. -1: indicates that the episode list is played in loop mode. Positive integer: indicates the number of times the episode list repeats after the first playback is complete.
Status	Integer	1	The status of the episode list. Valid values: 0: stopped 1: running
RequestId	String	5c6a2a0d-f228-4a64-af62-20e91b96****	The ID of the request.
Total	Integer	1	The total number of episode lists that were queried.

Examples

Sample requests

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

Sample success responses

XML format

<ListPlaylistResponse>
      <ProgramList>
           <Status>1</Status>
           <RepeatNumber>1</RepeatNumber>
          <DomainName>example.com</DomainName>
           <ProgramId>c09f3d63-eacf-4fbf-bd48-a07a6ba7****</ProgramId>
           <CasterId>casdfasdfasfdasdflkasjdflaj****</CasterId>
           <ProgramName>playlist1</ProgramName>
      </ProgramList>
      <RequestId>5c6a2a0d-f228-4a64-af62-20e91b96****</RequestId>
      <Total>1</Total>
</ListPlaylistResponse>

JSON format

{
    "ProgramList":[{
        "Status":"1",
        "RepeatNumber":"1",
        "DomainName":"example.com",
        "ProgramId":"c09f3d63-eacf-4fbf-bd48-a07a6ba7****",
        "CasterId":"casdfasdfasfdasdflkasjdflaj****",
        "ProgramName":"playlist1"
    }],
    "RequestId":"5c6a2a0d-f228-4a64-af62-20e91b96****",
    "Total":"1"
}

Error codes

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