查询模板占用--慢直播-火山引擎

文档中心

立即注册

导航

查询模板占用

最近更新时间：2022.08.19 18:13:44首次发布时间：2022.08.19 18:13:44

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

请求方式

使用 GET 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	CheckBindTemplate
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
TemplateID	Query	String	是	模板 ID	模板 ID，可通过调用 ListScreenshotTemplates、ListRecordTemplates、或 ListAITemplates 接口获取
TemplateType	Query	String	是	模板类型	可选枚举值包括： screenshot（截图模板） record（录制模板） ai（AI 模板）
SpaceID	Query	String	否	空间 ID	可通过调用 ListSpaces 接口获取

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
Spaces	Array of objects	查询到的空间列表，参考 GetSpace 接口的返回结果说明

示例

请求示例

GET https://open.volcengineapi.com?Action=CheckBindTemplate
&Version=2021-01-01
&TemplateID=1c443146-8d6a-44d5-baf8-5efafcxxxxxx
&TemplateType=ai
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202207291529570102120522060246226F",
        "Action": "CheckBindTemplate",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "Spaces": [
            {
                "SpaceName": "test-bug",
                "Description": "测试bug",
                "SpaceID": "3c207531-6c25-43bf-a192-0011e7xxxxxx",
                "Region": "cn-beijing-a",
                "AccessType": "gb28181",
                "Status": "enabled",
                "GB": {
                    "PullOnDemand": false
                },
                "HLSLowLatency": false,
                "CreatedAt": "2022-01-19T19:31:51+08:00",
                "UpdatedAt": "2022-01-19T19:31:51+08:00",
                "Domains": {
                    "yuxckgcfaxxxxxxx$pull$xxxxxx$com": {
                        "Domain": "yuxckgcfaxxxxxxx.pull.xxxxxx.com",
                        "Type": "fcdn-pull",
                        "Status": "enabled",
                        "CNAME": "yuxckgcfaxxxxxxx.pull.xxxxxx.com.c.xxxxx.com",
                        "CNAMEStatus": "",
                        "Default": true,
                        "Https": {
                            "Enable": false,
                            "CertificateID": ""
                        },
                        "CreatedAt": "2022-01-19T19:31:44+08:00",
                        "UpdatedAt": "",
                        "TimeFlag": false,
                        "MainKey": "",
                        "SpareKey": "",
                        "ValidDuration": 0
                    }
                },
                "SipServer": {
                    "SipId": "34020000002xxxxxxxxx",
                    "SipDomain": "xxx.xxx.xxx.xx",
                    "SipIp": "xxx.xxx.xxx.xx",
                    "SipPort": {
                        "tcp": 5060,
                        "udp": 5060
                    }
                },
                "CallbackURL": "",
                "Template": {
                    "Screenshot": {
                        "TemplateID": "",
                        "TemplateName": "",
                        "BindTime": ""
                    },
                    "Record": {
                        "TemplateID": "",
                        "TemplateName": "",
                        "BindTime": ""
                    },
                    "AI": {
                        "TemplateID": "1c443146-8d6a-44d5-baf8-5efafcxxxxxx",
                        "TemplateName": "",
                        "BindTime": "2022-05-11T12:12:51+08:00"
                    }
                }
            }
        ]
    }
}