QuerySnapshotJobList - - Centre de documentation Alibaba Cloud

Notes d'utilisation

Vous pouvez interroger jusqu'à 10 tâches de capture d'images à la fois via cette opération.

Limites de QPS

Vous pouvez appeler cette opération jusqu'à 100 fois par seconde et par compte. Si le nombre d'appels par seconde dépasse cette limite, un mécanisme de limitation du débit (throttling) se déclenche, ce qui peut affecter votre activité. Tenez compte de cette limite lors de l'appel à cette opération. Pour plus d'informations, consultez la rubrique Limite QPS.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	QuerySnapshotJobList	L'opération à effectuer. Définissez la valeur sur QuerySnapshotJobList.
SnapshotJobIds	String	No	72dfa5e679ab4be9a3ed9974c736****	Les ID des tâches de capture d'images à interroger. Pour obtenir ces ID, connectez-vous à la console ApsaraVideo Media Processing (MPS), cliquez sur Tasks dans le volet de navigation de gauche, puis consultez les ID dans l'onglet Snapshot. Vous pouvez interroger jusqu'à 10 tâches de capture d'images à la fois. Séparez les ID par des virgules (,).
NextPageToken	String	No	cc6cbef8e8d5481ca536f5d2a466****	Le jeton utilisé pour récupérer la page suivante des résultats de la requête. La valeur est un UUID de 32 bits. Ce paramètre est renvoyé si les résultats de la requête ne tiennent pas sur une seule page. La valeur de ce paramètre est mise à jour pour chaque requête.
MaximumPageSize	Long	No	30	Le nombre maximal d'entrées à renvoyer par page. Valeur par défaut : 30. Plage de valeurs valides : [1,300].
State	String	No	Snapshoting	L'état des tâches de capture d'images à interroger. Submitted : la tâche a été soumise. Snapshoting : la tâche est en cours de traitement. Success : la tâche a été traitée avec succès. Fail : la tâche a échoué.
StartOfJobCreatedTimeRange	String	No	2014-01-10T12:00:00Z	Le début de la plage de temps de création des tâches de capture d'images à interroger. Spécifiez l'heure selon la norme ISO 8601 au format YYYY-MM-DDThh:mm:ssZ. L'heure doit être exprimée en UTC.
EndOfJobCreatedTimeRange	String	No	2014-01-12T12:00:00Z	La fin de la plage de temps de création des tâches de capture d'images à interroger. Spécifiez l'heure selon la norme ISO 8601 au format YYYY-MM-DDThh:mm:ssZ. L'heure doit être exprimée en UTC.
PipelineId	String	No	b11c171cced04565b1f38f1ecc39****	L'ID de la file d'attente MPS à laquelle les tâches de capture d'images à interroger ont été soumises. Pour obtenir cet ID, connectez-vous à la console MPS et choisissez Global Settings > Pipelines dans le volet de navigation de gauche.

Paramètres de réponse

Parameter	Type	Example	Description
SnapshotJobList	Array of SnapshotJob		Les informations relatives aux tâches de capture d'images.
SnapshotJob
CreationTime	String	2021-06-30T12:34:29Z	L'heure de création de la tâche.
SnapshotConfig	Object		La configuration de la capture d'images.
Time	String	4	L'heure de début de la prise de captures d'images. Unité : millisecondes.
TileOut	Object		La configuration du mosaïquage.
Padding	String	0	La distance entre les images. Valeur par défaut : 0. Unité : pixel.
Color	String	black	La 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 Si vous souhaitez définir la couleur d'arrière-plan sur noir, vous pouvez spécifier le mot-clé de couleur dans l'un des trois formats suivants : Black, black ou #000000.
CellSelStep	String	3	Le pas d'une image unique.
CellHeight	String	8	La hauteur d'une image unique. La valeur par défaut correspond à la hauteur de la capture d'images de sortie.
CellWidth	String	8	La largeur d'une image unique. La valeur par défaut correspond à la largeur de la capture d'images de sortie.
Margin	String	0	La largeur de la marge de l'image en mosaïque. Valeur par défaut : 0. Unité : pixel.
Columns	String	10	Le nombre de colonnes que l'image en mosaïque peut contenir. Valeur par défaut : 10.
IsKeepCellPic	String	false	Indique si les images uniques sont conservées. Valeur par défaut : true.
Lines	String	10	Le nombre de lignes que l'image en mosaïque peut contenir. Valeur par défaut : 10.
Interval	String	10	L'intervalle de prise de captures d'images. Si ce paramètre Interval est spécifié dans la requête, les captures d'images sont prises à intervalles réguliers. La valeur doit être supérieure à 0. Unité : secondes. Valeur par défaut : 10.
FrameType	String	intra	Le type de capture d'images. Valeurs valides : normal : images normales. intra : images I. Valeur par défaut : intra.
Width	String	8	La largeur de la capture d'images de sortie.
Height	String	8	La hauteur de la capture d'images de sortie.
OutputFile	Object		Le fichier de sortie Object Storage Service (OSS) de la tâche de capture d'images.
RoleArn	String	acs:ram::1:role/testrole	Le nom de ressource Alibaba Cloud (ARN) du rôle RAM spécifié. Format : acs:ram::$accountID:role/$roleName.
Object	String	example.png	L'objet OSS généré en tant que fichier de sortie de la tâche de capture d'images.
Location	String	example-location	L'ID de la région dans laquelle se trouve le compartiment OSS de sortie.
Bucket	String	example	Le compartiment OSS qui stocke le fichier de sortie.
Num	String	10	Le nombre de captures d'images à prendre. Si le paramètre Num est défini dans la requête, les captures d'images sont prises à intervalles réguliers.
TileOutputFile	Object		Le fichier de sortie OSS de la tâche de mosaïquage.
RoleArn	String	acs:ram::1:role/testrole	L'ARN du rôle RAM spécifié. Format : acs:ram::$accountID:role/$roleName.
Object	String	example.png	L'objet OSS généré en tant que fichier de sortie de la tâche de mosaïquage.
Location	String	example-location	L'ID de la région dans laquelle se trouve le compartiment OSS de sortie.
Bucket	String	example	Le compartiment OSS qui stocke le fichier de sortie.
State	String	Snapshoting	L'état de la tâche de capture d'images. Submitted : la tâche a été soumise. Snapshoting : la tâche est en cours de traitement. Success : la tâche a été traitée avec succès. Fail : la tâche a échoué.
Message	String	The resource operated InputFile is bad	Le message d'erreur renvoyé en cas d'échec de la tâche. Ce paramètre n'est pas renvoyé si la tâche est traitée avec succès.
MNSMessageResult	Object		Le message envoyé par MNS pour notifier l'utilisateur du résultat de la tâche.
MessageId	String	799454621135656C7F815F198A76****	L'ID du message. Ce paramètre n'est pas renvoyé si la tâche échoue.
ErrorMessage	String	The resource operated InputFile is bad	Le message d'erreur renvoyé en cas d'échec de la tâche. Ce paramètre n'est pas renvoyé si la tâche est traitée avec succès.
ErrorCode	String	InvalidParameter	Le code d'erreur renvoyé en cas d'échec de la tâche. Ce paramètre n'est pas renvoyé si la tâche est traitée avec succès.
Input	Object		Les informations relatives à l'entrée de la tâche.
RoleArn	String	acs:ram::1:role/testrole	L'ARN du rôle RAM spécifié. Format : acs:ram::$accountID:role/$roleName.
Object	String	example.flv	L'objet OSS utilisé comme fichier d'entrée.
Location	String	example-location	L'ID de la région dans laquelle se trouve le compartiment OSS d'entrée.
Bucket	String	example	Le compartiment OSS qui stocke le fichier d'entrée.
Count	String	1	Le nombre de captures d'images effectuées.
TileCount	String	7	Le nombre de captures d'images contenues dans l'image en mosaïque.
UserData	String	testid-001	Les données personnalisées.
Code	String	InvalidParameter	Le code d'erreur renvoyé en cas d'échec de la tâche. Ce paramètre n'est pas renvoyé si la tâche est traitée avec succès.
PipelineId	String	b11c171cced04565b1f38f1ecc39****	L'ID de la file d'attente MPS à laquelle la tâche de capture d'images a été soumise.
Id	String	cc6cbef8e8d5481ca536f5d2a466****	L'ID de la tâche de capture d'images.
RequestId	String	34BCAB31-2833-43A7-9FBD-B34302AB23EQ	L'ID de la requête.
NonExistSnapshotJobIds	Array of String	c6d973c33d1c4b21bc39907d3b29****	Les ID des tâches de capture d'images qui n'existent pas. Ce paramètre n'est pas renvoyé si toutes les tâches de capture d'images spécifiées sont trouvées.
NextPageToken	String	b11c171cced04565b1f38f1ecc39****	Le jeton utilisé pour récupérer la page suivante des résultats de la requête. La valeur est un UUID de 32 bits. Ce paramètre est renvoyé si les résultats de la requête ne tiennent pas sur une seule page. La valeur de ce paramètre est mise à jour pour chaque requête.

Exemples

Exemple de requête

http(s)://mts.cn-hangzhou.aliyuncs.com/?Action=QuerySnapshotJobList
&SnapshotJobIds=72dfa5e679ab4be9a3ed9974c736****
&NextPageToken=cc6cbef8e8d5481ca536f5d2a466****
&MaximumPageSize=30
&State=Snapshoting
&StartOfJobCreatedTimeRange=2014-01-10T12:00:00Z
&EndOfJobCreatedTimeRange=2014-01-12T12:00:00Z
&PipelineId=b11c171cced04565b1f38f1ecc39****
&<Common request parameters>

Exemple de réponse en cas de succès

Format XML

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

<QuerySnapshotJobListResponse>
    <SnapshotJobList>
        <CreationTime>2021-06-30T12:34:29Z</CreationTime>
        <SnapshotConfig>
            <Time>4</Time>
            <TileOut>
                <Padding>0</Padding>
                <Color>black</Color>
                <CellSelStep>3</CellSelStep>
                <CellHeight>8</CellHeight>
                <CellWidth>8</CellWidth>
                <Margin>0</Margin>
                <Columns>10</Columns>
                <IsKeepCellPic>false</IsKeepCellPic>
                <Lines>10</Lines>
            </TileOut>
            <Interval>10</Interval>
            <FrameType>intra</FrameType>
            <Width>8</Width>
            <Height>8</Height>
            <OutputFile>
                <RoleArn>acs:ram::1:role/testrole</RoleArn>
                <Object>example.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>
        <MNSMessageResult>
            <MessageId>799454621135656C7F815F198A76****</MessageId>
        </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>7</TileCount>
        <UserData>testid-001</UserData>
        <PipelineId>b11c171cced04565b1f38f1ecc39****</PipelineId>
        <Id>cc6cbef8e8d5481ca536f5d2a466****</Id>
    </SnapshotJobList>
    <RequestId>34BCAB31-2833-43A7-9FBD-B34302AB23EQ</RequestId>
    <NonExistSnapshotJobIds>c6d973c33d1c4b21bc39907d3b29****</NonExistSnapshotJobIds>
    <NextPageToken>b11c171cced04565b1f38f1ecc39****</NextPageToken>
</QuerySnapshotJobListResponse>

Format JSON

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

{
    "SnapshotJobList": [
        {
            "CreationTime": "2021-06-30T12:34:29Z",
            "SnapshotConfig": {
                "Time": "4",
                "TileOut": {
                    "Padding": "0",
                    "Color": "black",
                    "CellSelStep": "3",
                    "CellHeight": "8",
                    "CellWidth": "8",
                    "Margin": "0",
                    "Columns": "10",
                    "IsKeepCellPic": "false",
                    "Lines": "10"
                },
                "Interval": "10",
                "FrameType": "intra",
                "Width": "8",
                "Height": "8",
                "OutputFile": {
                    "RoleArn": "acs:ram::1:role/testrole",
                    "Object": "example.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",,
            "MNSMessageResult": {
                "MessageId": "799454621135656C7F815F198A76****",
            },
            "Input": {
                "RoleArn": "acs:ram::1:role/testrole",
                "Object": "example.flv",
                "Location": "example-location",
                "Bucket": "example"
            },
            "Count": "1",
            "TileCount": "7",
            "UserData": "testid-001",
            "PipelineId": "b11c171cced04565b1f38f1ecc39****",
            "Id": "cc6cbef8e8d5481ca536f5d2a466****"
        }
    ],
    "RequestId": "34BCAB31-2833-43A7-9FBD-B34302AB23EQ",
    "NonExistSnapshotJobIds": [
        "c6d973c33d1c4b21bc39907d3b29****"
    ],
    "NextPageToken": "b11c171cced04565b1f38f1ecc39****"
}

Codes d'erreur

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