ListPlaylist - 获取播放列表

更新时间: 2024-12-24 15:03:37

查询节目单。

接口说明

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

QPS 限制

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:ListPlaylistget
*Caster
acs:live:*:{#accountId}:caster/{#CasterId}

请求参数

名称类型必填描述示例值
ProgramIdstring

节目单 ID。如果填此参数,则返回该节目单信息。若不填,默认返回该用户所有节目单信息。 如果您通过 AddPlaylistItems 接口添加节目单项,请查看 AddPlaylistItems 接口调用返回的参数 ProgramId 值。

c09f3d63-eacf-4fbf-bd48-a07a6ba7****
Pageinteger

查询分页页数。

1
PageSizeinteger

查询分页每页数量。

20

返回参数

名称类型描述示例值
object
ProgramListarray<object>

节目单信息列表。

ProgramInfoobject
CasterIdstring

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

casdfasdfasfdasdflkasjdflaj****
DomainNamestring

主播流域名。

example.com
ProgramIdstring

节目单 ID。

c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ProgramNamestring

节目单名称。

playlist1
RepeatNumberinteger

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

  • 0(默认值):不重复播放。
  • -1:一直循环重复。
  • 其他正整数:播放完 1 遍后继续重复播放的次数。
1
Statusinteger

节目单状态。取值:

  • 0:停止。
  • 1:运行。
1
RequestIdstring

请求 ID。

5c6a2a0d-f228-4a64-af62-20e91b96****
Totalinteger

节目单数量。

1

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息
400InvalidPageSize.Malformed%s
400InvalidPageNum.Malformed%s
400InvalidParameter.Malformed%s
404PlayListNotFound%s
500InternalError%s

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

变更历史

变更时间变更内容概要操作
暂无变更历史
上一篇: DeletePlaylist - 删除播放列表 下一篇: StartPlaylist - 开始播放列表项
阿里云首页 视频直播 相关技术圈