SubmitSnapshotJob - ApsaraVideo Media Processing - Centre de documentation Alibaba Cloud

Soumet une tâche de capture. Une fois cette opération appelée, ApsaraVideo Media Processing effectue des captures et génère des sprites d'images pour le fichier d'entrée.

Description de l'opération

La taille maximale d'un fichier d'entrée unique est de 100 Go. Le dépassement de cette limite peut entraîner l'échec de la tâche.
Assurez-vous que le fichier a été correctement importé dans OSS avant de soumettre une tâche de capture. Sinon, la tâche risque d'échouer. Vous pouvez configurer des messages de rappel OSS pour vérifier l'état d'importation du fichier.
Les tâches de capture prennent en charge les modes synchrone et asynchrone.
- Le mode synchrone prend uniquement en charge les captures d'image unique. L'image est générée lorsque la réponse de l'API est renvoyée.
- Le mode asynchrone ne garantit pas un traitement en temps réel. Une fois la tâche de capture soumise, la tâche est ajoutée à une file d'attente MPS pour planification et exécution. Par conséquent, la capture peut ne pas être générée au moment du renvoi de la réponse de l'API. Une fois l'exécution terminée, vous devez appeler l'opération de requête des résultats de la tâche de capture pour interroger le résultat de l'exécution, ou lier un message MNS à la file d'attente MPS pour recevoir le résultat de l'exécution. Pour plus d'informations, consultez Recevoir des notifications de messages.
- Si vous spécifiez le paramètre Interval ou Num, le mode asynchrone est utilisé.
Seules les images JPG sont prises en charge.
Pour plus d'informations sur la FAQ relative aux captures, consultez FAQ sur les captures.

Limites de QPS

La limite de QPS pour un utilisateur unique est de 50 requêtes par seconde. Si cette limite est dépassée, les appels d'API sont limités, ce qui peut affecter votre activité. Effectuez les appels d'API de manière appropriée. Pour plus d'informations, consultez Limites 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.

mts:SubmitSnapshotJob

create

*Toutes les ressources.

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Input	string	Oui	L'entrée de la tâche. Pour plus d'informations, consultez Détails de l'entrée. Remarque Dans les opérations de l'API ApsaraVideo Media Processing, le paramètre Object doit être encodé en URL en UTF-8. La région du compartiment OSS doit être identique à la région de MPS.	{"Bucket":"example-bucket","Location":"example-location","Object":"example%2Ftest.flv"}
SnapshotConfig	string	Oui	La configuration de capture. Pour plus d'informations, consultez Détails du paramètre SnapshotConfig.	{"OutputFile":{"Bucket":"example-001","Location":"example-location","Object":"{Count}.jpg"},"Time":"5","Num":"10","Interval":"20"}
UserData	string	Non	Les données utilisateur personnalisées. La valeur peut contenir des caractères chinois et anglais, des chiffres et des traits d'union (-), et ne peut pas commencer par un caractère spécial. La longueur maximale est de 1 024 octets.	testid-001
PipelineId	string	Non	L'identifiant de la file d'attente MPS. Pour plus d'informations, consultez Termes. Valeurs valides : vous pouvez interroger et créer des files d'attente MPS dans la console MPS en choisissant Paramètres globaux > Pipelines. Si vous avez besoin de notifications asynchrones, joignez un message MNS à la file d'attente MPS. Pour plus d'informations, consultez Accepter les notifications de messages.	dd3dae411e704030b921e52698e5****

É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.	19B6D8C5-A5DD-467A-B435-29D393C71E2D
SnapshotJob	object	La tâche de capture.
CreationTime	string	L'heure de création de la tâche. L'heure est affichée en UTC et suit la norme ISO 8601 au format AAAA-MM-JJThh:mm:ssZ.	2021-05-19T03:11:48Z
SnapshotConfig	object	La configuration de capture.
Time	string	L'heure de début de la capture. Unité : millisecondes.	5
TileOut	object	La configuration du sprite d'image.
Padding	string	L'espacement entre les images. Valeur par défaut : 0. Unité : pixels.	0
Color	string	La couleur d'arrière-plan. Valeur par défaut : black. Valeurs valides : color keyword et random. Remarque Un mot-clé de couleur prend en charge trois formats. Par exemple, le noir peut être spécifié comme Black, black ou #000000.	black
CellSelStep	string	La taille du pas pour la sélection des images uniques.	3
CellHeight	string	La hauteur d'une image unique. Valeur par défaut : la hauteur de la résolution de sortie de la capture.	100
CellWidth	string	La largeur d'une image unique. Valeur par défaut : la largeur de la résolution de sortie de la capture.	100
Margin	string	La largeur du cadre extérieur. Valeur par défaut : 0. Unité : pixels.	5
Columns	string	Le nombre de colonnes dans le sprite d'image. Valeur par défaut : 10.	10
IsKeepCellPic	string	Indique si les images uniques doivent être conservées. Valeurs valides : true : conserve les images uniques. false : ne conserve pas les images uniques. Valeur par défaut : true.	false
Lines	string	Le nombre de lignes dans le sprite d'image. Valeur par défaut : 10.	10
Interval	string	L'intervalle de temps entre les captures. Si ce paramètre est spécifié, des captures multi-images sont effectuées et la valeur doit être supérieure à 0. Unité : secondes. Valeur par défaut : 10.	20
FrameType	string	Le type de capture. Valeur par défaut : normal. Valeurs valides : normal : image normale. intra : image I (image clé). Remarque Si les paramètres du paramètre de requête FrameType spécifient une image I (image clé), seules les images clés sont capturées. Si le point temporel spécifié n'est pas une image clé, l'image clé la plus proche est capturée. Selon les mêmes règles de capture, la capture d'images clés est plus rapide que celle d'images normales.	intra
Width	string	La largeur de l'image de capture de sortie.	8
Height	string	La hauteur de l'image de capture de sortie.	8
OutputFile	object	La configuration OSS pour la sortie de capture.
RoleArn	string	L'ARN du rôle spécifié. Format : acs:ram::$accountID:role/$roleName.	acs:ram::1:role/testrole
Object	string	Le fichier de sortie de capture (objet OSS).	test.png
Location	string	Le centre de données où se trouve le compartiment OSS pour la sortie de capture (emplacement OSS).	example-location
Bucket	string	Le compartiment OSS où le fichier de sortie de capture est stocké.	example
Num	string	Le nombre de captures. Si ce paramètre est spécifié, des captures multi-images sont effectuées.	10
TileOutputFile	object	La configuration OSS pour le sprite d'image de sortie.
RoleArn	string	L'ARN du rôle spécifié. Format : acs:ram::$accountID:role/$roleName.	acs:ram::1:role/testrole
Object	string	Le fichier de sortie (objet OSS).	example.png
Location	string	Le centre de données où se trouve le compartiment OSS de sortie (emplacement OSS).	example-location
Bucket	string	Le compartiment OSS où le fichier de sortie est stocké.	example
TimeArray	object
TimePointList	array	Le tableau des points temporels spécifiés.
	integer	Le tableau des points temporels spécifiés. Unité : millisecondes. La valeur est un nombre à virgule flottante avec deux décimales. Les valeurs peuvent être en double et soumises dans le désordre, et sont triées par MPS. Un maximum de 100 points temporels peut être spécifié. Lorsque ce paramètre est spécifié, ne spécifiez pas le paramètre Num, Time ou Interval. Sinon, l'erreur InvalidParameter.Ambiguity est renvoyée.	[10050, 50000, 110000, 1000500, 1100500]
State	string	L'état de la capture. Valeurs valides : Submitted : la tâche est soumise. Snapshoting : la capture est en cours. Success : la tâche a réussi. Fail : la tâche a échoué.	Snapshoting
Message	string	Le message d'erreur renvoyé en cas d'échec de la tâche. Ce paramètre n'est pas renvoyé si la tâche réussit.	The resource operated InputFile is bad
MNSMessageResult	object	Le résultat de la notification MNS pour l'achèvement de la tâche.
MessageId	string	L'identifiant du message renvoyé lorsque la tâche réussit. Ce paramètre n'est pas renvoyé si la tâche échoue.	799454621135656C7F815F198A76****
ErrorMessage	string	Le message d'erreur renvoyé en cas d'échec de la tâche. Ce paramètre n'est pas renvoyé si la tâche réussit.	The resource operated InputFile is bad
ErrorCode	string	Le code d'erreur renvoyé en cas d'échec de la tâche. Ce paramètre n'est pas renvoyé si la tâche réussit.	InvalidParameter
Input	object	L'entrée de la tâche.
RoleArn	string	L'ARN du rôle spécifié. Format : acs:ram::$accountID:role/$roleName.	acs:ram::1:role/testrole
Object	string	Le fichier d'entrée (objet OSS).	example.flv
Location	string	Le centre de données où se trouve le compartiment OSS d'entrée (emplacement OSS).	example-location'
Bucket	string	Le compartiment OSS où le fichier d'entrée est stocké.	example
Count	string	Le nombre d'images capturées.	1
TileCount	string	Le nombre d'images dans le sprite d'image.	5
UserData	string	Les données utilisateur personnalisées.	testid-001
Code	string	Le code d'erreur renvoyé en cas d'échec de la tâche. Ce paramètre n'est pas renvoyé si la tâche réussit.	ResourceContentBad
PipelineId	string	L'identifiant de la file d'attente MPS.	dd3dae411e704030b921e52698e5****
Id	string	L'identifiant de la tâche de capture.	f4e3b9ba9f3840c39d6e288056f0****

Exemples

JSON format

{
  "RequestId": "19B6D8C5-A5DD-467A-B435-29D393C71E2D",
  "SnapshotJob": {
    "CreationTime": "2021-05-19T03:11:48Z",
    "SnapshotConfig": {
      "Time": "5",
      "TileOut": {
        "Padding": "0",
        "Color": "black",
        "CellSelStep": "3",
        "CellHeight": "100",
        "CellWidth": "100",
        "Margin": "5",
        "Columns": "10",
        "IsKeepCellPic": "false",
        "Lines": "10"
      },
      "Interval": "20",
      "FrameType": "intra",
      "Width": "8",
      "Height": "8",
      "OutputFile": {
        "RoleArn": "acs:ram::1:role/testrole",
        "Object": "test.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": "5",
    "UserData": "testid-001",
    "Code": "ResourceContentBad",
    "PipelineId": "dd3dae411e704030b921e52698e5****",
    "Id": "f4e3b9ba9f3840c39d6e288056f0****"
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.