ListTranscodeJobs - Intelligent Media Services - Alibaba Cloud ドキュメントセンター

メディアファイルのトランスコーディングジョブを一覧表示します。

今すぐお試しください

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

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
StartOfCreateTime	string	任意	ジョブの作成時刻でフィルター処理するための期間の開始時刻です。時刻は協定世界時 (UTC) で、`yyyy-MM-ddTHH:mm:ssZ` 形式である必要があります。	2022-07-01T00:00:00Z
EndOfCreateTime	string	任意	ジョブの作成時刻でフィルター処理するための期間の終了時刻です。時刻は協定世界時 (UTC) で、`yyyy-MM-ddTHH:mm:ssZ` 形式である必要があります。	2022-07-15T00:00:00Z
ParentJobId	string	任意	ジョブ ID でフィルター処理します。	7b38a5d86f1e47838927b6e7ccb1****
Status	string	任意	ジョブのステータスです。有効な値は以下のとおりです。 `Init`：送信済み。 `Success`：成功。 `Fail`：失敗。	Success
OrderBy	string	任意	並べ替え順序です。有効な値は以下のとおりです。 `CreateTimeDesc`：作成時刻の降順で並べ替えます。 `CreateTimeAsc`：作成時刻の昇順で並べ替えます。	CreateTimeDesc
PageSize	integer	任意	1 ページあたりのエントリ数です。有効な値は 1～100 です。デフォルト値は 20 です。	10
NextPageToken	string	任意	次のページの結果を取得するためのトークンです。1 ページ目のリクエストではこのパラメーターは不要です。	ab4802364a2e49208c99efab82df****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID です。	31E30781-9495-5E2D-A84D-759B0A01E262
Jobs	array<object>	ジョブの一覧です。
	array<object>	ジョブの詳細です。
CreateTime	string	ジョブが作成された時刻です。`yyyy-MM-ddTHH:mm:ssZ` 形式で表示され、協定世界時 (UTC) で表されます。	2022-01-12T08:49:41Z
Name	string	ジョブ名です。	transcode-job
RequestId	string	ジョブのリクエスト ID です。	31E30781-9495-5E2D-A84D-759B0A01E262
ParentJobId	string	親ジョブの ID です。	8b2198504dd340b7b3c9842a74fc****
JobCount	integer	サブジョブの数です。	1
Status	string	ジョブのステータスです。有効な値は以下のとおりです。 `Success`：少なくとも 1 つのサブジョブが成功した場合にジョブは成功とみなされます。 `Fail`：すべてのサブジョブが失敗した場合にジョブは失敗とみなされます。	Success
TriggerSource	string	ジョブの発生元です。有効な値は以下のとおりです。 `API`：API オペレーションの呼び出しによってジョブが送信されました。 `Workflow`：ワークフローによってジョブがトリガーされました。 `Console`：コンソール上でジョブが送信されました。	API
Percent	integer	ジョブの進捗状況です。	0
SubmitTime	string	ジョブが送信された時刻です。`yyyy-MM-ddTHH:mm:ssZ` 形式で表示され、協定世界時 (UTC) で表されます。	2022-01-12T08:49:41Z
FinishTime	string	ジョブが完了した時刻です。`yyyy-MM-ddTHH:mm:ssZ` 形式で表示され、協定世界時 (UTC) で表されます。	2022-01-12T08:49:41Z
InputGroup	array<object>	ジョブの入力グループです。単一の入力はトランスコーディングジョブを示し、複数の入力は合成ジョブを示します。
	object	ジョブの入力です。
Type	string	メディアアセットの種類です。有効な値は以下のとおりです。 `OSS`：OSS ファイル。 `Media`：メディアアセット ID。	OSS
Media	string	メディア情報です。このパラメーターの値は、Type の値によって異なります。 Type が `OSS` の場合、このパラメーターの値は OSS URL である必要があります。`oss://` および `http(s)://` の両方のプロトコルがサポートされています。 Type が `Media` の場合、このパラメーターの値はメディア ID である必要があります。	oss://bucket/path/to/video.mp4
InputUrl	string	メディアストリームの URL です。メディアストリームのトランスコードを行う場合にのみ、このパラメーターを指定する必要があります。	oss://bucket/path/to/video.mp4
OutputGroup	array<object>	ジョブの出力グループです。
	array<object>	ジョブの出力です。
Output	object	出力メディアの構成です。
Type	string	メディアアセットの種類です。有効な値は以下のとおりです。 `OSS`：OSS ファイル。 `Media`：メディアアセット ID。	OSS
Media	string	メディア情報です。このパラメーターの値は、Type の値によって異なります。 Type が `OSS` の場合、このパラメーターの値は OSS URL である必要があります。`oss://` および `http(s)://` の両方のプロトコルがサポートされています。 Type が `Media` の場合、このパラメーターの値はメディア ID である必要があります。	oss://bucket/path/to/video.mp4
OutputUrl	string	出力ストリームの URL です。メディアストリームのトランスコードを行う場合にのみ、このパラメーターを指定する必要があります。	oss://bucket/path/to/{MediaId}/{JobId}.mp4
ProcessConfig	object	ジョブの処理構成です。
Transcode	object	トランスコード構成です。
TemplateId	string	テンプレート ID です。	9547c6ad97cb4f2aaa29683ebd18****
OverwriteParams	object	上書きパラメーターです。このパラメーターを指定すると、テンプレート内の対応するパラメーターが上書きされます。
Video	object	動画設定です。
Codec	string	動画コーデックです。	H.264
Profile	string	エンコードプロファイルです。有効な値は baseline、main、high です。 `baseline`：モバイルデバイス向け。 `main`：標準解像度デバイス向け。 `high`：高解像度デバイス向け。デフォルト値は `high` です。	Main
Bitrate	string	平均動画ビットレートです。有効な値：10～50000。単位：Kbit/s。	3000
Crf	string	品質とビットレートの制御係数です。有効な値：0～51。デフォルト値：コーデックが H.264 の場合は 23、H.265 の場合は 26。 Crf を指定した場合、Bitrate の値は無視されます。	23
Width	string	幅です。有効な値：128～4096。単位：px。デフォルト値：ソース動画の幅。	1920
Height	string	高さです。有効な値：128～4096。単位：px。デフォルト値：ソース動画の高さ。	1080
Fps	string	フレームレートです。有効な値：0～60。入力ファイルのフレームレートが 60 を超える場合、値は 60 になります。デフォルト値：入力ファイルのフレームレート。	25
Gop	string	ピクチャグループ (GOP) 内の最大フレーム数です。有効な値：1～1080000。デフォルト値：250。	250
Preset	string	動画エンコーダーのプリセットです。このパラメーターは、動画コーデックが H.264 の場合にのみサポートされます。有効な値は `veryfast`、`fast`、`medium`、`slow`、`slower` です。デフォルト値は `medium` です。	medium
ScanMode	string	スキャンモードです。有効な値は `interlaced` および `progressive` です。	progressive
PixFmt	string	ピクセルフォーマットです。有効な値は `yuv420p` および `yuvj420p` です。	yuv420p
Remove	string	動画を削除するかどうかを指定します。有効な値は `true` および `false` です。	false
Crop	string	クロップ設定です。2 種類のモードがサポートされています。自動：黒枠を自動検出してクロップするには、値を `border` に設定します。手動：クロップ領域を `width:height:left:top` 形式で指定します。例：`1280:800:0:140`。	1280:800:0:140
Pad	string	黒枠を追加するための設定です。形式：`width:height:left:top`。例：`1280:800:0:140`。	1280:800:0:140
LongShortMode	string	長辺・短辺による適応的解像度を有効にするかどうかを指定します。	false
Bufsize	string	バッファーのサイズです。有効な値：1000～128000。デフォルト値：6000。単位：Kbit。	6000
Maxrate	string	最大動画ビットレートです。有効な値は 10～50000 です。単位は Kbit/s です。	9000
AbrMax	string	アダプティブビットレート (ABR) ストリーミングの最大ビットレートです。このパラメーターは、縦幅が狭く横幅が広い動画にのみ有効です。有効な値は 10～50000 です。単位は Kbit/s です。	6000
Audio	object	音声設定です。
Codec	string	音声コーデックです。有効な値は `AAC`、`MP3`、`VORBIS`、`FLAC` です。デフォルト値は `AAC` です。	AAC
Profile	string	音声エンコーディングのプリセットです。このパラメーターは、音声コーデックが AAC の場合にのみサポートされます。有効な値は `aac_low`、`aac_he`、`aac_he_v2`、`aac_ld`、`aac_eld` です。	aac_low
Samplerate	string	サンプルレートです。有効な値：22050、32000、44100、48000、96000。デフォルト値：44100。単位：Hz。	44100
Bitrate	string	出力ファイルの音声ビットレートです。有効な値：8～1000。単位：Kbit/s。デフォルト値：128。	128
Channels	string	音声チャンネル数です。デフォルト値は 2 です。	2
Remove	string	音声ストリームを削除するかどうかを指定します。有効な値は `true` および `false` です。	false
Volume	object	ボリューム制御設定です。
Method	string	ボリューム調整方法です。	auto
IntegratedLoudnessTarget	string	ターゲット統合ラウドネスです。	-6
TruePeak	string	真のピークレベルです。	-1
LoudnessRangeTarget	string	ターゲットラウドネス範囲です。	8
Container	object	コンテナフォーマット設定です。
Format	string	コンテナフォーマットです。	mp4
MuxConfig	object	マルチプレックス設定です。
Segment	object	セグメント設定です。
Duration	string	各セグメントの持続時間です。	10
ForceSegTime	string	セグメンテーションを強制するタイミングです。	2,3
Tags	object	カスタムタグです。
	string	カスタムタグのキーと値のペアです。
ImageWatermarks	array<object>	画像ウォーターマークの構成です。
	array<object>	画像ウォーターマークの構成です。
TemplateId	string	テンプレート ID です。	9547c6ad97cb4f2aaa29683ebd18****
OverwriteParams	object	上書きパラメーターです。このパラメーターを指定すると、テンプレート内の対応するパラメーターが上書きされます。
Width	string	ウォーターマークの幅です。	32
Height	string	ウォーターマークの高さです。	32
Dx	string	ウォーターマークの水平オフセットです。	10
Dy	string	ウォーターマークの垂直オフセットです。	10
ReferPos	string	基準位置です。有効な値は `TopLeft`、`TopRight`、`BottomLeft`、`BottomRight` です。デフォルト値は `TopLeft` です。	TopLeft
Timeline	object	タイムライン設定です。
Start	string	開始時刻です。	00:00:05
Duration	string	表示持続時間（秒単位）です。「ToEND」も指定できます。	ToEND
File	object	ウォーターマーク画像ファイルです。
Type	string	メディアアセットの種類です。有効な値は以下のとおりです。 `OSS`：OSS ファイル。 `Media`：メディアアセット ID。	OSS
Media	string	メディア情報です。このパラメーターの値は、Type の値によって異なります。 Type が `OSS` の場合、このパラメーターの値は OSS URL である必要があります。`oss://` および `http(s)://` の両方のプロトコルがサポートされています。 Type が `Media` の場合、このパラメーターの値はメディア ID である必要があります。	oss://bucket/path/to/video.mp4
TextWatermarks	array<object>	テキストウォーターマークの構成です。
	array<object>	テキストウォーターマークの構成です。
TemplateId	string	テンプレート ID です。	9547c6ad97cb4f2aaa29683ebd18****
OverwriteParams	object	上書きパラメーターです。このパラメーターを指定すると、テンプレート内の対応するパラメーターが上書きされます。
Content	string	ウォーターマークテキストです。UTF-8 エンコーディングである必要があります。Base64 エンコーディングは不要です。	测试水印
FontName	string	フォントです。	SimSun
FontColor	string	色です。	#006400
FontAlpha	string	透過度です。	1.0
Top	string	ウォーターマークの上端からの距離です。	10
Left	string	動画の左端からの距離です。	10
FontSize	integer	フォントサイズです。	16
BorderWidth	integer	ボーダーの幅です。	0
BorderColor	string	ボーダーの色です。	#006400
Adaptive	string	出力動画のサイズに応じてフォントサイズを自動調整するかどうかを指定します。 `true`：出力動画のサイズに応じてフォントサイズが自動的に調整されます。 `false`：フォントサイズは固定され、出力動画のサイズには影響されません。デフォルト値：false	false
Subtitles	array<object>	字幕焼き込み設定です。
	array<object>	字幕焼き込み構成です。
TemplateId	string	テンプレート ID です。	9547c6ad97cb4f2aaa29683ebd18****
OverwriteParams	object	上書きパラメーターです。指定した場合、これらのパラメーターがテンプレート内の対応するパラメーターを上書きします。
Format	string	字幕ファイルの形式です。	vtt
CharEnc	string	ファイルのエンコード形式です。	UTF-8
File	object	字幕ファイルです。
Type	string	メディアオブジェクトの種類です。有効な値は以下のとおりです。 OSS：Object Storage Service (OSS) ファイル。 Media：メディアアセットの ID。	OSS
Media	string	メディア値： Type が OSS の場合、値は URL です。OSS および HTTP プロトコルの両方がサポートされています。 Type が Media の場合、値はメディアアセット ID です。	oss://bucket/path/to/video.mp4
Encryption	object	暗号化設定です。
EncryptType	string	暗号化タイプです。	PrivateEncryption
CipherText	string	標準暗号化の鍵の暗号文です。	MTYi00NDU0LTg5O****
DecryptKeyUri	string	標準暗号化の復号サービスの URL です。	https://sample.com/path?CipherText=MTYi00NDU0LTg5O****
CombineConfigs	array<object>	複数の入力を結合するための構成です。
	object
AudioIndex	string	音声ストリームのインデックスです。	0 或 exclude
VideoIndex	string	動画ストリームのインデックスです。	0 或 exclude
Start	number	入力ストリームの開始時刻です。デフォルト値は 0 です。	0.0
Duration	number	入力ストリームの持続時間です。デフォルトでは動画の持続時間になります。	20.0
IsInheritTags	boolean	入力ストリームからタグを継承するかどうかを指定します。このパラメーターは、入力がメディアアセットである場合にのみ適用されます。デフォルト値は false です。
UserData	string	ユーザーデータ。	user-data
ScheduleConfig	object	ジョブのスケジュール構成です。
PipelineId	string	パイプライン ID です。	e37ebee5d98b4781897f6086e89f****
Priority	integer	ジョブの優先度です。値が大きいほど優先度が高くなります。値は 1～10 の整数です。	5
NextPageToken	string	次のページの結果を取得するためのトークンです。最初のリクエストではこのパラメーターを空のままにしてください。トークンは最初のクエリ後に返されます。	019daf5780f74831b0e1a767c9f1****

例

成功レスポンス

JSONJSON

{
  "RequestId": "31E30781-9495-5E2D-A84D-759B0A01E262",
  "Jobs": [
    {
      "CreateTime": "2022-01-12T08:49:41Z",
      "Name": "transcode-job",
      "RequestId": "31E30781-9495-5E2D-A84D-759B0A01E262",
      "ParentJobId": "8b2198504dd340b7b3c9842a74fc****",
      "JobCount": 1,
      "Status": "Success",
      "TriggerSource": "API",
      "Percent": 0,
      "SubmitTime": "2022-01-12T08:49:41Z",
      "FinishTime": "2022-01-12T08:49:41Z",
      "InputGroup": [
        {
          "Type": "OSS",
          "Media": "oss://bucket/path/to/video.mp4",
          "InputUrl": "oss://bucket/path/to/video.mp4"
        }
      ],
      "OutputGroup": [
        {
          "Output": {
            "Type": "OSS",
            "Media": "oss://bucket/path/to/video.mp4",
            "OutputUrl": "oss://bucket/path/to/{MediaId}/{JobId}.mp4"
          },
          "ProcessConfig": {
            "Transcode": {
              "TemplateId": "9547c6ad97cb4f2aaa29683ebd18****",
              "OverwriteParams": {
                "Video": {
                  "Codec": "H.264",
                  "Profile": "Main",
                  "Bitrate": "3000",
                  "Crf": "23",
                  "Width": "1920",
                  "Height": "1080",
                  "Fps": "25",
                  "Gop": "250",
                  "Preset": "medium",
                  "ScanMode": "progressive",
                  "PixFmt": "yuv420p",
                  "Remove": "false",
                  "Crop": "1280:800:0:140",
                  "Pad": "1280:800:0:140",
                  "LongShortMode": "false",
                  "Bufsize": "6000",
                  "Maxrate": "9000",
                  "AbrMax": "6000"
                },
                "Audio": {
                  "Codec": "AAC",
                  "Profile": "aac_low",
                  "Samplerate": "44100",
                  "Bitrate": "128",
                  "Channels": "2",
                  "Remove": "false",
                  "Volume": {
                    "Method": "auto",
                    "IntegratedLoudnessTarget": "-6",
                    "TruePeak": "-1",
                    "LoudnessRangeTarget": "8"
                  }
                },
                "Container": {
                  "Format": "mp4"
                },
                "MuxConfig": {
                  "Segment": {
                    "Duration": "10",
                    "ForceSegTime": "2,3"
                  }
                },
                "Tags": {
                  "key": ""
                }
              }
            },
            "ImageWatermarks": [
              {
                "TemplateId": "9547c6ad97cb4f2aaa29683ebd18****",
                "OverwriteParams": {
                  "Width": "32",
                  "Height": "32",
                  "Dx": "10",
                  "Dy": "10",
                  "ReferPos": "TopLeft",
                  "Timeline": {
                    "Start": "00:00:05",
                    "Duration": "ToEND"
                  },
                  "File": {
                    "Type": "OSS",
                    "Media": "oss://bucket/path/to/video.mp4"
                  }
                }
              }
            ],
            "TextWatermarks": [
              {
                "TemplateId": "9547c6ad97cb4f2aaa29683ebd18****",
                "OverwriteParams": {
                  "Content": "测试水印",
                  "FontName": "SimSun",
                  "FontColor": "#006400",
                  "FontAlpha": "1.0",
                  "Top": "10",
                  "Left": "10",
                  "FontSize": 16,
                  "BorderWidth": 0,
                  "BorderColor": "#006400",
                  "Adaptive": "false"
                }
              }
            ],
            "Subtitles": [
              {
                "TemplateId": "9547c6ad97cb4f2aaa29683ebd18****",
                "OverwriteParams": {
                  "Format": "vtt",
                  "CharEnc": "UTF-8",
                  "File": {
                    "Type": "OSS",
                    "Media": "oss://bucket/path/to/video.mp4"
                  }
                }
              }
            ],
            "Encryption": {
              "EncryptType": "PrivateEncryption",
              "CipherText": "MTYi00NDU0LTg5O****",
              "DecryptKeyUri": "https://sample.com/path?CipherText=MTYi00NDU0LTg5O****"
            },
            "CombineConfigs": [
              {
                "AudioIndex": "0 或 exclude",
                "VideoIndex": "0 或 exclude",
                "Start": 0,
                "Duration": 20
              }
            ],
            "IsInheritTags": false
          }
        }
      ],
      "UserData": "user-data",
      "ScheduleConfig": {
        "PipelineId": "e37ebee5d98b4781897f6086e89f****",
        "Priority": 5
      }
    }
  ],
  "NextPageToken": "019daf5780f74831b0e1a767c9f1****"
}

エラーコード

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

変更履歴

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