云点播获取轮播播单列表-轮播相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： vod.tencentcloudapi.com 。

该接口用于获取轮播播单列表。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeRoundPlays。
Version	是	String	公共参数，本接口取值：2018-07-17。
Region	否	String	公共参数，此参数为可选参数。
SubAppId	否	Integer	点播应用 ID。从2023年12月25日起开通点播的客户，如访问点播应用中的资源（无论是默认应用还是新创建的应用），必须将该字段填写为应用 ID。示例值：1490012345
RoundPlayIds.N	否	Array of String	过滤条件：轮播播单标识，数组长度限制：100。示例值：["1234"]
Status	否	String	过滤条件，轮播播单状态，可选值： Enabled：启动状态； Disabled：停止状态。示例值：Enabled
CreateTime	否	TimeRange	过滤条件：轮播播单创建时间。示例值：1
UpdateTime	否	TimeRange	过滤条件：轮播播单更新时间。
ScrollToken	否	String	翻页标识，分批拉取时使用：当单次请求无法拉取所有数据，接口将会返回 ScrollToken，下一次请求携带该 Token，将会从下一条记录开始获取。
Offset	否	Integer	分页偏移量，默认值：0。已经废弃，请根据 ScrollToken 参数进行分批次查询。示例值：0
Limit	否	Integer	返回记录条数，默认值：10，最大值：100。示例值：1

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合过滤条件的轮播播单总数。已经废弃，分批次查询请请使用 ScrollToken 参数。示例值：100
RoundPlaySet	Array of RoundPlayInfo	轮播播单详情列表。
ScrollToken	String	翻页标识，当请求未返回所有数据，该字段表示下一条记录的 ID。当该字段为空，说明已无更多数据。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取轮播播单列表

获取所有轮播播单的播单列表、名称、描述等详细信息。

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRoundPlays
<公共请求参数>

{}

输出示例

{
    "Response": {
        "TotalCount": 0,
        "RequestId": "6xxxxe3a-6b8e-4b4e-9256-fdc700064ef3",
        "RoundPlaySet": [
            {
                "Name": "Demo",
                "RoundPlayId": "bffb15f07530b57bc1aabb01fac74bca",
                "StartTime": "2022-06-01T00:00:00+08:00",
                "Desc": "Demo",
                "Url": "http://123.vod-qcloud.com/rplay/v1/xxxx/playlist.m3u8",
                "Status": "Enabled",
                "PlayBackMode": "Loop",
                "RoundPlaylist": [
                    {
                        "ItemId": "a01",
                        "AudioVideoType": "Transcode",
                        "Definition": 100,
                        "FileId": "528xxx5487985271487"
                    }
                ]
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
ResourceNotFound	资源不存在。

获取轮播播单列表

本页目录：