すべてのプロダクト
Search

このプロダクト

    Intelligent Media Services:GetTemplate

    ドキュメントセンター

    Intelligent Media Services:GetTemplate

    最終更新日:Mar 21, 2026

    テンプレート ID を指定して、テンプレートの情報を照会します。テンプレートの状態が「Available」（利用可能）の場合、高度テンプレートの情報を照会できます。

    操作説明

    テンプレートは、メディア編集・制作ジョブのタイムラインをカプセル化したものです。共通のタイムラインをテンプレートとして定義することで、同様の要件がある場合に、キーとなるパラメーターと素材のみを指定するだけでビデオを生成できます。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    ice:GetTemplate

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    TemplateId

    string

    任意

    テンプレート ID。

    ****20b48fb04483915d4f2cd8ac****
    RelatedMediaidFlag

    string

    任意

    関連素材の情報を返すかどうかを指定します。デフォルト値は 0 です。有効な値は 0 および 1 です。値が 1 の場合、関連素材の情報が応答に含まれます。このパラメーターは、通常テンプレートでのみ有効です。

    0

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    RequestId

    string

    リクエスト ID。

    ******11-DB8D-4A9A-875B-275798******
    Template

    object

    テンプレート情報。

    TemplateId

    string

    テンプレート ID。

    ****20b48fb04483915d4f2cd8ac****
    Name

    string

    テンプレート名。

    视频添加水印模板
    Type

    string

    テンプレートタイプ。有効な値は以下のとおりです。

    • Timeline

    • VETemplate

    Timeline
    Config

    string

    テンプレートの構成。

    参考Timeline模板配置详解
    PreviewMedia

    string

    プレビュー用メディアアセット。

    ****20b48fb04483915d4f2cd8ac****
    Status

    string

    テンプレートの状態。有効な値は以下のとおりです。

    • Available

    • Created

    • Uploading

    • Processing

    • UploadFailed

    • ProcessFailed

    Available
    CreateSource

    string

    テンプレートの作成元。有効な値は以下のとおりです。

    • AliyunConsole

    • OpenAPI

    • WebSDK

    OpenAPI
    ModifiedSource

    string

    テンプレートの変更元。有効な値は以下のとおりです。

    • AliyunConsole

    • OpenAPI

    • WebSDK

    OpenAPI
    PreviewMediaStatus

    string

    プレビュー用メディアアセットの状態。有効な値は以下のとおりです。

    • Init：初期状態。ソースファイルが準備されていないことを示します。

    • Preparing：ソースファイルの準備中。たとえば、ファイルのアップロードや編集が進行中です。

    • PrepareFail：ソースファイルの準備に失敗しました。たとえば、ソースファイルに関する情報の取得に失敗しました。

    • Normal：ソースファイルが準備完了です。

    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

    動画制作ジョブの送信に使用するクリップパラメーター。実際の値（mediaId や text）に置き換えてジョブを送信できます。参考情報：

    {"Media1":"mediaId","Text1":"text"}
    RelatedMediaids

    string

    通常テンプレートエディターで使用する、テンプレートに関連付けられた素材の ID。

    {"video":["******c04f1d4a06996144cc1a******"],"audio":["******c04f1d4a06996144cc1a******"],"image":["******c04f1d4a06996144cc1a******"]}

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Template": {
    "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\"}",
    "RelatedMediaids": "{\"video\":[\"******c04f1d4a06996144cc1a******\"],\"audio\":[\"******c04f1d4a06996144cc1a******\"],\"image\":[\"******c04f1d4a06996144cc1a******\"]}"
  }
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。