You need to enable JavaScript to run this app.
导航

创建录像计划

最近更新时间2023.06.27 11:40:49

首次发布时间2023.06.27 11:40:49

创建录像计划。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称CreateRecordPlan
VersionQueryString公共参数,OpenAPI 接口版本2021-01-01

Body 参数

字段
类型
必填
说明
PlanNameString录像计划名称,支持汉字、大小写字母、数字、中划线
DescriptionString录像计划描述
BindTemplateString绑定的录像模板 ID

StreamingIndex

Integer

录制的主子码流编号:

  • 0:主码流

  • 1~n: 子码流

说明:如通过 BindChannels 绑定通道,必须指定主子码流编号

Resolution

String

分辨率编码(可参考 GB28181-2022 协议附录G中的定义):

  • 1(QCIF - 176x144)

  • 2(CIF - 320x288)

  • 3(4CIF - 704x576)

  • 4(D1 - 720x576)

  • 5(720p)

  • 6(1080p/i)

  • WxH:(其它分辨率,自定义宽高,如19201080等,需设备支持)

BindChannels

Object

绑定的通道(通过 {设备国标 ID,通道 ID,主子码流编号} 三元组可唯一确定需要录制的通道)
说明:

  • 需要通过 StreamingIndex 参数指定主子码流编号

  • BindChannels 和 BindStreams 属于并的关系,可以同时指定,也可以指定其中之一

BindStreams

Array of Streams

绑定的视频流 ID 列表(可唯一确定需要录制的通道,通过 ListStreams 接口获取)
说明:BindChannels 和 BindStreams 属于并的关系,可以同时指定,也可以指定其中之一

Status

String

是否启用录像计划:

  • enabled(启用)

  • disabled(禁用)

返回结果

返回参数说明

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

Result 字段包含以下参数:

字段
类型
说明
IDString创建的录像计划唯一 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"
    }
}