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

查询录制配置列表

最近更新时间：2023.11.13 13:47:54

首次发布时间：2023.09.25 14:34:04

我的收藏

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

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

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

Type

String

否

tos

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

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

返回参数

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

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

PresetList

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

SlicePresetV2

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

RecordPresetConfig

参数类型示例值描述

TranscodeRecord

Integer

1

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

  • 0：不录制；
  • 1：录制。
  • 2：全部录制，如果录制转码流后缀列表（TranscodeSuffixList）为空则全部录制，不为空则录制 TranscodeSuffixList 命中的转码后缀。

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 录制时设置。
TranscodeSuffixListArray of String["_hd"]录制转码流后缀列表，转码流录制配置为全部录制时（TranscodeRecord 配置等于 2）生效。

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，对于存储在点播的录制文件，会使用该工作流模版对视频进行处理。
ClassificationIDInteger12***45直播录制文件存储到点播时的视频分类 ID。
StorageClassInteger1直播录制文件存储到点播时的存储类型。支持的取值及含义如下所示。
ExactObjectStringrecord/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime}录制文件的存储位置。默认存储位置格式为 record/{PubDomain}/{App}/{Stream}/{StartTime}_{EndTime}。

示例

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220726*******************051B513A",
        "Action": "ListVhostRecordPresetV2",
        "Version": "2023-01-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}" 
									      }
										}
								}
						}
        }
    ]
}

错误码

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

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
403RequestForbidden-请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误，请联系技术支持。
500InternalError.Presetan internal error related to preset occurred, please contact the administrator.出现与功能配置相关的内部错误，请联系技术支持。
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时，请联系技术支持。