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

:SearchTemplate

最終更新日:Feb 25, 2026

指定された状態のカスタムトランスコーディングテンプレートを照会するために、この操作を呼び出すことができます。

操作説明

この操作は1秒あたり最大100回呼び出すことができます。1秒あたりの呼び出し回数が制限を超えると、速度制限がトリガーされます。その結果、ビジネスに影響が出る可能性があります。この操作を呼び出す際は、制限に注意することを推奨します。詳細については、「QPS 制限」をご参照ください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

mts:SearchTemplate

get

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

PageSize

integer

任意

結果のページングクエリ中に設定される各ページセットのサイズ。

  • 上限:100。

  • デフォルト値:10。

10

PageNumber

integer

任意

返されるページの番号。デフォルト値:1

1

State

string

任意

照会するカスタムトランスコーディングテンプレートのステータス。

  • All: すべてのカスタムトランスコーディングテンプレートが照会されます。

  • Normal: 通常のカスタムトランスコーディングテンプレートが照会されます。

  • Deleted: 削除されたカスタムトランスコーディングテンプレートが照会されます。

  • デフォルト値:All

Normal

NamePrefix

string

任意

テンプレートを検索するための名前プレフィックス。

S00000001

レスポンスフィールド

フィールド

説明

object

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

TotalCount

integer

検索結果の合計数。

1

TemplateList

object

Template

array<object>

トランスコーディングテンプレート。

array<object>

ビデオコーデック構成。

Video

object

ビデオコーデック構成。

Bufsize

string

バッファーサイズ。

  • 単位:KB。

  • デフォルト値:6000

6000

LongShortMode

string

自動回転画面機能が有効になっているかどうかを示します。

  • この機能が有効な場合、出力ビデオの幅は入力ビデオの長辺 (縦モードでの入力ビデオの高さ) に対応します。出力ビデオの高さは入力ビデオの短辺 (縦モードでの入力ビデオの幅) に対応します。有効値:

  • true

  • false

  • デフォルト値:false

false

Degrain

string

ビデオ品質コントロールのレベル。

10

BitrateBnd

object

ビデオの平均ビットレート範囲。

Max

string

合計ビットレートの上限。単位:Kbit/s。

500

Min

string

合計ビットレートの下限。単位:Kbit/s。

100

PixFmt

string

ビデオのピクセルフォーマット。有効値:yuv420p や yuvj420p などの標準ピクセルフォーマット。

yuv420p

Pad

string

ビデオに追加される黒枠。

  • フォーマット:width:height:left:top。

  • 例:1280:800:0:140。

1280:800:0:140

Codec

string

コーデック。

  • 有効値:H.264 および H.265。

  • デフォルト値:H.264

H.264

Height

string

ビデオの高さ。

  • 単位:ピクセル。

  • デフォルト値:入力ビデオの高さ

800

Qscale

string

独立したノイズ除去アルゴリズムの強度。

1

Crop

string

ビデオクロッピングの方法。有効値:

  • border: 黒枠を自動的に検出して削除します。

  • width:height:left:top フォーマットの値: カスタム設定に基づいてビデオ画像をクロップします。フォーマット:width:height:left:top。例:1280:800:0:140。

border

Bitrate

string

ビデオの平均ビットレート。単位:Kbit/s。

200

Maxrate

string

ビデオの最大ビットレート。単位:Kbit/s。

500

NarrowBand

object

ナローバンド HD 設定。

Abrmax

number

動的ビットレートの上限。このパラメーターが設定されている場合、平均ビットレートは (0, 1000000] の範囲内になります。

3000

MaxAbrRatio

number

動的ビットレートの上限の最大比率。このパラメーターが設定されている場合、Abrmax の値はソースビデオビットレートの x 倍を超えません。有効値:(0,1.0]。

1.0

Version

string

ナローバンド HD バージョン。1.0 のみが返される場合があります。

1.0

MaxFps

string

最大フレームレート。

60

Profile

string

コーデックプロファイル。有効値:

  • baseline: モバイルデバイスに適用されます。

  • main: 標準解像度デバイスに適用されます。

  • high: 高解像度デバイスに適用されます。

  • デフォルト値:high

high

Crf

string

定数レートファクター。

  • Codec の値が H.264 の場合のデフォルト値:23、Codec の値が H.265 の場合のデフォルト値:26

  • このパラメーターが設定されている場合、Bitrate の値は無効になります。

15

Remove

string

ビデオストリームが削除されるかどうかを示します。有効値:

  • true

  • false

  • デフォルト値:false

false

Gop

string

2つのキーフレーム間の最大フレーム数。デフォルト値:250

10

Width

string

ビデオの幅。

  • 有効値:[128,4096]

  • 単位:ピクセル。

  • デフォルト値:入力ビデオの幅

256

Fps

string

ビデオのフレームレート。

  • 入力ビデオのフレームレートが 60 を超える場合、値は 60 です。

  • デフォルト値:入力ビデオのフレームレート

25

Preset

string

プリセットビデオアルゴリズム。デフォルト値:medium。有効値:

  • veryfast

  • fast

  • medium

  • slow

  • slower

medium

ScanMode

string

スキャンモード。有効値:

  • interlaced

  • progressive

interlaced

ResoPriority

string

解像度調整のポリシー。

1

Hdr2sdr

string

HDR2SDR 変換機能が有効になっているかどうかを示します。この機能が有効な場合、ハイダイナミックレンジ (HDR) ビデオはスタンダードダイナミックレンジ (SDR) ビデオにトランスコードされます。

true

TransConfig

object

一般的なトランスコーディング構成。

IsCheckAudioBitrate

string

オーディオビットレートがチェックされるかどうかを示します。出力オーディオのビットレートが入力オーディオのビットレートよりも高い場合、入力ビットレートが保持され、指定されたオーディオビットレートは有効になりません。このパラメーターは IsCheckAudioBitrateFail よりも優先度が低いです。有効値:

  • true

  • false

  • デフォルト値:

    • このパラメーターが空で、出力オーディオのコーデックが入力オーディオのコーデックと異なる場合、デフォルト値は false です。

    • このパラメーターが空で、出力オーディオのコーデックが入力オーディオのコーデックと同じ場合、デフォルト値は true です。

false

TransMode

string

トランスコーディングモード。デフォルト値:onepass。有効値:

  • onepass

  • twopass

  • CBR

onepass

IsCheckReso

string

解像度がチェックされるかどうかを示します。出力解像度が幅または高さに基づいて入力解像度よりも高い場合、入力解像度が保持されます。有効値:

  • true

  • false

  • デフォルト値:false

false

IsCheckVideoBitrateFail

string

ビデオビットレートチェックエラーが許可されるかどうかを示します。このパラメーターは IsCheckVideoBitrate よりも優先度が高いです。有効値:

  • true: ビデオビットレートチェックが失敗した場合、入力ファイルはトランスコードされません。

  • false: ビデオビットレートはチェックされません。

  • デフォルト値:false

false

AdjDarMethod

string

解像度調整の方法。デフォルト値:none。有効値:

  • rescale

  • crop

  • none

none

IsCheckVideoBitrate

string

ビデオビットレートがチェックされるかどうかを示します。出力ビデオのビットレートが入力ビデオのビットレートよりも高い場合、入力ビットレートが保持されます。有効値:

  • true

  • false

  • デフォルト値:false

false

IsCheckResoFail

string

解像度がチェックされるかどうかを示します。出力解像度が幅または高さに基づいて入力解像度よりも高い場合、トランスコーディング失敗が返されます。有効値:

  • true

  • false

  • デフォルト値:false

false

IsCheckAudioBitrateFail

string

オーディオビットレートチェックエラーが許可されるかどうかを示します。このパラメーターは IsCheckAudioBitrate よりも優先度が高いです。有効値:

  • true: オーディオビットレートチェックが失敗した場合、入力ファイルはトランスコードされません。

  • false: オーディオビットレートはチェックされません。

  • デフォルト値:false

false

State

string

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

  • Normal

  • Deleted

Normal

MuxConfig

object

トランスミキシング構成。

Gif

object

GIF のトランスミキシング構成。

FinalDelay

string

最終フレームが一時停止される期間。単位:センチ秒。

0

DitherMode

string

パレットのカラーディザリングアルゴリズム。有効値:sierra および bayer。

sierra

Loop

string

ループカウント。

0

IsCustomPalette

string

カスタムパレットが使用されるかどうかを示します。

false

Segment

object

セグメント構成。

Duration

string

セグメントの長さ。単位:秒。

10

Name

string

テンプレートの名前。

MPS-example

Audio

object

オーディオコーデック構成。

Profile

string

オーディオのコーデックプロファイル。Codec の値が aac の場合の有効値:

  • aac_low

  • aac_he

  • aac_he_v2

  • aac_ld

  • aac_eld

aac_low

Remove

string

オーディオストリームが削除されるかどうかを示します。有効値:

  • true

  • false

  • デフォルト値:false

false

Codec

string

オーディオコーデックフォーマット。デフォルト値:aac。有効値:

  • aac

  • mp3

  • vorbis

  • flac

aac

Samplerate

string

サンプリングレート。

  • 単位:Hz

  • デフォルト値:44100

44100

Qscale

string

独立したノイズ除去アルゴリズムの強度。有効値:[1,9]

1

Channels

string

サウンドチャンネル数。デフォルト値:2

2

Bitrate

string

出力ファイルのオーディオビットレート。

  • 単位:Kbit/s。

  • デフォルト値:128

500

Id

string

トランスコーディングテンプレート ID。

16f01ad6175e4230ac42bb5182cd****

Container

object

コンテナフォーマット構成。

Format

string

コンテナーのフォーマット。有効値:

  • flv

  • mp4

  • ts

  • m3u8

  • gif

  • mp3

  • ogg

  • flac

mp4

CreationTime

string

テンプレートが作成された時間。

2021-03-04T06:44:43Z

PageSize

integer

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

10

RequestId

string

リクエストの ID。

BC860F04-778A-472F-AB39-E1BF329C****

PageNumber

integer

返されるページの番号。

1

成功レスポンス

JSONJSON

{
  "TotalCount": 1,
  "TemplateList": {
    "Template": [
      {
        "Video": {
          "Bufsize": "6000",
          "LongShortMode": "false",
          "Degrain": "10",
          "BitrateBnd": {
            "Max": "500",
            "Min": "100"
          },
          "PixFmt": "yuv420p",
          "Pad": "1280:800:0:140",
          "Codec": "H.264",
          "Height": "800",
          "Qscale": "1",
          "Crop": "border",
          "Bitrate": "200",
          "Maxrate": "500",
          "NarrowBand": {
            "Abrmax": 3000,
            "MaxAbrRatio": 1,
            "Version": "1.0"
          },
          "MaxFps": "60",
          "Profile": "high",
          "Crf": "15",
          "Remove": "false",
          "Gop": "10",
          "Width": "256",
          "Fps": "25",
          "Preset": "medium",
          "ScanMode": "interlaced",
          "ResoPriority": "1",
          "Hdr2sdr": "true"
        },
        "TransConfig": {
          "IsCheckAudioBitrate": "false",
          "TransMode": "onepass",
          "IsCheckReso": "false",
          "IsCheckVideoBitrateFail": "false",
          "AdjDarMethod": "none",
          "IsCheckVideoBitrate": "false",
          "IsCheckResoFail": "false",
          "IsCheckAudioBitrateFail": "false"
        },
        "State": "Normal",
        "MuxConfig": {
          "Gif": {
            "FinalDelay": "0",
            "DitherMode": "sierra",
            "Loop": "0",
            "IsCustomPalette": "false"
          },
          "Segment": {
            "Duration": "10"
          }
        },
        "Name": "MPS-example",
        "Audio": {
          "Profile": "aac_low",
          "Remove": "false",
          "Codec": "aac",
          "Samplerate": "44100",
          "Qscale": "1",
          "Channels": "2",
          "Bitrate": "500"
        },
        "Id": "16f01ad6175e4230ac42bb5182cd****",
        "Container": {
          "Format": "mp4"
        },
        "CreationTime": "2021-03-04T06:44:43Z"
      }
    ]
  },
  "PageSize": 10,
  "RequestId": "BC860F04-778A-472F-AB39-E1BF329C****",
  "PageNumber": 1
}

エラーコード

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

変更履歴

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