創建新模板。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
vs:CreateTemplate | create | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Name | string | 是 | 模板名稱。 | 錄制模板 |
Description | string | 否 | 模板描述。 | 錄制模板 |
Type | string | 是 | 模板類型。取值:
| record |
Region | string | 否 | OSS 所屬區域,即服務中心。 | cn-qingdao |
OssBucket | string | 否 | OSS 的 Bucket。 | bucketname |
OssEndpoint | string | 否 | OSS 的域名。 | oss-cn-qingdao.aliyuncs.com |
OssFilePrefix | string | 否 | OSS 文件前綴 | oss-prefix |
Trigger | string | 否 | 模板觸發類型,默認 auto。取值:
| auto |
Interval | long | 否 | 操作周期,單位秒。 | 3600 |
Retention | long | 否 | 時移保存周期,單位:天 | 3 |
FileFormat | string | 否 | 存儲文件格式,多值用逗號分隔。取值:
說明
青島單元暫不支持 flv、mp4 錄制
| hls |
JpgOverwrite | string | 否 | JPG 的存儲路徑,用于覆蓋截圖。
| osspath/snapshot/{AppName}/{StreamName}.jpg |
JpgSequence | string | 否 | JPG 的存儲路徑,用于序列截圖。
| osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg |
JpgOnDemand | string | 否 | JPG 的存儲路徑,用于按需截圖。
| osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg |
Mp4 | string | 否 | MP4 的存儲路徑。
| osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime} |
Flv | string | 否 | FLV 的存儲路徑。格式參考 Mp4 說明。 | osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime} |
HlsM3u8 | string | 否 | HLS 的存儲路徑,m3u8 文件。格式參考 Mp4 說明。 | osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime} |
HlsTs | string | 否 | HLS 的存儲路徑,ts 文件。
| osspath/record/{StreamName}/{UnixTimestamp}_{Sequence} |
Callback | string | 否 | 模板執行后的回調。 說明
注: 按需觸發的模板不支持回調參數。
| http://example.com/callback |
TransConfigsJSON | string | 否 | 轉碼配置 TransConfig 類型的數組,JSON 格式字符串 | [{"Fps":25,"Gop":50,"Height":720,"VideoCodec":"h264","Width":1280,"Name":"sd","VideoBitrate":800}] |
返回參數
示例
正常返回示例
JSON
格式
{
"Id": "399*****735-cn-qingdao",
"RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。