QuerySnapshotJobList - 查詢截圖作業結果 -

查詢截圖作業。

介面說明

您可以指定多個截圖作業 ID（SnapshotJobIds）進行查詢。或不指定具體的截圖作業 ID，通過篩選截圖狀態、建立時間、管道等條件，進行分頁查詢。
本介面一次最多查詢 10 個截圖作業。
本介面傳回值預設按 CreationTime 降序排列。

QPS 限制

本介面的單使用者 QPS 限制為 100 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。更多資訊，請參見 QPS 限制。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

mts:QuerySnapshotJobList

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
SnapshotJobIds	string	否	截圖作業 ID 列表。一次最多查詢 10 個，半形逗號（,）分隔。可以通過 MPS 控制台>任務管理>截圖擷取，也可以從提交截圖作業的返回參數中擷取。	72dfa5e679ab4be9a3ed9974c736****
NextPageToken	string	否	下一頁標識，32 位 UUID。查詢結果大於一頁會返回 NextPageToken 參數，每次查詢值都會更新。擷取後請在下一次查詢時填入。	cc6cbef8e8d5481ca536f5d2a466****
MaximumPageSize	integer	否	分頁查詢每頁最大返回數。取值範圍：[1,300]。預設值：30 。	30
State	string	否	需要查詢的截圖狀態。 Submitted：已提交。 Snapshoting：截圖中。 Success：截圖成功。 Fail：截圖失敗。	Snapshoting
StartOfJobCreatedTimeRange	string	否	最早任務建立時間。日期格式按照 ISO8601 標準表示，並需要使用 UTC 時間。格式為：YYYY-MM-DDThh:mm:ssZ 。	2014-01-10T12:00:00Z
EndOfJobCreatedTimeRange	string	否	最晚任務建立時間。日期格式按照 ISO8601 標準表示，並需要使用 UTC 時間。格式為：YYYY-MM-DDThh:mm:ssZ 。	2014-01-12T12:00:00Z
PipelineId	string	否	管道 ID。詳細資料請參見基本概念。可選值：可以通過 MPS 控制台>全域設定>管道查詢和建立。如果需要非同步通知，請為管道綁定 MNS 訊息，詳細說明請參見接收訊息通知。	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。說明其中顏色關鍵字支援三種格式，比如黑色，支援 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 Object）。	example.png
Location	string	截圖輸出 OSS Bucket 所在資料中心（OSS Location）。	example-location
Bucket	string	截圖輸出檔案所在 OSS Bucket。	example
Num	string	截圖數量。若指定則表示序列截圖。	10
TileOutputFile	object	拼圖任務大圖的輸出 OSS 配置。
RoleArn	string	指定角色的 ARN。格式：acs:ram::$accountID:role/$roleName。	acs:ram::1:role/testrole
Object	string	輸出檔案（OSS Object）。	example.png
Location	string	輸出 OSS Bucket 所在資料中心（OSS Location）。	example-location
Bucket	string	輸出檔案所在 OSS Bucket。	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 Object）。	example.flv
Location	string	輸入 OSS Bucket 所在資料中心（OSS Location）。	example-location
Bucket	string	輸入檔案所在 OSS Bucket。	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****

樣本

正常返回樣本

JSON格式

{
  "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****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。