SubmitSnapshotJob - - Alibaba Cloud ドキュメントセンター

この操作を呼び出して、ビデオスナップショットジョブを送信し、非同期処理を実行します。

操作説明

JPG 形式のイメージのみがサポートされています。
スナップショットジョブが完了すると、SnapshotComplete イベント通知が生成されます。イベントタイプは `EventType=SnapshotComplete` で、サブタイプは `SubType=SpecifiedTime` です。

QPS 制限

この操作における単一ユーザーの 1 秒あたりのクエリ数 (QPS) 制限は、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 を表示します。 CreateUploadVideo 操作を呼び出してアップロード URL と認証情報を取得すると、応答の `VideoId` パラメーターの値がビデオ ID になります。ビデオがアップロードされた後、SearchMedia 操作を呼び出してビデオ ID をクエリできます。応答の `VideoId` パラメーターの値がビデオ ID になります。	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 を指定してスナップショットジョブを構成できます。スナップショットテンプレートの作成方法の詳細については、「AddVodTemplate」をご参照ください。スナップショットテンプレート ID を指定した場合、`Action` と `VideoId` を除く他のすべてのリクエストパラメーターは無視されます。スナップショットテンプレート ID を指定した場合、テンプレートのパラメーターは同じ名前の他のリクエストパラメーターをオーバーライドします。	f5b228fe693bf55bd87b789****
UserData	string	任意	カスタム設定。このパラメーターは JSON 文字列である必要があります。カスタムデータのパススルーと Webhook アドレスの設定をサポートしています。パラメーター構造の詳細については、「UserData」をご参照ください。説明このパラメーターでメッセージコールバック機能を使用するには、コンソールで HTTP Webhook アドレスを構成し、対応するイベントタイプを選択する必要があります。そうしないと、コールバック設定は有効になりません。	{"MessageCallback":{"CallbackURL":"http://.example.aliyundoc.com"},"Extend":{"localId":"xxx","example":"www"}}
SpecifiedOffsetTimes	array	任意	スナップショットをキャプチャする時刻。単位：ミリ秒。最大 30 個の時刻を指定できます。
	integer	任意	カスタムの時刻。単位：ミリ秒。	1000
ReferenceId	string	任意	カスタム ID。 ID には、小文字、大文字、数字、ハイフン (-)、アンダースコア (_) のみを含めることができます。 ID の長さは 6～64 文字である必要があります。 ID はユーザーごとに一意である必要があります。	123-123

説明

`Count` パラメーターと `Interval` パラメーターの少なくとも 1 つを指定する必要があります。両方のパラメーターを指定した場合、スナップショット数が少なくなる方が優先されます。

レスポンスフィールド

フィールド	型	説明	例
	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****"
  }
}

エラーコード

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

変更履歴

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