ListPlaylist - 获取播放列表 - 视频直播

查询节目单。

接口说明

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

QPS 限制

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
live:ListPlaylist	get	Caster `acs:live::{#accountId}:caster/{#CasterId}`	无	无

请求参数

名称	类型	必填	描述	示例值
ProgramId	string	否	节目单 ID。如果填此参数，则返回该节目单信息。若不填，默认返回该用户所有节目单信息。如果您通过 AddPlaylistItems 接口添加节目单项，请查看 AddPlaylistItems 接口调用返回的参数 ProgramId 值。	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
Page	integer	否	查询分页页数。	1
PageSize	integer	否	查询分页每页数量。	20

返回参数

名称	类型	描述	示例值
	object
ProgramList	array<object>	节目单信息列表。
ProgramInfo	object
CasterId	string	节目单对应导播台 ID。可作为添加虚拟演播厅布局、删除虚拟演播厅布局、修改虚拟演播厅布局和查询虚拟演播厅布局的请求参数。	casdfasdfasfdasdflkasjdflaj****
DomainName	string	主播流域名。	example.com
ProgramId	string	节目单 ID。	c09f3d63-eacf-4fbf-bd48-a07a6ba7****
ProgramName	string	节目单名称。	playlist1
RepeatNumber	integer	播放完后继续重复播放的次数。取值： 0（默认值）：不重复播放。 -1：一直循环重复。其他正整数：播放完 1 遍后继续重复播放的次数。	1
Status	integer	节目单状态。取值： 0：停止。 1：运行。	1
RequestId	string	请求 ID。	5c6a2a0d-f228-4a64-af62-20e91b96****
Total	integer	节目单数量。	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	错误码	错误信息
400	InvalidPageSize.Malformed	%s
400	InvalidPageNum.Malformed	%s
400	InvalidParameter.Malformed	%s
404	PlayListNotFound	%s
500	InternalError	%s

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史