查詢模板列表。
調試
您可以在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"
}
]
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。