すべてのプロダクト
Search

このプロダクト

    Intelligent Media Services:SubmitSnapshotJob

    ドキュメントセンター

    Intelligent Media Services:SubmitSnapshotJob

    最終更新日:Apr 07, 2026

    この API は、スナップショットジョブを送信するために使用されます。メディアファイルの ID または URL、時点、および目的のフォーマットを指定すると、API はスナップショットを生成し、指定された場所に保存します。

    操作説明

    これは非同期インターフェイスです。タスクを送信するとタスク ID が返され、タスクは非同期処理のためにキューに追加されます。最終結果はコールバックによって配信されます。または、スクリーンショットタスク詳細を照会してタスクのステータスを確認することもできます。

    今すぐお試しください

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

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Name

    string

    任意

    スナップショットジョブの名前。

    SampleJob
    Input

    object

    必須

    スナップショットジョブの入力。

    Type

    string

    必須

    入力のタイプ。有効な値：

    • OSS：OSS ファイル URL。

    • Media：メディアアセット ID。

    Media
    Media

    string

    必須

    入力メディアアセット。

    • Type が OSS の場合、入力ファイルの OSS URL を指定します。

    • Type が Media の場合、メディアアセットの ID を指定します。

    OSS URL は、次のいずれかのフォーマットである必要があります：

    1. oss://bucket/object

    2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object
      これらのフォーマットでは、bucket は現在のプロジェクトと同じリージョンにある OSS バケットの名前で、object はファイルパスです。

    説明

    URL で指定された OSS バケットは、使用前に IMS のストレージ管理に追加する必要があります。

    oss://bucket/object.mp4
    Output

    object

    必須

    スナップショットジョブの出力先。

    Type

    string

    必須

    出力のタイプ。有効な値：

    • OSS：OSS ファイル URL。

    • Media：メディアアセット ID。

    OSS
    Media

    string

    必須

    出力メディアアセット。

    • Type が OSS の場合、出力ファイルの OSS URL を指定します。

    • Type が Media の場合、出力メディアアセットの ID を指定します。

    OSS URL は、次のいずれかのフォーマットである必要があります：

    1. oss://bucket/object

    2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object

    これらのフォーマットでは、bucket は現在のプロジェクトと同じリージョンにある OSS バケットの名前で、object はファイルパスです。

    • 複数の静的スナップショットをキャプチャする場合、object には {Count} プレースホルダーを含める必要があります。

    • スプライトをキャプチャする場合、object には {TileCount} プレースホルダーを含める必要があります。

    • WebVTT スナップショットの場合、object パス内のファイル名は .vtt で終わる必要があります。

    説明

    URL で指定された OSS バケットは、使用前に IMS のストレージ管理に追加する必要があります。

    oss://test-bucket/output-{Count}.jpg
    TemplateConfig

    object

    必須

    スナップショットテンプレート設定。

    TemplateId

    string

    必須

    スナップショットテンプレートの ID。

    ****96e8864746a0b6f3****

    OverwriteParams

    object

    任意

    指定されたテンプレートの設定を上書きするためのパラメーター。

    Type

    string

    任意

    スナップショットタイプ。

    Sprite
    FrameType

    string

    任意

    フレームタイプ。

    intra
    Count

    integer

    任意

    キャプチャするスナップショットの数。

    5
    Interval

    integer

    任意

    スナップショット間の間隔。

    10
    Time

    integer

    任意

    スナップショットをキャプチャする開始時刻。

    1000
    Width

    integer

    任意

    出力画像の幅。

    720
    Height

    integer

    任意

    出力画像の高さ。

    480
    BlackLevel

    integer

    任意

    最初のフレームで黒いコンテンツを検出およびフィルターするためのしきい値。これは複数フレームのスナップショットにのみ適用されます。

    30
    PixelBlackThreshold

    integer

    任意

    ピクセルが黒いかどうかを判断するためのしきい値。

    70
    SpriteSnapshotConfig

    object

    任意

    スプライト設定。

    CellWidth

    integer

    任意

    各タイルの幅。デフォルト：出力スナップショットの幅。

    720
    CellHeight

    integer

    任意

    各タイルの高さ。デフォルト：出力スナップショットの高さ。

    480
    Padding

    integer

    任意

    タイル間のパディング (ピクセル単位)。デフォルト値：0。

    20
    Margin

    integer

    任意

    スプライトの周囲のマージン (ピクセル単位)。デフォルト値：0。

    20
    Columns

    integer

    任意

    スプライトグリッドの列数。

    20
    Lines

    integer

    任意

    スプライトグリッドの行数。

    20
    Color

    string

    任意

    背景色。

    #000000
    IsSptFrag

    boolean

    任意

    スナップショットを単一のスプライトに結合するかどうかを指定します。これは WebVTT スナップショットにのみ適用されます。

    true
    ScheduleConfig

    object

    任意

    スケジューリング設定。

    PipelineId

    string

    任意

    パイプライン ID。

    ****96e8864746a0b6f3****

    UserData

    string

    任意

    カスタムユーザーデータ。JSON 形式の文字列として渡されます。

    {"test parameter": "test value"}

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答オブジェクト。

    RequestId

    string

    リクエストの一意の識別子。

    ******11-DB8D-4A9A-875B-275798******
    JobId

    string

    送信されたジョブの ID。

    ****20b48fb04483915d4f2cd8ac****

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "JobId": "****20b48fb04483915d4f2cd8ac****"
}

    エラーコード

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

    変更履歴

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