查询模板列表。
调试
您可以在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 |
| PageSize | long | 否 | 分页大小，默认为 20。 | 20 |
| PageNum | long | 否 | 第几个分页，默认为 1。 | 1 |
返回参数
示例
正常返回示例
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"
}
]
}
]
}错误码
访问错误中心查看更多错误码。