すべてのプロダクト
Search
ドキュメントセンター

Intelligent Media Services:ListCustomTemplates

最終更新日:Mar 21, 2026

ユーザー定義の Video on Demand (VOD) 媒体処理テンプレートのリストを取得します。

今すぐお試しください

この 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:ListCustomTemplates

list

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

Type

string

必須

テンプレートのタイプ。有効な値:

  • 1: トランスコーディングテンプレート

  • 2: スクリーンショットテンプレート

  • 3: アニメーション GIF テンプレート

  • 4: 画像透かしテンプレート

  • 5: テキスト透かしテンプレート

  • 6: 字幕テンプレート

  • 7: AI コンテンツモデレーション

  • 8: AI スマートカバー

  • 9: AI オブジェクト除去

1

Subtype

string

任意

テンプレートのサブタイプ。このパラメーターは、Type が 1、2、7、または 9 に設定されている場合にのみ適用されます。

  • トランスコーディングテンプレートのサブタイプ:
    • 1: 通常 (Normal)

    • 2: オーディオのみ (AudioTranscode)

    • 3: リマックス (Remux)

    • 4: ナローバンド HD 1.0 (NarrowBandV1)

    • 5: ナローバンド HD 2.0 (NarrowBandV2)

  • スクリーンショットテンプレートのサブタイプ:
    • 1: 通常 (Normal)

    • 2: スプライト画像 (Sprite)

    • 3: WebVTT (WebVtt)

  • AI コンテンツモデレーションのサブタイプ:
    • 1: ビデオモデレーション (Video)

    • 2: オーディオモデレーション (Audio)

    • 3: 画像モデレーション (Image)

  • AI オブジェクト除去のサブタイプ:
    • 1: ロゴ除去 (VideoDelogo)

    • 2: テキスト除去 (VideoDetext)

2

Name

string

任意

テンプレートの名前。

test-template

TemplateId

string

任意

テンプレートの ID。

****96e8864746a0b6f3****

PageNumber

integer

任意

返される結果のページ番号。

1

PageSize

integer

任意

1 ページあたりのエントリ数。

20

OrderBy

string

任意

結果のソート順。有効な値:

  • CreationTime:Desc: 結果を作成時間で降順にソートします。

  • CreationTime:Asc: 結果を作成時間で昇順にソートします。

CreateTimeDesc

レスポンスフィールド

フィールド

説明

object

応答のルートオブジェクトです。

RequestId

string

リクエストの一意の ID です。

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

Total

integer

テンプレートの総数です。

20

CustomTemplateList

array<object>

カスタムテンプレートオブジェクトの配列です。

array<object>

カスタムテンプレートの詳細です。

TemplateId

string

テンプレート ID です。

****20b48fb04483915d4f2cd8ac****

TemplateName

string

テンプレート名です。

test-template

Type

integer

テンプレートタイプ ID です。

1

TypeName

string

テンプレートタイプ名です。

TranscodeTemplate

Subtype

integer

テンプレートサブタイプ ID です。

2

SubtypeName

string

テンプレートサブタイプ名です。

AudioTranscode

Status

string

テンプレートのステータスです。

列挙値:

  • Normal :

    テンプレートが正常な状態であることを示します。

Normal

IsDefault

boolean

テンプレートがデフォルトテンプレートであるかどうかを示します。

列挙値:

  • true :

    テンプレートがデフォルトテンプレートであることを示します。

  • false :

    テンプレートがデフォルトテンプレートではないことを示します。

true

TemplateConfig

string

テンプレート構成。JSON 文字列形式です。

{"Container":{"Format":"mp3"},"Audio":{"Codec":"mp3","Bitrate":"64","Samplerate":"22050","Channels":"2"}}

CreateTime

string

テンプレートが作成された時間。協定世界時 (UTC) で、YYYY-MM-DDTHH:mm:ssZ の形式で表されます。

2022-07-12T16:17:54Z

ModifiedTime

string

テンプレートが最後に変更された時間。協定世界時 (UTC) で、YYYY-MM-DDTHH:mm:ssZ の形式で表されます。

2022-07-12T16:17:54Z

FrontendHint

object

TranscodeTemplateHint

object

BitrateControlType

string

成功レスポンス

JSONJSON

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Total": 20,
  "CustomTemplateList": [
    {
      "TemplateId": "****20b48fb04483915d4f2cd8ac****",
      "TemplateName": "test-template",
      "Type": 1,
      "TypeName": "TranscodeTemplate",
      "Subtype": 2,
      "SubtypeName": "AudioTranscode",
      "Status": "Normal",
      "IsDefault": true,
      "TemplateConfig": "{\"Container\":{\"Format\":\"mp3\"},\"Audio\":{\"Codec\":\"mp3\",\"Bitrate\":\"64\",\"Samplerate\":\"22050\",\"Channels\":\"2\"}}",
      "CreateTime": "2022-07-12T16:17:54Z",
      "ModifiedTime": "2022-07-12T16:17:54Z",
      "FrontendHint": {
        "TranscodeTemplateHint": {
          "BitrateControlType": ""
        }
      }
    }
  ]
}

エラーコード

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

変更履歴

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