指定された条件を満たすテンプレートの一覧をクエリします。テンプレートのステータスや作成ソースなどの情報に基づいてクエリできます。
操作説明
テンプレートは、メディア編集および制作ジョブのタイムラインをカプセル化したものです。共通のタイムラインをテンプレートとして定義することで、要件が同じ場合は主要なパラメーターと素材を指定するだけで動画を制作できます。
-
通常テンプレートの使用方法については、「通常テンプレートの作成と使用」をご参照ください。
-
高度なテンプレートの使用方法については、「高度なテンプレートの作成と使用」をご参照ください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ice:ListTemplates |
*すべてのリソース
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Type |
文字列 |
任意 |
テンプレートタイプ。 有効な値:
列挙値:
|
Timeline |
| Status |
文字列 |
任意 |
テンプレートの状態。 有効な値:
列挙値:
|
Available |
| CreateSource |
文字列 |
任意 |
テンプレートの作成元。 有効な値:
列挙値:
|
OpenAPI |
| Keyword |
文字列 |
任意 |
検索キーワード。テンプレート ID またはタイトルをキーワードとして、テンプレートを検索できます。 |
****20b48fb04483915d4f2cd8ac**** |
| SortType |
文字列 |
任意 |
ソートパラメーター。デフォルトでは、クエリ結果は作成日時の降順でソートされます。 有効な値:
列挙値:
|
CreationTime:Desc |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
オブジェクト |
レスポンスパラメーター。 |
||
| RequestId |
文字列 |
リクエスト ID。 |
******11-DB8D-4A9A-875B-275798****** |
| TotalCount |
整数 |
返されたエントリの総数。 |
100 |
| Templates |
配列<オブジェクト> |
検索されたテンプレート。 |
|
|
オブジェクト |
テンプレート情報。 |
||
| TemplateId |
文字列 |
テンプレート ID。 |
**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 |
文字列 |
サムネイル URL。 |
http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg |
| ClipsParam |
文字列 |
クリップパラメーター。 |
{"Media1":"mediaId","Text1":"text"} |
例
成功レスポンス
JSONJSON
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"TotalCount": 100,
"Templates": [
{
"TemplateId": "****20b48fb04483915d4f2cd8ac****",
"Name": "クラウド編集テンプレート",
"Type": "Timeline",
"Config": "タイムラインテンプレートの構成詳細を参照してください。",
"PreviewMedia": "****20b48fb04483915d4f2cd8ac****",
"Status": "利用可能",
"CreateSource": "OpenAPI",
"ModifiedSource": "OpenAPI",
"PreviewMediaStatus": "正常",
"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\"}"
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。