创建录像计划--慢直播-火山引擎

文档中心

立即注册

导航

创建录像计划

最近更新时间：2024.02.29 14:55:33首次发布时间：2023.06.27 11:40:49

创建录像计划。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=CreateRecordPlan&Version=2021-01-01

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
PlanName	String	是	`全天计划`	录像计划名称，支持由中文、大小写字母、数字、中划线组成。
Description	String	否	`全天录像`	录像计划描述。
BindTemplate	String	是	`plan01`	绑定的录像模板 ID，通过 ListRecordTemplates 接口获取。
StreamingIndex	Integer	否	`0`	录制的主子码流编号，取值及含义如下所示。 0：主码流； 1~n: 子码流。说明如需通过 {设备国标 ID，通道 ID，主子码流编号} 三元组增加绑定的通道，必须指定主子码流编号。
Resolution	String	否	`3`	分辨率编码（可参考 GB28181-2022 协议附录G中的定义）： 1（QCIF - 176x144） 2（CIF - 320x288) 3（4CIF - 704x576) 4（D1 - 720x576) 5（720p) 6（1080p/i) WxH：（其它分辨率，自定义宽高，如19201080等，需设备支持）
BindChannels	JSON Map	是	`-`	绑定的通道（通过 {设备国标 ID，通道 ID，主子码流编号} 三元组可唯一确定需要录制的通道）。说明需要通过 StreamingIndex 参数指定主子码流编号 BindChannels 和 BindStreams 属于并的关系，可以同时指定，也可以指定其中之一
BindStreams	Array of String	否	`["3a890d3f-6db4-4663-a5a6-9abf06xxxxxx","3a890d3f-6db4-4663-a5a6-9abf06xxxxxx"]`	绑定的视频流 ID 列表（可唯一确定需要录制的通道，通过 ListStreams 接口获取）。说明 BindChannels 和 BindStreams 属于并的关系，可以同时指定，也可以指定其中之一。
Status	String	是	`enabled`	是否启用录像计划，取值及含义如下所示。 enabled：启用； disabled：禁用。
MainStreams	Array of String	否	`["524c804d-0149-4b58-8209-2f17f6xxxxxx"]`	绑定的视频主码流流 ID 列表（可结合Resolution/StreamingIndex唯一确定需要录制的通道，通过 ListStreams 接口获取）。说明 BindChannels 和 BindStreams 属于并的关系，可以同时指定，也可以指定其中之一。

返回参数

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

参数	类型	示例值	描述
ID	String	`plan0xxxx`	创建的录像计划唯一 ID，凭借该 ID 可以编辑录像计划、查询录像计划信息、删除录像计划。

请求示例

POST https://open.volcengineapi.com?Action=CreateRecordPlan&Version=2021-01-01

{
    "PlanName": "全天计划",
    "Description": "全天录像",
    "BindTemplate": "plan01",
    "StreamingIndex": 0,
    "Resolution": "3",
    "BindChannels": {
        "34020009991320xxxxxx": [
            {
                "ChannelID": "9888000xxxxxx0000000"
            }
        ]
    },
    "BindStreams": [
        "3a890d3f-6db4-4663-a5a6-9abf06xxxxxx",
        "3a890d3f-6db4-4663-a5a6-9abf06xxxxxx"
    ],
    "Status": "enabled"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202209141449260102020891370D037571",
        "Action": "CreateRecordPlan",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "plan0xxxx"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。