You need to enable JavaScript to run this app.
导航
查看录制模板
最近更新时间:2022.02.08 14:18:34首次发布时间:2021.11.25 17:22:10

查询指定录制模板的详细信息。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称GetRecordTemplate
VersionQueryString公共参数,OpenAPI 接口版本2021-01-01
TemplateIDQueryString模板 ID可通过调用 ListRecordTemplates 接口获取

返回结果

返回参数说明

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

Result 字段包含以下参数:

字段
类型
说明
TemplateNameString模板名称
TemplateIDString模板 ID
RecordArray of objects录制配置,参考以下 录制配置结构说明
TemplateTypeString模板类型
CreatedAtTimestamp模板创建时间
UpdatedAtTimestamp模板更新时间

录制配置结构说明

字段
类型
说明
RecordDurationInteger单个视频文件录制时长,单位毫秒

Type

String

录制方式:

  • realtime(实时录制)

Format

String

视频存储格式:

  • mp4
  • hls

示例

请求示例

GET https://open.volcengineapi.com?Action=GetRecordTemplate
&Version=2021-01-01
&TemplateID=535aa5e6-3388-42e9-bd7d-a1ee6616040c
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021120909544301021001802624007F92",
        "Action": "GetRecordTemplate",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "TemplateID": "535aa5e6-3388-42e9-bd7d-a1ee6616040c",
        "TemplateName": "hyzrecord01",
        "TemplateType": "record",
        "Record": {
            "RecordDuration": 600000,
            "Type": "realtime",
            "Format": "mp4"
        },
        "CreatedAt": "2021-11-11T14:56:08+08:00",
        "UpdatedAt": "2021-11-22T18:18:27+08:00"
    }
}