列出合格模板,支援根據模板狀態、建立來源等資訊查詢。
介面說明
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ice:ListTemplates |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| PageNo |
integer |
否 |
當前頁碼。預設值為 1。 |
1 |
| PageSize |
integer |
否 |
分頁大小,每頁顯示條數。預設值為 20,最大值為 100。 |
20 |
| Type |
string |
否 |
模板類型。 枚舉值:
|
Timeline |
| Status |
string |
否 |
模板狀態。 枚舉值:
|
Available |
| CreateSource |
string |
否 |
建立來源。 枚舉值:
|
OpenAPI |
| Keyword |
string |
否 |
搜尋關鍵詞,可以根據模板 ID 和 title 搜尋。 |
****20b48fb04483915d4f2cd8ac**** |
| SortType |
string |
否 |
排序參數,預設根據建立時間倒序。 枚舉值:
|
CreationTime:Desc |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回參數。 |
||
| RequestId |
string |
請求 ID。 |
******11-DB8D-4A9A-875B-275798****** |
| TotalCount |
integer |
本次請求條件下的資料總量。 |
100 |
| Templates |
array<object> |
模板列表。 |
|
|
object |
模板資訊。 |
||
| TemplateId |
string |
模板 ID。 |
****20b48fb04483915d4f2cd8ac**** |
| Name |
string |
模板名稱。 |
雲剪輯模板 |
| Type |
string |
模板類型。 枚舉值:
|
Timeline |
| Config |
string |
模板配置。 |
參考Timeline模板配置詳解 |
| PreviewMedia |
string |
預覽素材。 |
****20b48fb04483915d4f2cd8ac**** |
| Status |
string |
模板狀態。 枚舉值:
|
Available |
| CreateSource |
string |
建立來源。 枚舉值:
|
OpenAPI |
| ModifiedSource |
string |
修改來源。 枚舉值:
|
OpenAPI |
| PreviewMediaStatus |
string |
預覽素材狀態。 枚舉值:
|
Normal |
| CreationTime |
string |
建立時間。 |
2020-12-26T04:11:10Z |
| ModifiedTime |
string |
修改時間。 |
2020-12-26T04:11:10Z |
| CoverURL |
string |
封面 URL。 |
http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg |
| ClipsParam |
string |
剪輯參數。 |
{"Media1":"mediaId","Text1":"text"} |
樣本
正常返回樣本
JSON格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"TotalCount": 100,
"Templates": [
{
"TemplateId": "****20b48fb04483915d4f2cd8ac****",
"Name": "雲剪輯模板",
"Type": "Timeline",
"Config": "參考Timeline模板配置詳解",
"PreviewMedia": "****20b48fb04483915d4f2cd8ac****",
"Status": "Available",
"CreateSource": "OpenAPI",
"ModifiedSource": "OpenAPI",
"PreviewMediaStatus": "Normal",
"CreationTime": "2020-12-26T04:11:10Z",
"ModifiedTime": "2020-12-26T04:11:10Z",
"CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg",
"ClipsParam": "{\"Media1\":\"mediaId\",\"Text1\":\"text\"}"
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。