调用ListPlaylist查询节目单。

使用说明

先通过AddPlaylistItems接口添加节目单项，再调用本接口查询节目单。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListPlaylist

系统规定参数。取值：

ListPlaylist。

RegionId String 否 cn-shanghai

地域ID。
ProgramId String 否 c09f3d63-eacf-4fbf-bd48-a07a6ba7****

节目单ID。如果填此参数，则返回该节目单信息。若不填，默认返回该用户所有节目单信息。

如果您通过AddPlaylistItems接口添加节目单项，请查看AddPlaylistItems接口调用返回的参数ProgramId值。

Page Integer 否 1

查询分页页数。
PageSize Integer 否 20

查询分页每页数量。

返回数据

名称 类型 示例值 描述
ProgramList Array of ProgramInfo

节目单信息列表。
CasterId String casdfasdfasfdasdflkasjdflaj****

节目单对应导播台ID。可作为添加虚拟演播厅布局、删除虚拟演播厅布局、修改虚拟演播厅布局和查询虚拟演播厅布局的请求参数。
DomainName String example.com

主播流域名。
ProgramId String c09f3d63-eacf-4fbf-bd48-a07a6ba7****

节目单ID。
ProgramName String playlist1

节目单名称。
RepeatNumber Integer 1

播放完后继续重复播放的次数。取值：

  • 0（默认值）：不重复播放。
  • -1：一直循环重复。
  • 其他正整数：播放完1遍后继续重复播放的次数。
Status Integer 1

节目单状态。取值：

  • 0：停止。
  • 1：运行。
RequestId String 5c6a2a0d-f228-4a64-af62-20e91b96****

请求ID。
Total Integer 1

节目单数量。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=ListPlaylist
&<公共请求参数>

正常返回示例

XML格式 

<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格式 

{
    "ListPlaylistResponse": {
        "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
    }
}

错误码

访问错误中心查看更多错误码。