GetCarouselDetail - 查询轮播任务--视频直播-火山引擎

文档中心

立即注册

导航

GetCarouselDetail - 查询轮播任务

最近更新时间：2025.04.09 11:15:30首次发布时间：2025.04.03 18:21:33

调用 GetCarouselDetail 接口查询指定轮播任务的详细信息，包括播放状态、视频列表及当前播放进度，便于管理和监控任务执行情况。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=GetCarouselDetail&Version=2023-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetCarouselDetail`	接口名称。当前 API 的名称为 `GetCarouselDetail`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
TaskID	String	是	`44c5da50318440*********2d62c910b8`	待查询的轮播任务 ID，任务的唯一标识。调用 `CreateCarouselTask` 接口创建轮播任务时返回。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	描述
Data	Object of Data		包含轮播任务相关信息的数据对象。

Data

参数	类型	示例值	描述
LastOperationIndex	Integer	`1`	最新的播放列表修改序列号，每次成调用 `UpdateCarouselTask` 接口更新任务，此值都会加 `1`。
LastSuccessOperationIndex	Integer	`1`	当前实际生效的播放列表序列号，表示任务目前按照该版本的素材列表在播放。
Rule	String	{"Loop":1,"Mode":1,"Output":{"Audio":{"BitRate":144000,"ChannelLayout":"stereo","SampleRate":44100},"Url":["rtmp://push-rtmp-f5.douyincdn.com/zebraedit/dev-114203018399843854?expire=1729119100&sign=a1b23eb99a26816a5db20a1ec4b314cb&volcSecret=a1b23eb99a26816a5db20a1ec4b314cb&volcTime=1729119100"],"Video":{"BitRate":8000000,"Codec":"h264","FrameRate":30,"GOP":2,"Height":1080,"Preset":"faster","Width":1920}},"PlayTime":1,"Source":[{"ID":"1","Type":"vod","Url":"https://tosv.byted.org/obj/fcdn-engine-001/test/douyin_D_90sTVC_1Mbps.mp4"},{"ID":"2","Type":"vod","Url":"https://tosv.byted.org/obj/fcdn-engine-001/test/111.mp4"}]}	轮播任务的播放规则，以下是部分关键参数： `Loop`：是否循环播放，及其循环次数。 `Mode`：播放模式（普通模式/转码模式）。 `Output`：推流参数，包括 `Audio`（音频参数）、`Video`（视频参数）和 `Url`（推流地址）。 `Source`：轮播素材列表，包括每个素材的 `ID`、`Type`（类型，如 `vod`）、`Url`（播放地址）等信息。
PlayInfo	String	`{"Loop":1,"SourceID":"2","SourceLoop":1,"SourceSeek":910}`	当前播放或最后一次播放的素材信息，以 JSON 字符串的形式返回。此字段包含素材的详细信息，例如素材名称、播放位置等，便于用户获取播放相关的具体数据。
Status	String	`running`	任务的当前状态。支持以下取值： `pending`：任务等待调度中； `prepare`：任务初始化中； `running`：任务运行中； `prestop`：任务停止中； `done`：任务已经停止。该字段用于指示任务生命周期中的当前阶段，通常用于监控或查询任务执行的进展情况。

请求示例

POST https://live.volcengineapi.com?Action=GetCarouselDetail&Version=2023-01-01
{
    "TaskID": "fc03709348ca6db8"
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "202410301535298CE0D4E0152CAF10A8AC",
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetCarouselDetail",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "Data": {
            "LastOperationIndex": 1,
            "LastSuccessOperationIndex": 1,
            "PlayInfo": "{\"Loop\":1,\"SourceID\":\"2\",\"SourceLoop\":1,\"SourceSeek\":910}",
            "Rule": "{\"Loop\":1,\"Mode\":1,\"Output\":{\"Audio\":{\"BitRate\":144000,\"ChannelLayout\":\"stereo\",\"SampleRate\":44100},\"Url\":[\"rtmp://push-rtmp-f5.douyincdn.com/zebraedit/dev-114203018399843854?expire=1729119100&sign=a1b23eb99a26816a5db20a1ec4b314cb&volcSecret=a1b23eb99a26816a5db20a1ec4b314cb&volcTime=1729119100\"],\"Video\":{\"BitRate\":8000000,\"Codec\":\"h264\",\"FrameRate\":30,\"GOP\":2,\"Height\":1080,\"Preset\":\"faster\",\"Width\":1920}},\"PlayTime\":1,\"Source\":[{\"ID\":\"1\",\"Type\":\"vod\",\"Url\":\"https://tosv.byted.org/obj/fcdn-engine-001/test/douyin_D_90sTVC_1Mbps.mp4\"},{\"ID\":\"2\",\"Type\":\"vod\",\"Url\":\"https://tosv.byted.org/obj/fcdn-engine-001/test/111.mp4\"}]}",
            "Status": "running"
        }
    }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码	错误码	错误信息	说明
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。