SubmitSnapshotJob API は、スクリーンショット タスクを送信します。現在、JPG イメージがサポートされています。
- 同期モード: スクリーンショット API の応答と同時に、該当バケットにスクリーンショットが生成されます。
- 非同期モード:スクリーンショット API の応答と同時に、スクリーンショットが生成されないこともあります。スクリーンショット タスクはバックグラウンドで待機し、非同期にスクリーンショットを撮ります。Interval
または Num パラメーターが設定されている場合は、非同期モードとなります。
- メッセージ通知: PipelineId パラメーターが設定されている場合、スクリーンショット タスクが送信されると非同期メッセージが送信されます。
パラメーター |
タイプ |
必須 |
説明 |
Action |
String |
はい |
操作 API、システム必須パラメーター。パラメーターの値は SubmitSnapshotJob にします。 |
Input |
String |
はい |
タスク入力。JSON オブジェクト。Input の定義は、用語集を参照。例: {"Bucket":"example-bucket", "Location": "oss-cn-hangzhou", "Object": "example.flv"} コンソールで MPS にバケットへのアクセス権限を付与しておく必要があります。
|
SnapshotConfig |
String |
はい |
スクリーンショットの設定。JSON オブジェクト。詳細は、「付録」の「パラメーター」の「11. SnapshotConfig」を参照。例:- 同期モード:{"OutputFile": {"Bucket": "example-001","Location": "oss-cn-hangzhou", "Object": "example.jpg"},
"Time": "5"} - 非同期モード:(5 ミリ秒で開始、20秒毎にスクリーンショットが 1 つ撮られ、10 のスクリーンショットを撮る必要があります): {"OutputFile": {"Bucket": "example-001", "Location": "oss-cn-hangzhou", "Object":
"{Count}.jpg"}, "Time": "5", "Num":"10", "Interval":"20" }
|
PipelineId |
String |
いいえ |
MPS キュー ID。MPS キューが、利用可能なメッセージの件名にバインドされていることを確認します。バインドされていない場合、メッセージは正常に送信されません。 |
UserData |
String |
いいえ |
カスタム データ(最大 1024 バイト)。 |
リクエスト例
http://mts.cn-hangzhou.aliyuncs.com?Action=SubmitSnapshotJob&Input=%7b%22Bucket%22%3a%22example-bucket%22%2c%22Location%22%3a%22oss-cn-hangzhou%22%2c%22Object%22%3a%22example.flv%22%7d&SnapshotConfig=%7B%22OutputFile%22%3A%7B%22Bucket%22%3A%22example-001%22%2C%22Location%22%3A%22oss-cn-hangzhou%22%2C%22Object%22%3A%22example.jpg%22%7D%2C%22Time%22%3A%225%22%7D&PipelineId=88c6ca184c0e47098a5b665e2a126797<Public parameter>
XML 形式
<SubmitSnapshotJobResponse>
<RequestId>
25818875-5F78-4A13-BEF6-D7393642CA58
</RequestId>
<SnapshotJob>
<Id>88c6ca184c0e47098a5b665e2a126797</Id>
<State>Success</State>
<Code> </Code>
<Message> </Message>
<SnapshotConfig>
<OutputFile>
<Bucket>example-001</Bucket>
<Location>oss-cn-hangzhou</Location>
<Object>example.png</Object>
</OutputFile>
<Time>4</Time>
</SnapshotConfig>
<PipelineId>88c6ca184c0e47098a5b665e2a126797</PipelineId>
<UserData>testid-001</UserData>
<CreationTime>2014-01-10T12:00:00Z</CreationTime>
</SnapshotJob>
</SubmitSnapshotJobResponse>
JSON 形式
{
"RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
"SnapshotJob": {
"Id": "88c6ca184c0e47098a5b665e2a126797",
"State": "Success",
"Code": "",
"Message": "",
“SnapshotConfig”:{
"OutputFile": {
"Bucket": "example-001",
"Location": "oss-cn-hangzhou",
"Object": "example.png"
},
“Time”:”5”
},
"PipelineId": "88c6ca184c0e47098a5b665e2a126797",
"UserData": "testid-001",
"CreationTime": "2014-01-10T12:00:00Z"
}
}
エラーコード |
説明 |
詳細情報 |
InvalidParameter.ResourceNotFound |
スクリーンショットファイルが見つかりません。 |
The resource operated cannot be found. |
SnapshotTimeOut |
スクリーンショットがタイムアウトしました。同期モードで頻繁にタイムアウトする場合は、非同期モードにしてタイムアウトを避けることを推奨します。再試行は推奨しません。 |
Snapshot times out. |
InvalidParameter.ResourceContentBad |
スクリーンショット ファイルが破損しているか、スクリーンショットが仕様と合わないために取得できません。 |
The resource operated is broken. |
EntityNotExist.Role |
ロールがありません。 |
The role not exists. |
PermissionDenied.ResourceAccess |
操作権限がありません。 |
MTS is not authorized to operate on the specified resource. |
InternalError |
不明な内部エラー |
The operation has failed due to some unknown error, exception or failure. |
TransientNetWorkError |
データのダウンロード中に一時的なネットワークエラーが発生しています。通常、再試行するとダウンロードは回復します。 |
Snapshot fail, transient network error occurs, please try again. |