创建轮播任务--慢直播-火山引擎

文档中心

立即注册

导航

创建轮播任务

最近更新时间：2023.05.22 16:16:31首次发布时间：2023.05.22 16:16:31

创建轮播任务。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考「公共参数」。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	CreateStreamPollingTask
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01

Body 参数

字段	类型	必填	说明
TaskName	String	是	轮播任务名称，支持汉字、大小写字母、数字、中划线
TimeInterval	Int	是	轮播时间间隔，单位：秒，取值范围 [30,600]
WindowCount	Int	是	分屏窗口数量： 1（单分屏） 4（四分屏） 9（九分屏） 16（十六分屏）
Streams	Array of streams	是	绑定通道 ID 列表

返回结果

返回参数说明

通用返回参数，请参考 ResponseMetadata 结构体说明。

Result 字段包含以下参数：

字段	类型	说明
ID	String	创建成功的轮播任务 ID

示例

请求示例

POST https://open.volcengineapi.com?Action=CreateStreamPollingTask
&Version=2021-01-01
&<公共请求参数>
{
  "TaskName": "stream-polling-01", 
  "TimeInterval": 60,
  "WindowCount": 1,
  "Streams": ["13edb5df-aeb5-4bc9-a98a-9a3c5exxxxxx,e10ff636-04d7-4a89-95aa-c94af5xxxxxx"]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202305181059241D7344A326EDED0C5408",
        "Action": "CreateStreamPollingTask",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "92a7a136-ca9b-4bea-83ba-be754axxxxxx"
    }
}