SubmitSnapshotJob - - Centre de documentation Alibaba Cloud

Soumet une tâche de capture d'instantanés vidéo pour démarrer le traitement asynchrone des instantanés.

Description de l'opération

Il s'agit d'une opération asynchrone. Après avoir soumis une tâche, l'identifiant de la tâche est renvoyé (la tâche n'est pas encore terminée et entre dans une file d'attente pour une exécution asynchrone). Le résultat final est envoyé via une notification de rappel. Vous pouvez également interroger de manière proactive l'état de la tâche en appelant Obtenir les détails de la tâche.
Seules les images JPG sont prises en charge.
Lorsque la capture d'instantanés est terminée, une notification d'événement Capture d'instantané vidéo terminée avec EventType=SnapshotComplete et SubType=SpecifiedTime est envoyée.

Limite de QPS

La limite de QPS pour un seul utilisateur sur cette opération est de 30 appels par seconde. Si cette limite est dépassée, l'appel d'API est limité, ce qui peut affecter votre activité. Appelez cette opération de manière appropriée. Pour plus d'informations, consultez Limite de QPS.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

vod:SubmitSnapshotJob

create

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
VideoId	string	Non	L'identifiant de la vidéo. Vous pouvez obtenir l'identifiant de la vidéo en utilisant l'une des méthodes suivantes : Pour les vidéos téléchargées via la console, connectez-vous à la console ApsaraVideo VOD et choisissez Fichiers multimédias > Audio/Vidéo pour afficher l'identifiant de la vidéo. Obtenez l'identifiant de la vidéo à partir de la valeur du paramètre de réponse VideoId lorsque vous appelez l'opération CreateUploadVideo pour obtenir l'URL et les informations d'identification de téléchargement. Une fois la vidéo téléchargée, appelez l'opération SearchMedia pour interroger l'identifiant de la vidéo, qui correspond à la valeur du paramètre de réponse VideoId.	d3e680e618708efbf2cae7cc9312****
SpecifiedOffsetTime	integer	Non	L'heure de début pour la capture d'instantanés. Unité : millisecondes. Valeur par défaut : 0.	0
Width	string	Non	La largeur de l'instantané. Valeurs valides : `[8,4096]`. Valeur par défaut : la largeur de la vidéo source. Unité : px.	1280
Height	string	Non	La hauteur de l'instantané. Valeurs valides : `[8,4096]`. Valeur par défaut : la hauteur de la vidéo source. Unité : px.	720
Count	integer	Non	Le nombre maximal d'instantanés. Valeur par défaut : 1.	1
Interval	integer	Non	L'intervalle de capture d'instantanés. La valeur doit être supérieure ou égale à 0. Unité : secondes. Valeur par défaut : 1. Si Interval est défini sur 0, les instantanés sont capturés de manière uniforme en fonction de la valeur de Count et de la durée de la vidéo.	1
SpriteSnapshotConfig	string	Non	La configuration de la sprite. Si ce paramètre n'est pas vide, une sprite est générée. Pour plus d'informations sur la structure du paramètre, consultez SpriteSnapshotConfig.	{'CellWidth': 120, 'CellHeight': 68, 'Columns': 3,'Lines': 10, 'Padding': 20, 'Margin': 50}
SnapshotTemplateId	string	Non	L'identifiant du modèle d'instantané. Nous vous recommandons de créer d'abord un modèle d'instantané, puis de transmettre l'identifiant du modèle d'instantané. Pour plus d'informations sur la création d'un modèle d'instantané, consultez Ajouter un modèle d'instantané. Si vous transmettez l'identifiant du modèle d'instantané, tous les paramètres de requête sauf Action et VideoId sont ignorés.	f5b228fe693bf55bd87b789****
UserData	string	Non	Les paramètres personnalisés. Seules les chaînes JSON sont prises en charge. Vous pouvez utiliser ce paramètre pour transmettre des données personnalisées et spécifier les paramètres de l'URL de rappel. Pour plus d'informations sur la structure du paramètre, consultez UserData. Remarque Pour utiliser le rappel de message dans ce paramètre, configurez l'URL de rappel HTTP et sélectionnez les types d'événements de rappel correspondants dans la console. Sinon, les paramètres de rappel ne prennent pas effet.	{"MessageCallback":{"CallbackURL":"http://.example.aliyundoc.com"},"Extend":{"localId":"xxx","example":"www"}}
SpecifiedOffsetTimes	array	Non	Les moments auxquels les instantanés sont capturés. Unité : millisecondes. Vous pouvez spécifier jusqu'à 30 moments à la fois.
	integer	Non	Le moment personnalisé. Unité : millisecondes.	1000
ReferenceId	string	Non	L'identifiant personnalisé. Seules les lettres minuscules, les lettres majuscules, les chiffres, les traits d'union et les traits de soulignement sont pris en charge. Longueur : 6 à 64 caractères. La valeur doit être unique au niveau de l'utilisateur.	123-123

Remarque

Vous devez spécifier au moins l'un des paramètres Count et Interval. Si les deux sont spécifiés, le plus petit nombre d'instantanés prévaut.

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
RequestId	string	L'identifiant de la requête.	25818875-5F78-5EB0-4AF6-D7393642****
SnapshotJob	object	Les informations sur la tâche de capture d'instantanés.
JobId	string	L'identifiant de la tâche de capture d'instantanés.	ad90a501b1b94b72374ad0050464****

Exemples

JSON format

{
  "RequestId": "25818875-5F78-5EB0-4AF6-D7393642****",
  "SnapshotJob": {
    "JobId": "ad90a501b1b94b72374ad0050464****"
  }
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.