SubmitSnapshotJob - - Centre de documentation Alibaba Cloud

Remarque

Seules les captures au format JPG sont générées.
Une fois la tâche de capture terminée, ApsaraVideo VOD envoie une notification d'événement SnapshotComplete contenant EventType=SnapshotComplete et SubType=SpecifiedTime.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer pour plus de commodité. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	SubmitSnapshotJob	L'opération à effectuer. Définissez la valeur sur SubmitSnapshotJob.
VideoId	String	Yes	d3e680e618708*****efbf2cae7cc931	ID de la vidéo.
SpecifiedOffsetTime	Long	No	0	Heure de début de la période de capture spécifiée. Unité : millisecondes. Valeur par défaut : 0.
Width	String	No	1280	Largeur de chaque capture. Valeurs valides : `[8,4096]`. Par défaut, la largeur du fichier source de la vidéo est utilisée. Unité : pixel.
Height	String	No	720	Hauteur de chaque capture. Valeurs valides : `[8,4096]`. Par défaut, la hauteur du fichier source de la vidéo est utilisée. Unité : pixel.
Count	Long	No	1	Nombre maximal de captures. Valeur par défaut : 1.
Interval	Long	No	1	Intervalle entre les captures. La valeur doit être supérieure ou égale à 0. Unité : secondes. Si vous définissez ce paramètre sur 0, les captures sont prises à intervalles réguliers en fonction de la durée de la vidéo divisée par la valeur du paramètre Count. Valeur par défaut : 1.
SpriteSnapshotConfig	String	No	{'CellWidth': 120, 'CellHeight': 68, 'Columns': 3,'Lines': 10, 'Padding': 20, 'Margin': 50}	Configuration des captures sprite. Si vous définissez ce paramètre, des captures sprite sont générées. Pour plus d'informations, consultez SpriteSnapshotConfig.
SnapshotTemplateId	String	No	f5b228fe693*****bf55bd87789	ID du modèle de capture. Nous vous recommandons de créer un modèle de capture avant de spécifier son ID. Si vous définissez le paramètre SnapshotTemplateId, tous les autres paramètres de requête, à l'exception des paramètres Action et VideoId, sont ignorés. Pour plus d'informations sur la création d'un modèle de capture, consultez AddVodTemplate.
UserData	String	No	{"MessageCallback":{"CallbackURL":"http://test.test.com"},"Extend":{"localId":"xxx","test":"www"}}	Configurations personnalisées, y compris la configuration de la transmission transparente des données et les configurations de rappel. La valeur est une chaîne au format JSON. Pour plus d'informations, consultez UserData. Remarque Les configurations de rappel prennent effet uniquement lorsque vous spécifiez l'URL de rappel HTTP et sélectionnez les événements de rappel spécifiques dans la console ApsaraVideo VOD.

Remarque

Vous devez définir au moins l'un des paramètres Count ou Interval. Si vous définissez les deux, le paramètre générant le moins de captures est pris en compte.

Paramètres de réponse

Parameter

Type

Example

Description

| RequestId | String | 25818875-5F78-4A*F6-D7393642CA58 |

ID de la requête.

|

| SnapshotJob | Struct | |

Informations relatives à la tâche de capture.

|

| JobId | String | ad90a501b1b94b*72374ad005046 |

ID de la tâche de capture.

|

Exemples

Exemples de requêtes

https://vod.{ApiRegion}.aliyuncs.com/?Action=SubmitSnapshotJob
&VideoId=d3e680e618708*****efbf2cae7cc931
&<Common request parameters>

Exemples de réponses réussies

Format XML

<SubmitSnapshotJobResponse>
      <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>
      <SnapshotJob>
            <JobId>ad90a501b1b94b*****72374ad005046</JobId>
      </SnapshotJob>
</SubmitSnapshotJobResponse>

Format JSON

{
    "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
    "SnapshotJob": {
        "JobId": "ad90a501b1b94b*****72374ad005046"
    }
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs de l'API.

Erreurs courantes

Le tableau suivant décrit les erreurs courantes que cette opération peut renvoyer.

Error code

Error message

HTTP status code

Description

|

InvalidVideo.NotFound

|

The video does not exist.

|

404

|

La vidéo n'existe pas.

|

NoSuchResource

|

The specified resource %s does not exist.

|

404

|

La ressource spécifiée n'existe pas.

|

Forbidden.IllegalStatus

|

Status of the video is illegal.

|

400

|

L'état de la vidéo est invalide. Vous pouvez soumettre une tâche de capture pour une vidéo uniquement si celle-ci se trouve dans l'état UploadSucc, Normal, Checking ou Blocked.

|

Exemples de SDK

Nous vous recommandons d'utiliser un SDK serveur pour appeler cette opération. Pour plus d'informations sur l'exemple de code utilisé pour appeler cette opération dans divers langages, consultez les rubriques suivantes :