ListCarouselTask - 查询轮播任务列表--视频直播-火山引擎

文档中心

立即注册

导航

视频直播

ListCarouselTask - 查询轮播任务列表

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

调用 ListCarouselTask 接口获取当前所有轮播任务的列表，包括任务 ID、状态及创建时间，可用于任务管理及批量查询。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
Page	Integer	是	`1`	查询数据的页码。
PageSize	Integer	是	`30`	每页显示的数据条数，最大值为 1000。

返回参数

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

参数	类型	示例值	描述
Data	Object of Data	`-`	轮播任务数据对象。

Data

参数	类型	示例值	描述
Count	Integer	`29`	满足查询条件的轮播任务总数。
Result	Array of Result	`-`	轮播任务的数组，每个元素表示一个任务的详细信息。

Result

参数	类型	示例值	描述
CreatedAt	Object of CreatedAt	`{"Time":"2023-03-15T08:00:00+08:00"}`	任务的创建时间，RFC3339 格式的时间戳，精度为秒。
Name	String	`轮播测试`	轮播任务名称。
Status	String	`running`	轮播任务的当前状态。取值和含义如下： `pending`：任务等待调度中； `prepare`：任务初始化中； `running`：任务运行中； `prestop`：任务停止中； `done`：任务已经停止。
StoppedAt	Object of StoppedAt	`{"Time":"2023-03-16T08:00:00+08:00"}`	任务的结束时间，RFC3339 格式的时间戳，精度为秒。
TaskID	String	`e1fb009334fc5b16`	轮播任务的唯一标识。
UpdatedAt	Object of UpdatedAt	`{"Time":"2023-03-15T10:00:00+08:00"}`	任务的更新时间，RFC3339 格式的时间戳，精度为秒。

CreatedAt

参数	类型	示例值	描述
Time	String	`2024-10-30T15:25:07+08:00`	任务的创建时间，RFC3339 格式的时间戳，精度为秒。

StoppedAt

参数	类型	示例值	描述
Time	String	`0001-01-01T00:00:00Z`	任务的结束时间，RFC3339 格式的时间戳，精度为秒。

UpdatedAt

参数	类型	示例值	描述
Time	String	`2024-10-30T15:25:08+08:00`	任务的更新时间，RFC3339 格式的时间戳，精度为秒。

请求示例

POST https://live.volcengineapi.com?Action=ListCarouselTask&Version=2023-01-01
{
    "Page": 0,
    "PageSize": 10
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "202410301540353C34785110C816119A9E",
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListCarouselTask",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "Data": {
            "Count": 29,
            "Result": [
                {
                    "CreatedAt": {
                        "Time": "2024-10-30T15:25:07+08:00"
                    },
                    "Name": "轮播测试",
                    "Status": "running",
                    "StoppedAt": {
                        "Time": "0001-01-01T00:00:00Z"
                    },
                    "TaskID": "c619851e61dcaf85",
                    "UpdatedAt": {
                        "Time": "2024-10-30T15:25:08+08:00"
                    }
                }
            ]
        }
    }
}

错误码

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

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