すべてのプロダクト
Search

このプロダクト

    :QuerySnapshotJobList

    ドキュメントセンター

    :QuerySnapshotJobList

    最終更新日:Jan 16, 2026

    スナップショットジョブを照会します。

    操作説明

    • 1 つ以上のスナップショットジョブ ID (SnapshotJobIds) を指定してスナップショットジョブを照会できます。また、ジョブ ID を指定せずに、ページングクエリを実行し、ステータス、作成時刻、または MPS キューでジョブをフィルターすることもできます。

    • この操作では、1 回の呼び出しで最大 10 個のスナップショットジョブを照会できます。

    • この操作の戻り値は、デフォルトで CreationTime の降順でソートされます。

    QPS 制限

    この操作は、ユーザーあたり 1 秒あたり 100 クエリ (QPS) に制限されています。この制限を超えると、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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    mts:QuerySnapshotJobList

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    SnapshotJobIds

    string

    任意

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

    • 一度に最大 10 個のジョブを照会できます。複数の ID はコンマ (,) で区切ります。

    • ジョブ ID は、MPS コンソールで [タスク管理] > [スナップショット] を選択して取得できます。また、SubmitSnapshotJob 操作のレスポンスパラメーターからも取得できます。

    72dfa5e679ab4be9a3ed9974c736****
    NextPageToken

    string

    任意

    次のページのトークン。32 ビットの汎用一意識別子 (UUID) です。

    • クエリ結果が切り捨てられた場合、NextPageToken パラメーターが返されます。このパラメーターの値は、クエリごとに更新されます。次のクエリでこのトークンを使用して、結果の次のページを取得します。

    cc6cbef8e8d5481ca536f5d2a466****
    MaximumPageSize

    integer

    任意

    ページングクエリの各ページで返すエントリの最大数。

    • 有効な値：[1, 300]。

    • デフォルト値：30。

    30
    State

    string

    任意

    照会するスナップショットジョブの状態。

    • Submitted：ジョブは送信済みです。

    • Snapshoting：ジョブは進行中です。

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

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

    Snapshoting
    StartOfJobCreatedTimeRange

    string

    任意

    ジョブ作成時間範囲の開始。

    • 日付形式は ISO 8601 標準に準拠し、協定世界時 (UTC) を使用する必要があります。

    • 形式は YYYY-MM-DDThh:mm:ssZ です。

    2014-01-10T12:00:00Z
    EndOfJobCreatedTimeRange

    string

    任意

    ジョブ作成時間範囲の終了。

    • 日付形式は ISO 8601 標準に準拠し、協定世界時 (UTC) を使用する必要があります。

    • 形式は YYYY-MM-DDThh:mm:ssZ です。

    2014-01-12T12:00:00Z
    PipelineId

    string

    任意

    MPS キューの ID。詳細については、「用語」をご参照ください。

    • MPS コンソールで [グローバル設定] > [パイプライン] を選択して、MPS キューを表示および作成できます。

    • 非同期通知メッセージを受信する場合は、MNS キューまたは Topic を MPS キューにアタッチします。詳細については、「メッセージ通知の受信」をご参照ください。

    b11c171cced04565b1f38f1ecc39****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    SnapshotJobList

    object

    SnapshotJob

    array<object>

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

    array<object>

    レスポンスパラメーター。

    CreationTime

    string

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

    2021-06-30T12:34:29Z
    SnapshotConfig

    object

    スナップショット設定。

    Time

    string

    スナップショットの開始時刻。単位：ミリ秒。

    4
    TileOut

    object

    モザイク設定。

    Padding

    string

    イメージ間の間隔。

    • デフォルト：0。

    • 単位：px。

    0
    Color

    string

    背景色。

    • デフォルト：black。

    • 有効な値：色キーワード、random。

    説明

    色のキーワードは 3 つの形式をサポートしています。たとえば、黒は Black、black、または #000000 として指定できます。

    black
    CellSelStep

    string

    単一イメージを選択するためのステップサイズ。

    3
    CellHeight

    string

    単一イメージの高さ。デフォルトはスナップショット出力の高さです。

    8
    CellWidth

    string

    単一イメージの幅。デフォルトはスナップショット出力の幅です。

    8
    Margin

    string

    外枠の幅。

    • デフォルト：0。

    • 単位：px。

    0
    Columns

    string

    モザイクの列数。デフォルト：10。

    10
    IsKeepCellPic

    string

    個々のイメージを保持するかどうかを示します。デフォルト：true。

    false
    Lines

    string

    モザイクの行数。デフォルト：10。

    10
    Interval

    string

    スナップショット間隔。

    • 指定した場合、一連のスナップショットを示し、値は 0 より大きい必要があります。

    • 単位：秒。

    • デフォルト値：10。

    10
    FrameType

    string

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

    • normal：通常フレーム。

    • intra：I フレーム。

    • デフォルト値：intra。

    intra
    Width

    string

    出力スナップショットイメージの幅。

    8
    Height

    string

    出力スナップショットイメージの高さ。

    8
    OutputFile

    object

    スナップショット出力の OSS 設定。

    RoleArn

    string

    指定されたロールの ARN。形式：acs:ram::$accountID:role/$roleName。

    acs:ram::1:role/testrole
    Object

    string

    スナップショットの出力ファイル (OSS オブジェクト)。

    example.png
    Location

    string

    出力 OSS バケットが配置されているデータセンター (OSS ロケーション)。

    example-location
    Bucket

    string

    出力ファイルが保存されている OSS バケット。

    example
    Num

    string

    スナップショットの数。指定した場合、一連のスナップショットを示します。

    10
    TileOutputFile

    object

    モザイクジョブのラージイメージ出力の OSS 設定。

    RoleArn

    string

    指定されたロールの ARN。形式：acs:ram::$accountID:role/$roleName。

    acs:ram::1:role/testrole
    Object

    string

    出力ファイル (OSS オブジェクト)。

    example.png
    Location

    string

    出力 OSS バケットが配置されているデータセンター (OSS ロケーション)。

    example-location
    Bucket

    string

    出力ファイルが保存されている OSS バケット。

    example
    TimeArray

    object

    TimePointList

    array

    指定された時点の配列。

    integer

    指定された時点の配列。単位：ミリ秒。これは小数点以下 2 桁の浮動小数点数です。時点は繰り返し可能で、任意の順序で送信できます。MPS がそれらをソートします。最大 100 の時点がサポートされています。このパラメーターを指定する場合、Num、Time、または Interval を指定しないでください。そうしないと、InvalidParameter.Ambiguity エラーが返されます。

    [10050, 50000, 110000, 1000500, 1100500]
    State

    string

    スナップショットジョブの状態。

    • Submitted：ジョブは送信済みです。

    • Snapshoting：ジョブは進行中です。

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

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

    Snapshoting
    Message

    string

    分析が失敗した場合に返されるエラーメッセージ。ジョブが成功した場合、このパラメーターは返されません。

    The resource operated InputFile is bad
    MNSMessageResult

    object

    ジョブが完了したときにユーザーに送信される MNS 通知の結果。

    MessageId

    string

    メッセージの ID。ジョブが失敗した場合、このパラメーターは返されません。

    799454621135656C7F815F198A76****
    ErrorMessage

    string

    エラーメッセージ。ジョブが成功した場合、このパラメーターは返されません。

    The resource operated InputFile is bad
    ErrorCode

    string

    エラーコード。ジョブが成功した場合、このパラメーターは返されません。

    InvalidParameter
    Input

    object

    ジョブ入力。

    RoleArn

    string

    指定されたロールの ARN。形式：acs:ram::$accountID:role/$roleName。

    acs:ram::1:role/testrole
    Object

    string

    入力ファイル (OSS オブジェクト)。

    example.flv
    Location

    string

    入力 OSS バケットが配置されているデータセンター (OSS ロケーション)。

    example-location
    Bucket

    string

    入力ファイルが保存されている OSS バケット。

    example
    Count

    string

    キャプチャされたイメージの数。

    1
    TileCount

    string

    モザイク内のイメージの数。

    7
    UserData

    string

    ユーザー定義データ。

    testid-001
    Code

    string

    分析が失敗した場合に返されるエラーコード。ジョブが成功した場合、このパラメーターは返されません。

    InvalidParameter
    PipelineId

    string

    パイプライン ID。

    b11c171cced04565b1f38f1ecc39****
    Id

    string

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

    cc6cbef8e8d5481ca536f5d2a466****
    RequestId

    string

    リクエストの ID。

    34BCAB31-2833-43A7-9FBD-B34302AB23EQ
    NonExistSnapshotJobIds

    object

    String

    array

    存在しないスナップショットジョブ ID のリスト。

    string

    存在しないスナップショットジョブ ID の詳細。データが存在しない場合、このパラメーターは返されません。

    c6d973c33d1c4b21bc39907d3b29****
    NextPageToken

    string

    次のページのトークン。32 ビットの UUID です。このパラメーターは、クエリ結果が切り捨てられた場合に返されます。このパラメーターの値は、クエリごとに更新されます。

    b11c171cced04565b1f38f1ecc39****

    例

    成功レスポンス

    JSONJSON

    {
  "SnapshotJobList": {
    "SnapshotJob": [
      {
        "CreationTime": "2021-06-30T12:34:29Z",
        "SnapshotConfig": {
          "Time": "4",
          "TileOut": {
            "Padding": "0",
            "Color": "black",
            "CellSelStep": "3",
            "CellHeight": "8",
            "CellWidth": "8",
            "Margin": "0",
            "Columns": "10",
            "IsKeepCellPic": "false",
            "Lines": "10"
          },
          "Interval": "10",
          "FrameType": "intra",
          "Width": "8",
          "Height": "8",
          "OutputFile": {
            "RoleArn": "acs:ram::1:role/testrole",
            "Object": "example.png",
            "Location": "example-location",
            "Bucket": "example"
          },
          "Num": "10",
          "TileOutputFile": {
            "RoleArn": "acs:ram::1:role/testrole",
            "Object": "example.png",
            "Location": "example-location",
            "Bucket": "example"
          },
          "TimeArray": {
            "TimePointList": [
              0
            ]
          }
        },
        "State": "Snapshoting",
        "Message": "The resource operated InputFile is bad",
        "MNSMessageResult": {
          "MessageId": "799454621135656C7F815F198A76****",
          "ErrorMessage": "The resource operated InputFile is bad",
          "ErrorCode": "InvalidParameter"
        },
        "Input": {
          "RoleArn": "acs:ram::1:role/testrole",
          "Object": "example.flv",
          "Location": "example-location",
          "Bucket": "example"
        },
        "Count": "1",
        "TileCount": "7",
        "UserData": "testid-001",
        "Code": "InvalidParameter",
        "PipelineId": "b11c171cced04565b1f38f1ecc39****",
        "Id": "cc6cbef8e8d5481ca536f5d2a466****"
      }
    ]
  },
  "RequestId": "34BCAB31-2833-43A7-9FBD-B34302AB23EQ",
  "NonExistSnapshotJobIds": {
    "String": [
      "c6d973c33d1c4b21bc39907d3b29****"
    ]
  },
  "NextPageToken": "b11c171cced04565b1f38f1ecc39****"
}

    エラーコード

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

    変更履歴

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