指定された条件に合致するテンプレートの一覧をクエリします。テンプレートのステータスや作成ソースなどの情報をもとに、テンプレートを検索できます。
操作説明
テンプレートは、メディア編集および制作ジョブのタイムラインをカプセル化したものです。共通のタイムラインをテンプレートとして定義できます。同様の要件がある場合、キーとなるパラメーターと素材を指定するだけでビデオを生成できます。
通常テンプレートの使用方法については、「通常テンプレートの作成と使用」をご参照ください。
高度なテンプレートの使用方法については、「高度なテンプレートの作成と使用」をご参照ください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ice:ListTemplates |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Type |
string |
任意 |
テンプレートのタイプ。 有効な値:
列挙値:
|
Timeline |
| Status |
string |
任意 |
テンプレートの状態。 有効な値:
列挙値:
|
Available |
| CreateSource |
string |
任意 |
テンプレートの作成元。 有効な値:
列挙値:
|
OpenAPI |
| Keyword |
string |
任意 |
検索キーワード。テンプレート ID またはタイトルをキーワードとして使用してテンプレートを検索できます。 |
****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"} |
例
成功レスポンス
JSONJSON
{
"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\"}"
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。