すべてのプロダクト
Search

このプロダクト

    Intelligent Media Services:GetSnapshotJob

    ドキュメントセンター

    Intelligent Media Services:GetSnapshotJob

    最終更新日:Mar 21, 2026

    スナップショットジョブに関する情報を照会します。

    今すぐお試しください

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

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    JobId

    string

    必須

    スナップショットジョブの ID。

    ****d80e4e4044975745c14b****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    PlainResponse

    RequestId

    string

    リクエスト ID。

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

    object

    スナップショットジョブに関する情報。

    JobId

    string

    ジョブ ID。

    ****d80e4e4044975745c14b****
    TriggerSource

    string

    リクエストのトリガーソース。

    有効な値:

    • Console

    • Workflow

    • API

    列挙値:

    • Console :
    • Workflow :
    • API :

      API

    API
    Name

    string

    ジョブの名前。

    测试任务
    Type

    string

    スナップショットタイプ

    有効な値:

    • WebVtt

    • Sprite

    • Normal

    列挙値:

    • WebVtt :
    • Sprite :
    • Normal :

    Sprite
    Input

    object

    ジョブの入力。

    Type

    string

    入力ファイルのタイプ。有効な値:

    1. OSS: Object Storage Service (OSS) オブジェクト。

    2. Media: メディアアセット。

    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 URL では、bucket はジョブと同じリージョンにある OSS バケットを指定し、object は OSS 内のオブジェクト URL を指定します。

    oss://test-bucket/object.mp4
    OssFile

    object

    OSS の 3 つの主要な要素。

    Bucket

    string

    OSS バケット。

    test-bucket
    Location

    string

    OSS ロケーション。

    oss-cn-shanghai
    Object

    string

    OSS オブジェクト。

    object.mp4
    Output

    object

    ジョブの出力。

    Type

    string

    出力ファイルのタイプ。有効な値:

    1. OSS: OSS オブジェクト。

    2. Media: メディアアセット。

    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

    URL では、bucket はジョブと同じリージョンにある OSS バケットを指定し、object は OSS 内のオブジェクト URL を指定します。複数の静的スナップショットがキャプチャされた場合、オブジェクトには「{Count}」プレースホルダーを含める必要があります。スプライトの場合、オブジェクトには「{TileCount}」プレースホルダーを含める必要があります。WebVTT スナップショットオブジェクトのサフィックスは「.vtt」である必要があります。

    http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg
    OssFile

    object

    OSS の 3 つの主要な要素。

    Bucket

    string

    OSS バケット。

    test-bucket
    Location

    string

    OSS ロケーション。

    oss-cn-shanghai
    Object

    string

    OSS オブジェクト。

    output-{Count}.jpg
    Count

    integer

    スナップショットの数。

    8
    Async

    boolean

    スナップショットが非同期モードでキャプチャされたかどうかを示します。デフォルト値: true。

    true
    TemplateId

    string

    テンプレート ID。

    ****d80e4e4044975745c14b****
    TemplateConfig

    string

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

    {"Type":"Normal","FrameType":"normal","Time":0,"Count":10}
    PipelineId

    string

    ジョブが送信された MPS キューの ID。

    ****d80e4e4044975745c14b****
    Status

    string

    ジョブの状態。

    有効な値:

    • Init: ジョブが送信されました。

    • Success: ジョブは成功しました。

    • Fail: ジョブは失敗しました。

    列挙値:

    • Init :
    • Success :
    • Fail :

    Success
    Code

    string

    エラーコード

    ResourceNotFound
    Message

    string

    返されるエラーメッセージ。

    The specified resource for "Pipeline" could not be found.
    SubmitTime

    string

    ジョブが送信された時刻。

    2022-07-12T16:17:54Z
    FinishTime

    string

    ジョブが完了した時刻。

    2022-07-12T16:30:54Z
    UserData

    string

    ユーザー定義パラメーター。

    {"test parameter": "test value"}
    CreateTime

    string

    ジョブが作成された時刻。

    2022-07-12T16:17:54Z
    ModifiedTime

    string

    ジョブが最後に変更された時刻。

    2022-07-12T16:30:54Z

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "SnapshotJob": {
    "JobId": "****d80e4e4044975745c14b****",
    "TriggerSource": "API",
    "Name": "测试任务",
    "Type": "Sprite",
    "Input": {
      "Type": "OSS",
      "Media": "oss://test-bucket/object.mp4",
      "OssFile": {
        "Bucket": "test-bucket",
        "Location": "oss-cn-shanghai",
        "Object": "object.mp4"
      }
    },
    "Output": {
      "Type": "OSS",
      "Media": "http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg",
      "OssFile": {
        "Bucket": "test-bucket",
        "Location": "oss-cn-shanghai",
        "Object": "output-{Count}.jpg"
      }
    },
    "Count": 8,
    "Async": true,
    "TemplateId": "****d80e4e4044975745c14b****",
    "TemplateConfig": "{\"Type\":\"Normal\",\"FrameType\":\"normal\",\"Time\":0,\"Count\":10}",
    "PipelineId": "****d80e4e4044975745c14b****",
    "Status": "Success",
    "Code": "ResourceNotFound",
    "Message": "The specified resource for \"Pipeline\" could not be found.",
    "SubmitTime": "2022-07-12T16:17:54Z",
    "FinishTime": "2022-07-12T16:30:54Z",
    "UserData": "{\"test parameter\": \"test value\"}",
    "CreateTime": "2022-07-12T16:17:54Z",
    "ModifiedTime": "2022-07-12T16:30:54Z"
  }
}

    エラーコード

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

    変更履歴

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