SubmitSnapshotJob API を使用した動画スナップショットの作成 - VOD - Alibaba Cloud - ApsaraVideo VOD

ビデオスナップショットジョブを送信し、非同期スナップショット処理を開始します。

操作説明

これは非同期操作です。タスクを送信すると、タスク ID が返されます（タスクはまだ完了しておらず、非同期実行のためのキューに入ります）。最終結果はコールバック通知を通じて送信されます。タスク詳細の取得を呼び出して、タスクのステータスを能動的にクエリすることもできます。
JPG 画像のみがサポートされています。
スナップショットが完了すると、EventType=SnapshotComplete および SubType=SpecifiedTime のビデオスナップショット完了イベント通知が送信されます。

QPS 制限

この操作における単一ユーザーの QPS 制限は、1 秒あたり 30 回の呼び出しです。この制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。この操作は適切に呼び出してください。詳細については、「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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vod:SubmitSnapshotJob

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
VideoId	string	任意	ビデオ ID。以下のいずれかの方法でビデオ ID を取得できます。コンソールからアップロードされたビデオの場合、ApsaraVideo VOD コンソールにログインし、メディアファイル > オーディオ/ビデオを選択してビデオ ID をビューに表示します。アップロード URL と認証情報を取得するために CreateUploadVideo 操作を呼び出した際、VideoId レスポンスパラメーターの値からビデオ ID を取得します。ビデオのアップロード後、 SearchMedia 操作を呼び出してビデオ ID をクエリします。これは VideoId レスポンスパラメーターの値です。	d3e680e618708efbf2cae7cc9312****
SpecifiedOffsetTime	integer	任意	スナップショットの開始時刻。単位: ミリ秒。デフォルト値: 0。	0
Width	string	任意	スナップショットの幅。有効な値: `[8,4096]`。デフォルト値: ソースビデオの幅。単位: px。	1280
Height	string	任意	スナップショットの高さ。有効な値: `[8,4096]`。デフォルト値: ソースビデオの高さ。単位: px。	720
Count	integer	任意	スナップショットの最大値。デフォルト値: 1。	1
Interval	integer	任意	スナップショット間隔。値は 0 以上である必要があります。単位: 秒。デフォルト値: 1。 Interval が 0 に設定されている場合、Count の値とビデオの持続時間に基づいて均等にスナップショットがキャプチャされます。	1
SpriteSnapshotConfig	string	任意	スプライト構成。このパラメーターが空でない場合、スプライトが生成されます。パラメーター構造の詳細については、「 SpriteSnapshotConfig 」を参照してください。	{'CellWidth': 120, 'CellHeight': 68, 'Columns': 3,'Lines': 10, 'Padding': 20, 'Margin': 50}
SnapshotTemplateId	string	任意	スナップショットテンプレート ID。まずスナップショットテンプレートを作成し、そのスナップショットテンプレート ID を渡すことを推奨します。スナップショットテンプレートの作成方法の詳細については、「スナップショットテンプレートの追加」を参照してください。スナップショットテンプレート ID を渡した場合、Action と VideoId を除くすべてのリクエストパラメーターは無視されます。	f5b228fe693bf55bd87b789****
UserData	string	任意	カスタム設定。JSON 文字列のみがサポートされています。このパラメーターを使用してカスタムデータをパススルーし、コールバック URL 設定のセットを指定できます。パラメーター構造の詳細については、「 UserData 」を参照してください。説明このパラメーターでメッセージコールバックを使用するには、コンソールで HTTP コールバック URL を設定し、対応するコールバックイベントタイプを選択する必要があります。そうしないと、コールバック設定は効果がありません。	{"MessageCallback":{"CallbackURL":"http://.example.aliyundoc.com"},"Extend":{"localId":"xxx","example":"www"}}
SpecifiedOffsetTimes	array	任意	スナップショットがキャプチャされる時間ポイント。単位: ミリ秒。一度に最大 30 個の時間ポイントを指定できます。
	integer	任意	カスタム時間ポイント。単位: ミリ秒。	1000
ReferenceId	string	任意	カスタム ID。小文字、大文字、数字、ハイフン、アンダースコアのみがサポートされています。長さ: 6〜64 文字。値はユーザーレベルで一意である必要があります。	123-123

説明

Count または Interval の少なくとも一方を指定する必要があります。両方が指定されている場合、少ない方のスナップショット数が優先されます。

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	25818875-5F78-5EB0-4AF6-D7393642****
SnapshotJob	object	スナップショットジョブ情報。
JobId	string	スナップショットジョブ ID。	ad90a501b1b94b72374ad0050464****

例

成功レスポンス

JSONJSON

{
  "RequestId": "25818875-5F78-5EB0-4AF6-D7393642****",
  "SnapshotJob": {
    "JobId": "ad90a501b1b94b72374ad0050464****"
  }
}

エラーコード

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

変更履歴

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