You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

查询录制配置列表

最近更新时间：2023.10.12 17:39:58

首次发布时间：2022.04.19 20:40:35

我的收藏

根据域名下所有的应用名称，查询与各应用关联的录制模板。

说明

该接口属于历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版查询录制配置列表接口。

注意事项

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

请求说明

  • 请求方式：POST
  • 请求地址：https://live.volcengineapi.com?Action=ListVhostRecordPresetV2&Version=2020-08-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是ListVhostRecordPresetV2接口名称。当前 API 的名称为 ListVhostRecordPresetV2。
VersionString是2020-08-01接口版本。当前 API 的版本为 2020-08-01。

Body

参数类型是否必选示例值描述
VhostString是push.example.com域名空间名称

Type

String

否

tos

直播录制的存储类型。默认值为 tos，支持以下取值。

  • vod：录制文件存在 VOD；
  • tos：录制文件存在 TOS。

返回参数

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

参数类型示例值描述
PresetListArray of PresetList-录制模板列表

PresetList

参数类型示例值描述
VhostStringpush.example.com域名空间名称
AppStringlive应用名称
StreamStringstream001流名称
SlicePresetObject of SlicePreset-模板详细信息

SlicePreset

参数类型示例值描述
IDInteger8模板 ID
NameStringRecordPresetexample模板名称
RecordPresetConfigObject of RecordPresetConfig-录制模板详细配置

RecordPresetConfig

参数类型示例值描述

TranscodeRecord

Integer

1

转码流录制，默认值为 0。支持的取值如下所示。

  • 0：不录制；
  • 1：录制。

OriginRecord

Integer

1

源流录制，默认值为 0。支持的取值如下所示。

  • 0：不录制；
  • 1：录制。
SliceDurationInteger5录制 HLS 格式时，单个 TS 切片时长，单位为 s，默认值为 5，取值范围为 [5,30]
FlvParamObject of RecordParam-FLV 录制参数，开启 FLV 录制时设置
HlsParamObject of RecordParam-HLS 录制参数，开启 HLS 录制时设置
Mp4ParamObject of RecordParam-MP4 录制参数，开启 MP4 录制时设置

RecordParam

参数类型示例值描述

Enable

Boolean

true

当前格式的录制是否开启，默认 false，取值及含义如下所示。

  • false：不开启；
  • true：开启。
DurationInteger7200断流录制单文件录制时长，单位为 s，默认值为 7200，取值范围为 [300,86400]
RealtimeRecordDurationInteger7200实时录制文件时长，单位为 s，取值范围为 [300,21600]

Splice

Integer

0

断流拼接间隔时长，对实时录制无效，单位为 s，默认值为 0。支持的取值如下所示。

  • -1：一直拼接；
  • 0：不拼接；
  • 大于0：断流拼接时间间隔，对 HLS 录制生效。
TOSParamObject of TOSParam-TOS 存储相关配置
VODParamObject of VODParam-VOD 存储相关配置

TOSParam

参数类型示例值描述

Enable

Boolean

true

是否使用 TOS 存储，默认为 false，取值及含义如下所示。

  • false：不使用；
  • true：使用。
BucketStringlive-test-tos-exampleTOS 存储空间，一般使用 CDN 对应的 Bucket
StorageDirString/TOS 存储目录，默认为空
ExactObjectStringrecord/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime}录制文件的存储位置。存储路径为 record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime}

VODParam

参数类型示例值描述

Enable

Boolean

true

是否使用 VOD 存储，默认为 false，取值及含义如下所示。

  • false：不使用；
  • true：使用。
VodNamespaceStringSnapShot视频点播（VOD）空间名称
WorkflowIDString25524a2d*********891d7daf4b9工作流模版 ID，对于存储在点播的录制文件，会使用该工作流模版对视频进行处理
ClassificationIDString23**41直播录制文件存储到点播时的视频分类 ID。
StorageClassInteger1直播录制文件存储到点播时的存储类型。支持的取值及含义如下所示。
ExactObjectStringrecord/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime}录制文件的存储位置。默认存储位置为 record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime}

示例

请求示例

POST https://live.volcengineapi.com?Action=ListVhostRecordPresetV2&Version=2020-08-01
{
  "Vhost": "push.example.com"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220726*******************051B513A",
        "Action": "ListVhostRecordPresetV2",
        "Version": "2020-08-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
        "PresetList": [{
            "Vhost": "push.example.com",
            "App": "live",
            "SlicePreset": {
		            "ID": 8,
                "Name": "RecordPresetexample",               
                "RecordPresetConfig": { 
										"OriginRecord": 1,  
										"HlsParam": { 
												"Enable": "true",
												"RealtimeRecordDuration": 7200, 
								        "Splice": 0 
								        "TOSParam": { 
										        "Enable": true, 
										        "Bucket": "live-test-tos-example", 
										        "StorageDir": "", 
										        "RecordObject": "record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime}" 
									      },
										}
								}
						}
        }
    ]
}

错误码

访问公共错误码获取详细信息。