スナップショットジョブの情報を取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
ice:GetSnapshotJob |
* すべてのリソース
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| JobId |
文字列 |
必須 |
スナップショットジョブの ID。 |
d80e4e4044975745c14b |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
PlainResponse |
||
| RequestId |
文字列 |
リクエスト ID。 |
******11-DB8D-4A9A-875B-275798****** |
| SnapshotJob |
object |
スナップショットジョブに関する情報。 |
|
| JobId |
文字列 |
ジョブ ID。 |
****d80e4e4044975745c14b**** |
| TriggerSource |
文字列 |
リクエストのトリガーソース。 有効な値:
列挙値:
|
API |
| Name |
文字列 |
ジョブの名前。 |
Test task |
| Type |
文字列 |
スナップショットタイプ。 有効な値:
列挙値:
|
Sprite |
| Input |
object |
ジョブの入力。 |
|
| Type |
文字列 |
入力ファイルのタイプ。有効な値:
|
OSS |
| Media |
文字列 |
入力ファイル。Type が OSS に設定されている場合、OSS オブジェクトの URL が返されます。Type が Media に設定されている場合、メディアアセットの ID が返されます。OSS オブジェクトの URL は、次のいずれかの形式です。
|
oss://test-bucket/object.mp4 |
| OssFile |
object |
OSS の 3 つのキーエレメント。 |
|
| Bucket |
文字列 |
OSS バケット。 |
test-bucket |
| Location |
文字列 |
OSS のロケーション。 |
oss-cn-shanghai |
| Object |
文字列 |
OSS オブジェクト。 |
object.mp4 |
| Output |
object |
ジョブの出力。 |
|
| Type |
文字列 |
出力ファイルのタイプ。有効な値:
|
OSS |
| Media |
文字列 |
出力ファイル。Type が OSS に設定されている場合、OSS オブジェクトの URL が返されます。Type が Media に設定されている場合、メディアアセットの ID が返されます。OSS オブジェクトの URL は、次のいずれかの形式です。
URL 内の bucket は、ジョブと同じリージョンにある OSS バケットです。 object は、OSS 内のオブジェクト URL です。複数の静的スナップショットがキャプチャされた場合、 object にはプレースホルダー "{Count}" を含める必要があります。スプライトの場合、 object にはプレースホルダー "{TileCount}" を含める必要があります。 WebVTT スナップショットオブジェクトのサフィックスは ".vtt" である必要があります。 |
http://test-bucket.oss-cn-shanghai.aliyuncs.com/output-{Count}.jpg |
| OssFile |
object |
OSS の 3 つのキーエレメント。 |
|
| Bucket |
文字列 |
OSS バケット。 |
test-bucket |
| Location |
文字列 |
OSS のロケーション。 |
oss-cn-shanghai |
| Object |
文字列 |
OSS オブジェクト。 |
output-{Count}.jpg |
| Count |
整数 |
スナップショットの数。 |
8 |
| Async |
ブール値 |
スナップショットが非同期モードでキャプチャされたかどうかを示します。デフォルト値:true。 |
true |
| TemplateId |
文字列 |
テンプレート ID。 |
****d80e4e4044975745c14b**** |
| TemplateConfig |
文字列 |
スナップショットテンプレートの設定。 |
{"Type":"Normal","FrameType":"normal","Time":0,"Count":10} |
| PipelineId |
文字列 |
ジョブが送信された MPS キューの ID。 |
****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 |
例
成功レスポンス
JSONJSON
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"SnapshotJob": {
"JobId": "****d80e4e4044975745c14b****",
"TriggerSource": "API",
"Name": "Test task",
"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": "Success",
"Message": "",
"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"
}
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。