SubmitSnapshotJob - - Centre de documentation Alibaba Cloud

Soumet une tâche de capture d'images.

Notes d'utilisation

Cette opération génère uniquement des images au format JPG.
Mode asynchrone : la réponse peut être renvoyée avant la fin de la capture des images. Les tâches de capture sont mises en file d'attente en arrière-plan et traitées de manière asynchrone par ApsaraVideo Media Processing (MPS). Si vous définissez le paramètre Interval ou Num, la tâche est traitée en mode asynchrone. Pour plus d'informations, consultez la rubrique FAQ sur la capture d'images.
Notifications : lors de la soumission d'une tâche de capture, le paramètre PipelineId est obligatoire. Un message asynchrone n'est envoyé que si la fonction de notification est activée pour la file d'attente MPS.

Limite QPS

Vous pouvez appeler cette opération jusqu'à 50 fois par seconde par compte. Les requêtes dépassant cette limite sont rejetées, ce qui entraîne des interruptions de service. Tenez compte de cette limite lorsque vous appelez cette opération. Pour plus d'informations, consultez la rubrique Limite QPS.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	SubmitSnapshotJob	Opération à effectuer. Définissez la valeur sur SubmitSnapshotJob.
Input	String	Oui	null	Informations sur l'entrée de la tâche. La valeur doit être un objet JSON. Vous devez accorder les autorisations liées à MPS au compartiment Object Storage Service (OSS) qui stocke l'objet OSS utilisé comme entrée de la tâche. Pour accorder ces autorisations, connectez-vous à la console MPS, choisissez Workflows > Media Buckets dans le volet de navigation de gauche, puis cliquez sur Add Bucket. Ensuite, encodez l'URL de l'objet OSS. Exemple : `{"Bucket":"example-bucket","Location":"example-location","Object":"example%2Ftest.flv"}`. Cet exemple correspond à l'objet `"example-bucket.example-location.aliyuncs.com/example/test.flv"`. Remarque Le compartiment OSS doit se trouver dans la même région que votre service MPS.
SnapshotConfig	String	Oui	null	Configuration de la capture d'images. Pour plus d'informations, consultez la section « AliyunSnapshotConfig » de la rubrique Types de données. Remarque Si vous définissez le paramètre Interval imbriqué sous SnapshotConfig, les captures sont effectuées aux intervalles spécifiés. La valeur par défaut du paramètre Interval est de 10 secondes. Si la vidéo d'entrée est courte mais que vous spécifiez des valeurs élevées pour les paramètres Num et Interval, le nombre réel de captures peut être inférieur au nombre spécifié. Par exemple, si vous définissez le paramètre Num sur 5 et le paramètre Interval sur 3 pour une vidéo de 10 secondes, le nombre de captures sera inférieur à 5.
UserData	String	Non	testid-001	Données personnalisées. Elles peuvent contenir des lettres, des chiffres et des traits d'union (-), et leur taille maximale est de 1 024 octets. Les données personnalisées ne doivent pas commencer par un caractère spécial.
PipelineId	String	Non	dd3dae411e704030b921e52698e5****	ID de la file d'attente MPS à laquelle vous souhaitez soumettre la tâche de capture. Pour obtenir l'ID, connectez-vous à la console MPS et choisissez Global Settings > Pipelines dans le volet de navigation de gauche. Remarque Assurez-vous qu'un topic Message Service (MNS) disponible est lié à la file d'attente MPS spécifiée. Sinon, l'envoi des messages pertinents pourrait échouer.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	19B6D8C5-A5DD-467A-B435-29D393C71E2D	ID de la requête.
SnapshotJob	Object		Informations sur la tâche de capture.
CreationTime	String	2021-05-19T03:11:48Z	Heure de création de la tâche.
SnapshotConfig	Object		Configuration de la capture d'images.
Time	String	5	Heure de début de la capture. Unité : millisecondes.
TileOut	Object		Configuration de la mosaïque.
Padding	String	0	Distance entre deux images consécutives dans l'image en mosaïque. Valeur par défaut : 0. Unité : pixel.
Color	String	black	Couleur d'arrière-plan. Valeur par défaut : black. Vous pouvez définir le paramètre Color sur un mot-clé de couleur ou sur random dans la requête. Remarque Pour définir la couleur d'arrière-plan sur noir, vous pouvez spécifier le mot-clé de couleur selon l'un des trois formats suivants : Black, black ou #000000.
CellSelStep	String	3	Pas de sélection d'une image unique.
CellHeight	String	100	Hauteur d'une image unique. La valeur par défaut correspond à la hauteur de la capture effectuée.
CellWidth	String	100	Largeur d'une image unique. La valeur par défaut correspond à la largeur de la capture effectuée.
Margin	String	5	Largeur de la marge de l'image en mosaïque. Valeur par défaut : 0. Unité : pixel.
Columns	String	10	Nombre de colonnes de l'image en mosaïque. Valeur par défaut : 10.
IsKeepCellPic	String	false	Indique si les images uniques sont conservées. Valeurs possibles : true : les images uniques sont conservées. false : les images uniques ne sont pas conservées. Valeur par défaut : true.
Lines	String	10	Nombre de lignes de l'image en mosaïque. Valeur par défaut : 10.
Interval	String	20	Intervalle de capture des images. Si ce paramètre est spécifié dans la requête, les captures sont effectuées à intervalles réguliers. La valeur doit être supérieure à 0. Unité : secondes. Valeur par défaut : 10.
FrameType	String	intra	Type de capture. Valeur par défaut : normal. Valeurs possibles : normal : images normales. intra : images I (images clés). Remarque Si le paramètre FrameType est défini sur intra dans la requête, seules les images clés sont capturées. Si aucune image clé n'est trouvée à l'instant spécifié, l'image clé la plus proche est capturée. La capture des images clés est plus rapide que celle des images normales lorsque les mêmes règles de capture s'appliquent.
Width	String	8	Largeur de la capture.
Height	String	8	Hauteur de la capture.
OutputFile	Object		Informations sur le fichier de sortie de la tâche de capture.
RoleArn	String	acs:ram::1:role/testrole	Alibaba Cloud Resource Name (ARN) du rôle RAM spécifié. Format : acs:ram::$accountID:role/$roleName.
Object	String	test.png	Objet OSS généré en tant que fichier de sortie de la tâche de capture.
Location	String	example-location	ID de la région où se trouve le compartiment OSS stockant l'objet.
Bucket	String	example	Compartiment OSS stockant l'objet.
Num	String	10	Nombre de captures. Si le paramètre Num est défini dans la requête, les captures sont effectuées à intervalles réguliers.
TileOutputFile	Object		Informations sur le fichier de sortie de la tâche de mosaïque.
RoleArn	String	acs:ram::1:role/testrole	ARN du rôle RAM spécifié. Format : acs:ram::$accountID:role/$roleName.
Object	String	example.png	Objet OSS généré en tant que fichier de sortie de la tâche de mosaïque.
Location	String	example-location	ID de la région où se trouve le compartiment OSS stockant l'objet.
Bucket	String	example	Compartiment OSS stockant l'objet.
State	String	Snapshoting	Statut de la tâche de capture. Valeurs possibles : Submitted : la tâche est soumise. Snapshoting : la tâche est en cours de traitement. Success : la tâche a réussi. Fail : la tâche a échoué.
Message	String	The resource operated InputFile is bad	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.
MNSMessageResult	Object		Message envoyé par MNS pour notifier l'utilisateur du résultat de la tâche.
MessageId	String	799454621135656C7F815F198A76****	ID du message. Ce paramètre n'est pas renvoyé en cas d'échec de la tâche.
ErrorMessage	String	The resource operated InputFile is bad	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.
ErrorCode	String	InvalidParameter	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.
Input	Object		Informations sur l'entrée de la tâche.
RoleArn	String	acs:ram::1:role/testrole	ARN du rôle RAM spécifié. Format : acs:ram::$accountID:role/$roleName.
Object	String	example.flv	Objet OSS utilisé comme fichier d'entrée.
Location	String	example-location'	ID de la région où se trouve le compartiment OSS stockant l'objet.
Bucket	String	example	Compartiment OSS stockant l'objet.
Count	String	1	Nombre de captures effectuées.
TileCount	String	5	Nombre d'images uniques contenues dans l'image en mosaïque.
UserData	String	testid-001	Données personnalisées.
Code	String	ResourceContentBad	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.
PipelineId	String	dd3dae411e704030b921e52698e5****	ID de la file d'attente MPS à laquelle la tâche de capture est soumise.
Id	String	f4e3b9ba9f3840c39d6e288056f0****	ID de la tâche de capture.

Exemples

Exemple de requête

http(s)://mts.cn-hangzhou.aliyuncs.com/?Action=SubmitSnapshotJob
&Input={"Bucket":"example-bucket","Location":"example-location","Object":"example%2Ftest.flv"}
&SnapshotConfig={"OutputFile":{"Bucket":"example-001","Location":"example-location","Object":"{Count}.jpg"},"Time":"5","Num":"10","Interval":"20"}
&UserData=testid-001
&PipelineId=dd3dae411e704030b921e52698e5****
&<Common request parameters>

Exemples de réponses réussies

Format XML

HTTP/1.1 200 OK
Content-Type:application/xml

<SubmitSnapshotJobResponse>
    <RequestId>19B6D8C5-A5DD-467A-B435-29D393C71E2D</RequestId>
    <SnapshotJob>
        <CreationTime>2021-05-19T03:11:48Z</CreationTime>
        <SnapshotConfig>
            <Time>5</Time>
            <TileOut>
                <Padding>0</Padding>
                <Color>black</Color>
                <CellSelStep>3</CellSelStep>
                <CellHeight>100</CellHeight>
                <CellWidth>100</CellWidth>
                <Margin>5</Margin>
                <Columns>10</Columns>
                <IsKeepCellPic>false</IsKeepCellPic>
                <Lines>10</Lines>
            </TileOut>
            <Interval>20</Interval>
            <FrameType>intra</FrameType>
            <Width>8</Width>
            <Height>8</Height>
            <OutputFile>
                <RoleArn>acs:ram::1:role/testrole</RoleArn>
                <Object>test.png</Object>
                <Location>example-location</Location>
                <Bucket>example</Bucket>
            </OutputFile>
            <Num>10</Num>
            <TileOutputFile>
                <RoleArn>acs:ram::1:role/testrole</RoleArn>
                <Object>example.png</Object>
                <Location>example-location</Location>
                <Bucket>example</Bucket>
            </TileOutputFile>
        </SnapshotConfig>
        <State>Snapshoting</State>
        <Message>The resource operated InputFile is bad</Message>
        <MNSMessageResult>
            <MessageId>799454621135656C7F815F198A76****</MessageId>
            <ErrorMessage>The resource operated InputFile is bad</ErrorMessage>
            <ErrorCode>InvalidParameter</ErrorCode>
        </MNSMessageResult>
        <Input>
            <RoleArn>acs:ram::1:role/testrole</RoleArn>
            <Object>example.flv</Object>
            <Location>example-location'</Location>
            <Bucket>example</Bucket>
        </Input>
        <Count>1</Count>
        <TileCount>5</TileCount>
        <UserData>testid-001</UserData>
        <Code>ResourceContentBad</Code>
        <PipelineId>dd3dae411e704030b921e52698e5****</PipelineId>
        <Id>f4e3b9ba9f3840c39d6e288056f0****</Id>
    </SnapshotJob>
</SubmitSnapshotJobResponse>

Format JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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"
      }
    },
    "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

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