edit-icon download-icon

SubmitJobs

最終更新日: Oct 31, 2018

説明

SubmitJobs API は、トランスコード タスクを送信します。トランスコードの出力の場合、トランスコード タスクを生成します。本 API は、トランスコード タスクのリストを返します。タスクは、 MPS キューに追加され、スケジューリングされ、実行されます。タスクが実行された後に、「トランスコード タスクを照会」する API を呼び出し、タスクの実行結果をポーリングします。非同期通知を使用できます。

プリセット トランスコード テンプレートを使用する場合は、API SubmitAnalysisJob を呼び出してテンプレート分析を実行してから API QueryAnalysisJobList を呼び出し、入力ファイルで利用可能なプリセット トランスコード テンプレートのリストを取得します。利用可能なプリセット テンプレートのリストに、実行されたトランスコード タスクに指定されたプリセット テンプレートがない場合は、トランスコード タスクに失敗します。

リクエスト パラメーター

パラメーター タイプ 必須かどうか 説明
Action String はい 操作の API、システム必須パラメーター。パラメーターの値は、 SubmitJobs にします。
Input String はい ジョブ入力。JSON オブジェクト。Input の定義については、付録 - パラメーター詳細 - トランスコード タスク 入力の詳細 19 をご参照ください。 例:
{
"Bucket":"example-bucket",
"Location":"oss-cn-hangzhou",
"Object":"example.flv"
}
コンソール上で、クラウド リソースに権限を付与しておく必要があります。
OutputBucket String はい 出力バケット。コンソール上で、クラウド リソースに権限を付与しておく必要があります。
OutputLocation String いいえ 出力バケットの属するデータセンター。デフォルト値は oss-cn-hangzhou です。
Outputs String はい Outputs は Output リストで構成されており、JSON 配列で、Outputパラメーターは最大30個です。出力定義については、用語集を参照してください。Output パラメーターの詳細については、「付録」の「パラメーター」の「2. 出力」をご参照ください。例:
[{
"OutputObject":"example-output.flv",
"TemplateId":"S00000000-000010",
"WaterMarks":[{
"InputFile":{
"Bucket":"example-bucket",
"Location":"oss-cn-hangzhou",
"Object":"example-logo.png"
},
"WaterMarkTemplateId":"88c6ca184c0e47098a5b665e2a126797"
}],
"UserData":"testid-001"
}]
PipelineId String はい MPS キュー ID。 MPS キューの定義については、用語集をご参照ください。非同期通知が必要な場合は、MPS キューが利用可能なメッセージの件名にバインドされていることをご確認ください。

応答パラメーター

名前 タイプ 説明
JobResultList AliyunJobResult[ ] 送信されたトランスコード タスクの結果のリスト

リクエスト例

  1. http://mts.cn-hangzhou.aliyuncs.com/?PipelineId=88c6ca184c0e47098a5b665e2a126799&Action=SubmitJobs&Input=%7b%22Bucket%22%3a%22example-bucket%22%2c%22Location%22%3a%22oss-cn-hangzhou%22%2c%22Object%22%3a%22example.flv%22%7d&Outputs=%5b%7b%22OutputObject%22%3a%22example-output.flv%22%2c%22TemplateId%22%3a%22S00000000-000010%22%2c%22WaterMarks%22%3a%5b%7b%22InputFile%22%3a%7b%22Bucket%22%3a%22example-bucket%22%2c%22Location%22%3a%22oss-cn-hangzhou%22%2c%22Object%22%3a%22example-logo.png%22%7d%2c%22WaterMarkTemplateId%22%3a%2288c6ca184c0e47098a5b665e2a126797%22%7d%5d%7d%5d&OutputBucket=example-bucket&Public Parameters>

応答例

XML 形式

  1. <SubmitJobsResponse>
  2. <RequestId>25818875-5F78-4A13-BEF6-D7393642CA58</RequestId>
  3. <JobResultList list="true">
  4. <JobResult>
  5. <Success>true</Success>
  6. <Code> </Code>
  7. <Message> </Message>
  8. <Job>
  9. <JobId>31fa3c9ca8134f9cec2b4b0b0f787830</JobId>
  10. <Input>
  11. <Bucket>example-bucket</Bucket>
  12. <Location>oss-cn-hangzhou</Location>
  13. <Object>example.flv</Object>
  14. </Input>
  15. <Output>
  16. <OutputFile>
  17. <Bucket>example-bucket</Bucket>
  18. <Location>oss-cn-hangzhou</Location>
  19. <Object>example-output.flv</Object>
  20. </OutputFile>
  21. <TemplateId>S00000000-000010</TemplateId>
  22. <WaterMarkList list="true">
  23. <WaterMark>
  24. <InputFile>
  25. <Bucket>example-logo-bucket</Bucket>
  26. <Location>0ss-cn-hangzhou</Location>
  27. <Object>example-logo.png</Object>
  28. </InputFile>
  29. <WaterMarkTemplateId>88c6ca184c0e47098a5b665e2a126797</WaterMarkTemplateId>
  30. </WaterMark>
  31. </WaterMarkList>
  32. <UserData>testid-001</UserData>
  33. </Output>
  34. <State>Submitted</State>
  35. <Code> </Code>
  36. <Message> </Message>
  37. <Percent>0</Percent>
  38. <PipelineId>88c6ca184c0e47098a5b665e2a126797</PipelineId>
  39. <CreationTime>2014-01-10T12:00:00Z</CreationTime>
  40. </Job>
  41. </JobResult>
  42. </JobResultList>
  43. </SubmitJobsResponse>

JSON 形式

  1. {
  2. "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  3. "JobResultList": {
  4. "JobResult": [{
  5. "Success": true,
  6. "Code": "",
  7. "Message": "",
  8. "Job": {
  9. "JobId": "31fa3c9ca8134f9cec2b4b0b0f787830",
  10. "Input": {
  11. "Bucket": "example-bucket",
  12. "Location": "oss-cn-hangzhou",
  13. "Object": "example.flv"
  14. },
  15. "Output": {
  16. "OutputFile": {
  17. "Bucket": "example-bucket",
  18. "Location": "oss-cn-hangzhou",
  19. "Object": "example-output.flv"
  20. },
  21. "TemplateId": "S00000000-000010",
  22. "WaterMarkList": {
  23. "WaterMark": [{
  24. "InputFile": {
  25. "Bucket": "example-bucket",
  26. "Location": "oss-cn-hangzhou",
  27. "Object": "example-logo.png"
  28. },
  29. "WaterMarkTemplateId": "88c6ca184c0e47098a5b665e2a126797"
  30. }]
  31. },
  32. "UserData":"testid-001"
  33. },
  34. "State": "Submitted",
  35. "Code": "",
  36. "Message": "",
  37. "Percent": 0,
  38. "PipelineId": "88c6ca184c0e47098a5b665e2a126797",
  39. "CreationTime”:”2014-01-10T12:00:00Z"
  40. }
  41. }]
  42. }
  43. }

トランスコード エラー コード

エラーコード 説明 詳細情報
InvalidParameter.ResourceContentBad トランスコード ソース ファイルが壊れているため、トランスコードに失敗します。 The resource operated is broken.
PermissionDenied.ResourceAccess 操作権限がありません。 MTS is not authorized to operate on the specified resource.
InternalError 不明な内部エラー The operation has failed due to some unknown error, exception or failure.
InvalidParameter.NullValue パラメーター値が Null です。 The specified parameter “%s” cannot be null.
InvalidParameter.EmptyValue パラメーターが空白です。 The specified parameter “%s” cannot be empty.
InvalidParameter.UUIDFormatInvalid ID が UUID 形式ではありません。 The parameter “%s” is invalid. A uuid must: 1) be comprised of characters[a-f], numbers[0-9]; 2) be 32 characters long.
InvalidParameter.EmptyValue 範囲外のパラメーター値です。 The specified parameter “%s” is out of range.
InvalidParameter.ResourceNotFound 存在しないリソースです。 The resource operated “%s” cannot be found.
InvalidParameter.ResourceDeleted リソースは削除されています。 The resource operated “%s” has been deleted.
InvalidParameter.BucketNameInvalid 無効なバケット名です。 The bucket name “%s” is invalid. A bucket name must: 1) be comprised of lower-case characters, numbers, underscore(_) or dash(-); 2) start with lower case or numbers; 3) be between 3-255 characters long.
InvalidParameter.LocationInvalid 無効なロケーションです。 The location “%s” is invalid. A location name should be one of the five: oss-cn-hangzhou, oss-cn-shanghai, oss-cn-beijing, oss-us-west-1, and oss-cn-shenzhen.
InvalidParameter.ObjectKeyInvalid 無効なオブジェクト名です。 The object key “%s” is invalid. An object name must be between 1 - 1023 bytes long when encoded as UTF-8 and cannot contain LF or CR or unsupported chars in XML1.0.
InvalidParameter.JsonArrayFormatInvalid パラメータが JSON 配列ではありません。 The parameter “%s” does not conform to the JSON Array specification.
Parameters.NotSupported サポートされていないパラメーターです。 The Parameters “%s” are not supported the same time, select one of them.
InvalidParameter.ResourceNotSupported サポートされていないリソースタイプです。 The resource operated “%s” is not supported.
NotSupportedJob.SystemTemplateJobNotSupported システムテンプレートは、高速トランスコードをサポートしていません。 The Template “%s” is a system template, cannot be supported by boost Media Transcoding queue.
InvalidParameter.Format パラメーターの形式が正しくありません。 The format of parameter “%s” is invalid.
InvalidParameter.TemplateNotFound テンプレートが見つかりません。 The Template operated “%s” cannot be found.
InvalidParameter.TemplateNotSupported サポートされていないテンプレートです。 The template operated “%s” is not supported.
InvalidParameter.NumberFormatInvalid パラメーターが数値ではありません。 The number format of parameter “%s” is invalid.
ParameterNotBoolean パラメーターが Boolean ではありません。 ParameterNotBoolean, The Parameter “%s” is not boolean value.
InvalidParameter.DigiWatermark 電子ウォーターマーク パラメーターの値は無効です。 The specified parameter “%s” should include alternative of “InputFile” or (NumberMark, StringMark).
InvalidParameter.WaterMarkFileFormatNotSupported サポートされていないウォーターマークの形式です。 The resource operated “%s” is not supported, watermark only supports png file.
InvalidParameter.InvalidDigitalWaterMarkType 無効なデジタル ウォーターマーク タイプです。 The specified parameter “%s” is invalid.
InvalidParameter.ListSizeExceed パラメーター リストの長さがしきい値を超えています。 The specified parameter “%s” size exceed the limit.
InvalidParameter.InvalidBase64Format パラメーターが Base64 形式に準拠していないため、無効です。 The specified parameter “%s” must be encoded by base64_urlsafe.
InvalidParameter.ServiceNotSupportRegion 機能がこのリージョンではサポートされていません。 The parameter region “%s” has not support the open video service.
DataEncryption.ContainerFormatNotSupported データが暗号化されています。サポートされていないコンテナー形式です。 The container format only support: m3u8.
DataEncryption.CiphertextNotExist データは暗号化されていますが、暗号文が存在しません。 The ciphertext does not exist.