查询模板列表。
请求参数
参数 | 类型 | 是否必要 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeTemplates | 操作接口名,系统规定参数。取值:DescribeTemplates |
Type | String | 否 | record | 按模板类型查询。 |
InstanceId | String | 否 | 32388487739092998 | 按绑定的实例ID查询。 |
SortBy | String | 否 | id | 按给定字段排序,默认按ID排序。 |
SortDirection | String | 否 | asc | 排序方式,默认升序。取值:asc(升序),desc(降序) |
PageSize | Long | 否 | 20 | 分页大小,默认为20。 |
PageNum | Long | 否 | 1 | 第几个分页,默认为1。 |
返回参数
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageSize | Long | 20 | 分页大小。 |
PageNum | Long | 1 | 第几个分页。 |
PageCount | Long | 5 | 分页总数。 |
TotalCount | Long | 100 | 模板总数。 |
Templates | Template[] | 模板列表。 | |
RequestId | String | BEA5625F-8FCF-48F4-851B-CA63946DA664 | 该条任务请求ID。 |
Template类型
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String | 32388487739092998 | 模板ID。 |
Name | String | 录制模板 | 模板名称。 |
Description | String | 录制模板 | 模板描述。 |
Type | String | record | 模板类型。取值:record(录制),snapshot(截图),transcode(转码),timeshift(时移) |
Region | String | cn-shanghai | OSS所属区域,即服务中心。 |
OssBucket | String | my_oss_bucket | OSS的Bucket。 |
OssEndpoint | String | oss-cn-shanghai.aliyuncs.com | OSS的域名。 |
Interval | Long | 3600 | 操作周期,单位秒。 |
Retention | Long | 3 | (仅限时移模板)时移保存周期,单位天 |
FileFormat | String | mp4 | 存储文件格式,多值用逗号分隔。取值:mp4,flv,hls,jpg |
JpgOverwrite | String | my/oss/path/jpg/{StreamName} | (仅限截图模板)JPG的存储路径,用于覆盖截图。 |
JpgSequence | String | my/oss/path/jpg/{StreamName} | (仅限截图模板)JPG的存储路径,用于序列截图。 |
JpgOnDemand | String | my/oss/path/jpg/ondemand-{StreamName} | (仅限截图模板)JPG的存储路径,用于按需截图。 |
Mp4 | String | my/oss/path/mp4/{StreamName}/{EscapedStartTime}_{EscapedEndTime} | (仅限录制模板)MP4的存储路径。 |
Flv | String | my/oss/path/f'lv/{StreamName}/{EscapedStartTime}_{EscapedEndTime} | (仅限录制模板)FLV的存储路径。 |
HlsM3u8 | String | my/oss/path/m3u8/{StreamName}/{EscapedStartTime}_{EscapedEndTime} | (仅限录制模板)HLS的存储路径,m3u8文件。 |
HlsTs | String | my/oss/path/ts/{StreamName}/{EscapedStartTime}_{EscapedEndTime} | (仅限录制模板)HLS的存储路径,ts文件。 |
Trigger | String | auto | (仅限录制模板)模板触发类型。取值:auto(自动),ondemand(按需) |
Callback | String | http://xxx/callback | 模板执行后的回调。 |
CreatedTime | String | 2018-12-10T21:00:00Z | 模板创建时间。 |
TransConfigs | TransConfig[] | (仅限转码模板)转码配置列表 | |
RequestId | String | BEA5625F-8FCF-48F4-851B-CA63946DA664 | 该条任务请求ID。 |
TransConfig类型
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String | 600001-cn-shanghai | 转码配置ID |
Name | String | sd | 转码规则名称,取值:转码规则名称将作为转码流后缀,建议按使用习惯设置为sd,200k等易辨识后缀,只支持数字和字母 |
VideoCodec | String | h264 | 视频编码 |
VideoBitrate | Long | 800 | 视频比特率,单位kbps |
Fps | Long | 25 | 视频帧率,单位fps |
Gop | Long | 50 | 视频Gop,单位帧 |
Height | Long | 640 | 视频高度 |
Width | Long | 1280 | 视频宽度 |
示例
请求示例
http://vs.aliyuncs.com?Action=DescribeTemplates&<公共请求参数>
返回示例
{
"RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
"Templates": [
{
"Id": "32388487739092998 ",
"Name": "录制模板",
"Description": "录制模板",
"Type": "record",
"Region": "cn-shanghai",
"OssBucket": "my_oss_bucket",
"OssEndpoint": "oss-cn-shanghai.aliyuncs.com",
"Interval": 3600,
"FileFormat": "mp4",
"Mp4": "my/oss/path/mp4/{StreamName}/{EscapedStartTime}_{EscapedEndTime}",
"Callback": "http://xxx/callback",
"CreatedTime": "2018-12-10T21:00:00Z"
}
]
}
在文档使用中是否遇到以下问题
更多建议
匿名提交