调用DescribeTemplates查询模板列表_视图计算(VECS)-阿里云帮助中心

查询模板列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vs:DescribeTemplates	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
Id	string	否	模板 ID	323434****83423432
Type	string	否	按模板类型查询。	record
InstanceId	string	否	按绑定的实例 ID 查询。	323*****998-cn-qingdao
SortBy	string	否	按给定字段排序，默认按 ID 排序。	id
SortDirection	string	否	排序方式，默认升序。取值： asc（升序） desc（降序）	asc
PageSize	long	否	分页大小，默认为 20。	20
PageNum	long	否	第几个分页，默认为 1。	1

返回参数

名称	类型	描述	示例值
	object
PageNum	long	第几个分页。	1
PageSize	long	分页大小。	20
RequestId	string	请求 ID。	F3F88C96-CA6E-573E-B8F7-5BE83A1A0BCF
TotalCount	long	模板总数。	100
PageCount	long	分页总数。	5
Templates	array<object>	模板列表。
Template	object
Type	string	模板类型。取值： record（录制） snapshot（截图） transcode（转码） timeshift（时移）	record
Trigger	string	模板触发类型。取值： auto（自动） ondemand（按需）说明仅限录制模板。	auto
OssFilePrefix	string	OSS 文件前缀。	my_prefix
HlsTs	string	HLS 的存储路径，ts 文件。说明仅限录制模板。	osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}
Mp4	string	MP4 的存储路径。说明仅限录制模板。	osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}
JpgOnDemand	string	JPG 的存储路径，用于按需截图。说明仅限截图模板。	osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg
OssBucket	string	OSS 的 Bucket。	my_oss_bucket
JpgSequence	string	JPG 的存储路径，用于序列截图。说明仅限截图模板。	osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg
JpgOverwrite	string	JPG 的存储路径，用于覆盖截图。说明仅限截图模板。	osspath/snapshot/{AppName}/{StreamName}.jpg
FileFormat	string	存储文件格式，多值用逗号分隔。取值：mp4,flv,hls,jpg	hls
Callback	string	模板执行后的回调。	http://example.com/callback
Interval	long	操作周期，单位：秒。	3600
Description	string	模板描述。	录制模板
Region	string	OSS 所属区域，即服务中心。	cn-qingdao
Retention	long	时移保存周期，单位：天说明仅限时移模板。	3
HlsM3u8	string	HLS 的存储路径，m3u8 文件。说明仅限录制模板。	osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}
Flv	string	FLV 的存储路径。说明仅限录制模板。	osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}
Name	string	模板名称。	录制模板
CreatedTime	string	模板创建时间。	2018-12-10T10:00:00Z
OssEndpoint	string	OSS 的域名。	oss-cn-qingdao.aliyuncs.com
Id	string	模板 ID。	323*****998-cn-qingdao
TransConfigs	array<object>	转码配置列表。说明仅限转码模板。
TransConfig	object
Gop	long	视频 Gop，单位：帧	50
Width	long	视频宽度	1280
VideoBitrate	long	视频比特率，单位：kbps	800
Height	long	视频高度	720
VideoCodec	string	视频编码	h264
Fps	long	视频帧率，单位：fps	25
Name	string	转码规则名称，转码规则名称将作为转码流后缀，建议按使用习惯设置为 sd，200k 等易辨识后缀，只支持数字和字母	sd
id	string	转码配置 ID。	399788187729597430-cn-qingdao

示例

正常返回示例

JSON格式

{
  "PageNum": 1,
  "PageSize": 20,
  "RequestId": "F3F88C96-CA6E-573E-B8F7-5BE83A1A0BCF",
  "TotalCount": 100,
  "PageCount": 5,
  "Templates": [
    {
      "Type": "record",
      "Trigger": "auto",
      "OssFilePrefix": "my_prefix",
      "HlsTs": "osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}",
      "Mp4": "osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}",
      "JpgOnDemand": "osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg",
      "OssBucket": "my_oss_bucket",
      "JpgSequence": "osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg",
      "JpgOverwrite": "osspath/snapshot/{AppName}/{StreamName}.jpg",
      "FileFormat": "hls",
      "Callback": "http://example.com/callback",
      "Interval": 3600,
      "Description": "录制模板",
      "Region": "cn-qingdao",
      "Retention": 3,
      "HlsM3u8": "osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}",
      "Flv": "osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}",
      "Name": "录制模板",
      "CreatedTime": "2018-12-10T10:00:00Z",
      "OssEndpoint": "oss-cn-qingdao.aliyuncs.com",
      "Id": "323*****998-cn-qingdao",
      "TransConfigs": [
        {
          "Gop": 50,
          "Width": 1280,
          "VideoBitrate": 800,
          "Height": 720,
          "VideoCodec": "h264",
          "Fps": 25,
          "Name": "sd",
          "id": "399788187729597430-cn-qingdao"
        }
      ]
    }
  ]
}

错误码

访问错误中心查看更多错误码。