全部产品
Search
文档中心

视频直播:ListPlaylistItems - 列出播放列表项

更新时间:Nov 14, 2024

查询指定节目单下的节目单项。

接口说明

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

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

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

445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramItemIdsstring

节目单项 ID 列表。用英文逗号(,)隔开。 如果传该参数,则只返回指定节目单项的信息。若不传,则返回该节目单所有节目单项的信息。

c10f3d63-eacf-4fbf-bd48-a07a6ba7****,c09f3d63-eacf-4fbf-bd48-a07a6ba7****

返回参数

名称类型描述示例值
object
Totalinteger

节目单项数量。

1
RequestIdstring

请求 ID。

5c6a2a0d-f228-4a64-af62-20e91b9****
ProgramItemsarray<object>

节目单列表。

ProgramItemobject
Indexinteger

编排索引。

1
ResourceTypestring

资源类型。

vod
ProgramItemIdstring

节目单项 ID。

c10f3d63-eacf-4fbf-bd48-a07a6ba7****
ProgramIdstring

节目单 ID。可作为编辑节目单,删除节目单,查询节目单,启动节目单,停止节目单的请求参数。

445409ec-7eaa-461d-8f29-4bec2eb9****
ProgramItemNamestring

节目单项名称。

playlistItem1
ResourceValuestring

资源 ID。

asdfasdf8as9df8sa9df89****

示例

正常返回示例

JSON格式

{
  "Total": 1,
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b9****",
  "ProgramItems": [
    {
      "Index": 1,
      "ResourceType": "vod",
      "ProgramItemId": "c10f3d63-eacf-4fbf-bd48-a07a6ba7****",
      "ProgramId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
      "ProgramItemName": "playlistItem1",
      "ResourceValue": "asdfasdf8as9df8sa9df89****"
    }
  ]
}

错误码

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

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