Submits a transcoding job and starts asynchronous transcoding.

注
  • You can transcode a video only in the UploadSucc, Normal, or Checking state.
  • コード変換結果は、StreamTranscodeCompleteまたはTranscodeCompleteイベント通知で取得できます。
  • If you initiate an HTTP Live Streaming (HLS) packaging task, you can call this operation to dynamically override the subtitle. パッケージタスクに字幕が含まれていない場合は、この操作を呼び出してパッケージタスクを開始しないことをお勧めします。 Instead, you can specify the ID of the specific template group when you upload the video. 包装プロセスは自動的に開始されます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 SubmitTranscodeJobs

実行したい操作。 値をSubmitTranscodeJobsに設定します。

TemplateGroupId String 必須 ea2727ecc0 ***** 5ff43c04878f4e1

ビデオがトランスコードされるときに使用されるトランスコードテンプレートグループのID。 コード変換テンプレートグループを指定するには、ApsaraVideo VODコンソールにログインし、コード変換ページでコード変換テンプレートグループのIDを表示します。

VideoId String 任意 0222e203cT ***** 72f9c22870a4d2c

ビデオのID。

注 VideoIdパラメーターが必要です。
PipelineId String 任意 d3e680e618708 ***** fbf2cae7cc931

パイプラインのID。

EncryptConfig String 任意 {"CipherText":"ZjJmZGViNzUtZWY1Mi00Y2RlLTk3MTMt", "DecryptKeyUri":"http://decrypt.demo.com?CipherText=ZjJmZGViNzUtZWY1Mi00Y2RlLTk3MTMt", "KeyServiceType":"KMS"}

暗号化の設定。 値は JSON 形式の文字列です。 このパラメーターは、HLS暗号化を使用する場合にのみ必要です。

注
  • EncryptConfigパラメーターのJSON形式の文字列で、CipherTextパラメーターをGenerateDataKey操作を呼び出して生成されたAES-128暗号文キーに設定する必要があります。 それ以外の場合、HLS暗号化を使用するコード変換ジョブは失敗します。 HLS暗号化の使用方法の詳細については、「HLS暗号化」をご参照ください。
  • HLS暗号化またはAlibaba Cloud独自の暗号化が必要かどうかにかかわらず、TemplateGroupIdパラメーターで指定されたテンプレートグループに対してHLS暗号化を有効にする必要があります。 それ以外の場合、HLS暗号化は使用できません。
OverrideParams String 任意 {"透かし":[{"透かしId":"af2afe4761992c ***** 47dae97337","FileUrl":"http://test.bucket.aliyuncs.com/image/replace.png" },{ "透かしId":"e8e5b8038d7a **** da85b376c270" 、"コンテンツ":"透かしテスト"}}}

オーバーライドに使用されるパラメーター。 値は JSON 形式の文字列です。 このパラメーターを設定すると、トランスコードテンプレートに関連付けられている透かしまたは字幕を上書きできます。 画像透かしのファイルURL、テキスト透かしのコンテンツ、字幕ファイルのURL、字幕ファイルのエンコード形式をオーバーライドできます。 データ構造の詳細については、「メディア処理パラメーター」トピックの「OverrideParams」セクションをご参照ください。

Priority String 任意 6

キューに入れられたすべてのジョブにおける現在のトランスコードジョブの優先度。

  • 有効値: 10に1。
  • 10の値は、最も高い優先度を示します。
  • デフォルト値: 6。
    注 このパラメーターには、キューに入れられたすべてのジョブで現在のトランスコードジョブのみの優先度を指定します。実行中のジョブの優先度には影響しません。
UserData String 任意 {"Extend":{"localId":"****","test":"***"}}

コールバック設定を含むカスタム設定。 値は JSON 形式の文字列です。 詳細については、「リクエストパラメーター」の「UserData」セクションをご参照ください。

注 コールバック設定は、ApsaraVideo VODコンソールでHTTPコールバックURLを指定し、特定のコールバックイベントを選択した場合にのみ有効になります。

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String B1DBEFB3-3371-4E ***** 43-708259D719CE

リクエストの ID です。

TranscodeJobs TranscodeJobの配列

トランスコードジョブ。

注 このパラメーターは、HLSパッケージタスクでは返されません。 コード変換結果を非同期で受け取る必要があります。
TranscodeJob
JobId String d8921ce85057 ***** 16cfe86fb112c

ジョブの ID です。

TranscodeTaskId String 9f4a0df7da2c ***** 8a81c8c0408c8

送信されたコード変換ジョブのID。

例

リクエストの例

https:// vod.{ApiRegio n}.aliyuncs.com/?Action=SubmitTranscodeJobs
&TemplateGroupId=ea2727ecc0 ***** 5ff43c04878f4e1
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式 

<SubmitTranscodeJobsResponse>
  <RequestId>B1DBEFB3-3371-4E ***** 43-708259D719CE</RequestId>
  <TranscodeJobs>
        <TranscodeJob>
              <JobId>d8921ce85057 ***** 16cfe86fb112c</JobId>
        </TranscodeJob>
  </TranscodeJobs>
  <TranscodeTaskId>9f4a0df7da2c ***** 8a81c8c0408c8</TranscodeTaskId>
</SubmitTranscodeJobsResponse>

JSON 形式 

{
    "RequestId": "B1DBEFB3-3371-4E ***** 43-708259D719CE" 、
    "TranscodeJobs": {
        "TranscodeJob": [
            {
                "JobId": "d8921ce85057 ***** 16cfe86fb112c"
            }
        ]
    },
    "TranscodeTaskId": "9f4a0df7da2c ***** 8a81c8c0408c8"
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。

共通エラー

次の表に、この操作で返される一般的なエラーを示します。

エラーコード

エラーメッセージ

HTTP ステータスコード

説明

InvalidVideo.NotFound

ビデオは存在しません。

404

ビデオが存在しない場合に返されるエラーメッセージ。

NoSuchResource

指定されたリソース % sは存在しません。

404

ユーザー関連のリソースが存在しない場合に返されるエラーメッセージ。 % sは、特定のリソース情報を示します。

Forbidden.IllegalStatus

ビデオのステータスは違法です。

400

ビデオのステータスが無効な場合に返されるエラーメッセージ。 UploadSucc、Normal、またはChecking状態でのみビデオをトランスコードできます。

SDK サンプル

この操作を呼び出すには、サーバーSDKを使用することを推奨します。 さまざまな言語でこの操作を呼び出すために使用されるサンプルコードの詳細については、次のトピックを参照してください。