模板列表--慢直播-火山引擎

文档中心

立即注册

导航

模板列表

最近更新时间：2022.02.08 14:17:44首次发布时间：2021.11.25 17:21:02

查看指定空间配置的模板信息。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	GetSpaceTemplate
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
SpaceID	Query	String	是	空间 ID	可通过调用 ListSpaces 接口获取

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
Screenshot	Template	查询到的截图模板信息，参考以下 Template 数据结构说明
Record	Template	查询到的录制模板信息，参考以下 Template 数据结构说明
AI	Template	查询到的 AI 模板信息，参考以下 Template 数据结构说明

Template 数据结构说明

字段	类型	说明
TemplateID	String	模板 ID（未配置时为空）
TemplateName	String	模板名称（未配置时为空）
BindTime	String	模板配置时间

示例

请求示例

GET https://open.volcengineapi.com?Action=GetSpaceTemplate
&Version=2021-01-01
&SpaceID=517ff7ec-7700-4862-b1e7-7967a4xxxxxx
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202202071713300102111730980E036D50",
        "Action": "GetSpaceTemplate",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "Screenshot": {
            "TemplateID": "af991af9-fb07-4773-9ed1-c58e5b90a810",
            "TemplateName": "hyzsnap01",
            "BindTime": "2022-02-07T17:13:04+08:00"
        },
        "Record": {
            "TemplateID": "535aa5e6-3388-42e9-bd7d-a1ee6616040c",
            "TemplateName": "hyzrecord01",
            "BindTime": "2022-02-07T17:13:23+08:00"
        },
        "AI": {
            "TemplateID": "1c443146-8d6a-44d5-baf8-5efafc0e7275",
            "TemplateName": "car0121",
            "BindTime": "2022-02-07T17:12:39+08:00"
        }
    }
}