功能介绍
默认接口请求频率限制：500次/秒。
查询录制模板列表。
接口约束
无
URI
GET /v1?
请求参数
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeRecordTemplates | 操作接口名，系统规定参数。 |
| TemplateName | String | 否 | 录制模板 | 根据TemplateName查询。 |
| SortBy | String | 否 | CreatedTime | 选择按一个字段排序，可选值为：CreatedTime、TemplateName，默认为CreatedTime，按照创建时间排序。 |
| SortDirection | String | 否 | asc | 排序方式，默认升序。取值：asc(升序), desc(降序)。 |
| PageNum | Long | 否 | 1 | 第几个分页，默认为1。 |
| PageSize | Long | 否 | 20 | 分页大小，默认为20。取值范围为1～1000 |
返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| PageNum | Long | 第几个分页。 |
| PageSize | Long | 分页大小。 |
| TotalPage | Long | 分页总数。 |
| TotalNum | Long | 模板总数。 |
| RecordTemplates | RecordTemplate[] | 模板列表。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
RecordTemplate
| 参数 | 类型 | 描述 |
|---|---|---|
| TemplateId | String | 模板ID。 |
| Type | String | 模板类型。system：系统预置模板，user：用户模板。系统模板不可修改及删除。 |
| TemplateName | String | 模板名称 |
| Description | String | 模板描述。 |
| RecordType | Long | 是否启用自动录制，默认1。取值：1(自动录制), 2(按需录制) |
| HlsParam | RecordParam | Hls录制参数。 |
| FlvParam | RecordParam | Flv录制参数。 |
| Mp4Param | RecordParam | Mp4录制参数。 |
| CreatedTime | String | 模板创建时间。 |
| UpdatedTime | String | 模板更新时间。 |
RecordParam
| 参数 | 类型 | 描述 |
|---|---|---|
| Enable | Long | 是否开启当前格式录制，默认0。取值: 0(不开启), 1(开启) |
| Interval | Long | 录制间隔，单位秒，默认1800。 |
| StorageTime | Long | 存储时长，单位秒。默认0，0表示永久存储，604800表示一周。 |
| Path | String | 存储路径。默认为{DeviceId}/record/{StartTime}支持的特殊占位符有：{DeviceId}: 设备ID{StartTime}: 文件开始时间 |
示例
请求示例
GET https://vss-dsp-gzgy2-a.ctapi.ctyun.cn/v1?Action=DescribeRecordTemplates
Connection: keep-alive
ctyun-eop-request-id: b8631a0b-f048-499d-aa59-e3767a02b430
Eop-date: 20221025T101738Z
Eop-Authorization: BLLOJSUVKOZ7RVV9VEFF Headers=ctyun-eop-request-id;eop-date Signature=vNXcUBrHYtNgXkHKKYZvV7mdGN2uieKkUCq0zs0gXq0=
Host: vss-dsp-gzgy1-a.ctapi-test.ctyun.cn
User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.14)
返回示例
{
"RecordTemplates": [
{
"TemplateName": "按需5min",
"Description": "",
"RecordType": 2,
"HlsParam": {
"Enable": 1,
"Interval": 300,
"StorageTime": 604800,
"Path": "{DeviceId}/record/{StartTime}"
},
"FlvParam": {
"Enable": 0,
"Interval": 1800,
"StorageTime": 0,
"Path": "{DeviceId}/record/{StartTime}"
},
"Mp4Param": {
"Enable": 0,
"Interval": 1800,
"StorageTime": 0,
"Path": "{DeviceId}/record/{StartTime}"
},
"TemplateId": "448513221306826752",
"CreatedTime": "2022-04-28 18:37:06",
"UpdatedTime": "2022-10-08 10:32:02"
},
{
"TemplateName": "自动录制5min",
"Description": "",
"RecordType": 1,
"HlsParam": {
"Enable": 1,
"Interval": 1800,
"StorageTime": 2592000,
"Path": "{DeviceId}/record/{StartTime}"
},
"FlvParam": {
"Enable": 0,
"Interval": 1800,
"StorageTime": 0,
"Path": "{DeviceId}/record/{StartTime}"
},
"Mp4Param": {
"Enable": 0,
"Interval": 1800,
"StorageTime": 0,
"Path": "{DeviceId}/record/{StartTime}"
},
"TemplateId": "454333958554861568",
"CreatedTime": "2022-05-06 14:50:49",
"UpdatedTime": "2022-05-06 14:50:49"
},
{
"TemplateName": "安全整改自动录制",
"Description": "",
"RecordType": 1,
"HlsParam": {
"Enable": 1,
"Interval": 300,
"StorageTime": 2592000,
"Path": "{DeviceId}/record/{StartTime}"
},
"FlvParam": {
"Enable": 0,
"Interval": 1800,
"StorageTime": 0,
"Path": "{DeviceId}/record/{StartTime}"
},
"Mp4Param": {
"Enable": 0,
"Interval": 1800,
"StorageTime": 0,
"Path": "{DeviceId}/record/{StartTime}"
},
"TemplateId": "526196363508285440",
"CreatedTime": "2022-08-11 10:42:14",
"UpdatedTime": "2022-08-11 10:42:14"
},
{
"TemplateName": "安全整改按需录制",
"Description": "",
"RecordType": 2,
"HlsParam": {
"Enable": 1,
"Interval": 300,
"StorageTime": 2592000,
"Path": "{DeviceId}/record/{StartTime}"
},
"FlvParam": {
"Enable": 0,
"Interval": 1800,
"StorageTime": 0,
"Path": "{DeviceId}/record/{StartTime}"
},
"Mp4Param": {
"Enable": 0,
"Interval": 1800,
"StorageTime": 0,
"Path": "{DeviceId}/record/{StartTime}"
},
"TemplateId": "526196500947238912",
"CreatedTime": "2022-08-11 10:42:30",
"UpdatedTime": "2022-08-11 10:42:30"
},
{
"TemplateName": "录制模板",
"Description": "录制模板",
"RecordType": 1,
"HlsParam": {
"Enable": 0,
"Interval": 1800,
"StorageTime": 0,
"Path": "{DeviceId}/record/{StartTime}"
},
"FlvParam": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"Mp4Param": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"TemplateId": "552265784203067392",
"CreatedTime": "2022-09-15 13:43:34",
"UpdatedTime": "2022-09-15 13:43:34"
},
{
"TemplateName": "senrwo",
"Description": "录制模板修改修改3",
"RecordType": 1,
"HlsParam": {
"Enable": 1,
"Interval": 1800,
"StorageTime": 0,
"Path": "{DeviceId}/record/{StartTime}"
},
"FlvParam": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"Mp4Param": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"TemplateId": "552272072035188736",
"CreatedTime": "2022-09-15 13:55:46",
"UpdatedTime": "2022-09-18 15:37:27"
},
{
"TemplateName": "qswidw",
"Description": "录制模板修改5",
"RecordType": 1,
"HlsParam": {
"Enable": 1,
"Interval": 1800,
"StorageTime": 0,
"Path": "er"
},
"FlvParam": {
"Enable": 1,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"Mp4Param": {
"Enable": 1,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"TemplateId": "552273893101322240",
"CreatedTime": "2022-09-15 13:59:18",
"UpdatedTime": "2022-09-20 14:57:57"
},
{
"TemplateName": "riavct",
"Description": "录制模板",
"RecordType": 1,
"HlsParam": {
"Enable": 0,
"Interval": 1800,
"StorageTime": 20,
"Path": "er"
},
"FlvParam": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"Mp4Param": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"TemplateId": "552281443653877760",
"CreatedTime": "2022-09-15 14:13:57",
"UpdatedTime": "2022-09-15 14:13:57"
},
{
"TemplateName": "gsojad",
"Description": "录制模板",
"RecordType": 1,
"HlsParam": {
"Enable": 1,
"Interval": 1800,
"StorageTime": 77760001,
"Path": "er"
},
"FlvParam": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"Mp4Param": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"TemplateId": "552281924690214912",
"CreatedTime": "2022-09-15 14:14:53",
"UpdatedTime": "2022-09-20 14:54:20"
},
{
"TemplateName": "vkoyul",
"Description": "录制模板",
"RecordType": 1,
"HlsParam": {
"Enable": 0,
"Interval": 1200,
"StorageTime": 0,
"Path": "{DeviceId}/record/{StartTime}"
},
"FlvParam": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"Mp4Param": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"TemplateId": "553013039793717248",
"CreatedTime": "2022-09-16 13:53:26",
"UpdatedTime": "2022-10-14 10:11:06"
},
{
"TemplateName": "irlbmc",
"Description": "录制模板",
"RecordType": 1,
"HlsParam": {
"Enable": 0,
"Interval": 1800,
"StorageTime": 0,
"Path": "{DeviceId}/record/{StartTime}"
},
"FlvParam": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"Mp4Param": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"TemplateId": "553013538009923584",
"CreatedTime": "2022-09-16 13:54:24",
"UpdatedTime": "2022-09-16 13:54:24"
},
{
"TemplateName": "abc",
"Description": "录制模板",
"RecordType": 1,
"HlsParam": {
"Enable": 1,
"Interval": 1800,
"StorageTime": 20,
"Path": "er"
},
"FlvParam": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"Mp4Param": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"TemplateId": "553022626160721920",
"CreatedTime": "2022-09-16 14:12:02",
"UpdatedTime": "2022-09-16 14:12:02"
},
{
"TemplateName": "laoncc",
"Description": "1",
"RecordType": 1,
"HlsParam": {
"Enable": 1,
"Interval": 1800,
"StorageTime": 20,
"Path": "er"
},
"FlvParam": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"Mp4Param": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"TemplateId": "553029747216498688",
"CreatedTime": "2022-09-16 14:25:51",
"UpdatedTime": "2022-09-16 14:25:51"
},
{
"TemplateName": "jdtffp",
"Description": "1",
"RecordType": 1,
"HlsParam": {
"Enable": 1,
"Interval": 1800,
"StorageTime": 20,
"Path": "er"
},
"FlvParam": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"Mp4Param": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"TemplateId": "553030520310611968",
"CreatedTime": "2022-09-16 14:27:21",
"UpdatedTime": "2022-09-16 14:27:21"
},
{
"TemplateName": "jrvrrm",
"Description": "",
"RecordType": 1,
"HlsParam": {
"Enable": 1,
"Interval": 1800,
"StorageTime": 20,
"Path": "er"
},
"FlvParam": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"Mp4Param": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"TemplateId": "553030932627472384",
"CreatedTime": "2022-09-16 14:28:09",
"UpdatedTime": "2022-09-16 14:28:09"
},
{
"TemplateName": "padsaw",
"Description": "录制模板",
"RecordType": 2,
"HlsParam": {
"Enable": 1,
"Interval": 1800,
"StorageTime": 20,
"Path": "er"
},
"FlvParam": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"Mp4Param": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"TemplateId": "553044788191969280",
"CreatedTime": "2022-09-16 14:55:02",
"UpdatedTime": "2022-09-16 14:55:02"
},
{
"TemplateName": "wyvmtq",
"Description": "录制模板",
"RecordType": 1,
"HlsParam": {
"Enable": 1,
"Interval": 1800,
"StorageTime": 20,
"Path": "er"
},
"FlvParam": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"Mp4Param": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"TemplateId": "553046334380195840",
"CreatedTime": "2022-09-16 14:58:02",
"UpdatedTime": "2022-09-16 14:58:02"
},
{
"TemplateName": "srdhbd",
"Description": "",
"RecordType": 1,
"HlsParam": {
"Enable": 1,
"Interval": 1800,
"StorageTime": 20,
"Path": "er"
},
"FlvParam": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"Mp4Param": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"TemplateId": "553049100339134464",
"CreatedTime": "2022-09-16 15:03:24",
"UpdatedTime": "2022-09-16 15:03:24"
},
{
"TemplateName": "pwgrvo",
"Description": "录制模板",
"RecordType": 1,
"HlsParam": {
"Enable": 1,
"Interval": 1800,
"StorageTime": 20,
"Path": "er"
},
"FlvParam": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"Mp4Param": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"TemplateId": "553050165491023872",
"CreatedTime": "2022-09-16 15:05:28",
"UpdatedTime": "2022-09-16 15:05:28"
},
{
"TemplateName": "snskbi",
"Description": "录制模板",
"RecordType": 1,
"HlsParam": {
"Enable": 1,
"Interval": 1800,
"StorageTime": 20,
"Path": "er"
},
"FlvParam": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"Mp4Param": {
"Enable": 0,
"Interval": 0,
"StorageTime": 0,
"Path": ""
},
"TemplateId": "553051050254286848",
"CreatedTime": "2022-09-16 15:07:11",
"UpdatedTime": "2022-09-16 15:07:11"
}
],
"TotalPage": 20,
"TotalNum": 395,
"RequestId": "6dedda070f6c4d4c95ec653e22a23df9",
"PageNum": 1,
"PageSize": 20
}
