QuerySnapshotJobList - - Centre de documentation Alibaba Cloud

Consulte les tâches d'instantanés.

Description de l'opération

Vous pouvez interroger les tâches d'instantanés en spécifiant un ou plusieurs identifiants de tâche d'instantané (SnapshotJobIds). Vous pouvez également effectuer une requête paginée et filtrer les tâches par état, heure de création ou file d'attente MPS sans spécifier d'identifiants de tâche.

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:QuerySnapshotJobList

list

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
SnapshotJobIds	string	Non	La liste des identifiants des tâches d'instantanés.	72dfa5e679ab4be9a3ed9974c736****
NextPageToken	string	Non	Le jeton pour la page suivante. Il s'agit d'un identifiant universel unique (UUID) de 32 bits.	cc6cbef8e8d5481ca536f5d2a466****
MaximumPageSize	integer	Non	Le nombre maximal d'entrées à renvoyer sur chaque page d'une requête paginée.	30
State	string	Non	L'état des tâches d'instantanés à interroger.	Snapshoting
StartOfJobCreatedTimeRange	string	Non	Le début de la plage de temps de création de la tâche.	2014-01-10T12:00:00Z
EndOfJobCreatedTimeRange	string	Non	La fin de la plage de temps de création de la tâche.	2014-01-12T12:00:00Z
PipelineId	string	Non	L'identifiant de la file d'attente MPS. Pour plus d'informations, consultez Termes.	b11c171cced04565b1f38f1ecc39****

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
SnapshotJobList	object
SnapshotJob	array<object>	La liste des tâches d'instantanés.
	array<object>	Les paramètres de réponse.
CreationTime	string	The time the job was created.	2021-06-30T12:34:29Z
SnapshotConfig	object	The snapshot configuration.
Time	string	The start time for the snapshot. Unit: milliseconds.	4
TileOut	object	The mosaic configuration.
Padding	string	The spacing between images. Default: 0. Unit: px.	0
Color	string	The background color. Default: black. Valid values: color keyword, random. Remarque Color keywords support three formats. For example, black can be specified as Black, black, or #000000.	black
CellSelStep	string	The step size for selecting a single image.	3
CellHeight	string	The height of a single image. The default is the height of the snapshot output.	8
CellWidth	string	The width of a single image. The default is the width of the snapshot output.	8
Margin	string	The width of the outer border. Default: 0. Unit: px.	0
Columns	string	The number of columns in the mosaic. Default: 10.	10
IsKeepCellPic	string	Indicates whether to keep the individual images. Default: true.	false
Lines	string	The number of rows in the mosaic. Default: 10.	10
Interval	string	The snapshot interval. If specified, it indicates a sequence of snapshots, and the value must be greater than 0. Unit: seconds. Default value: 10.	10
FrameType	string	The snapshot type. normal: Normal frame. intra: I-frame. Default value: intra.	intra
Width	string	The width of the output snapshot image.	8
Height	string	The height of the output snapshot image.	8
OutputFile	object	The OSS configuration for the snapshot output.
RoleArn	string	The ARN of the specified role. Format: acs:ram::$accountID:role/$roleName.	acs:ram::1:role/testrole
Object	string	The output file (OSS Object) for the snapshot.	example.png
Location	string	The data center where the output OSS bucket is located (OSS Location).	example-location
Bucket	string	The OSS bucket where the output file is stored.	example
Num	string	The number of snapshots. If specified, it indicates a sequence of snapshots.	10
TileOutputFile	object	The OSS configuration for the large image output of the mosaic job.
RoleArn	string	The ARN of the specified role. Format: acs:ram::$accountID:role/$roleName.	acs:ram::1:role/testrole
Object	string	The output file (OSS Object).	example.png
Location	string	The data center where the output OSS bucket is located (OSS Location).	example-location
Bucket	string	The OSS bucket where the output file is stored.	example
TimeArray	object
TimePointList	array	The array of specified time points.
	integer	The array of specified time points. Unit: milliseconds. This is a floating-point number with two decimal places. The time points can be repeated and submitted in any order. MPS sorts them. A maximum of 100 time points are supported. If you specify this parameter, do not specify Num, Time, or Interval. Otherwise, an InvalidParameter.Ambiguity error is returned.	[10050, 50000, 110000, 1000500, 1100500]
State	string	The state of the snapshot job. Submitted: The job is submitted. Snapshoting: The job is in progress. Success: The job is successful. Fail: The job failed.	Snapshoting
Message	string	The error message returned when the analysis fails. This parameter is not returned if the job is successful.	The resource operated InputFile is bad
MNSMessageResult	object	The result of the MNS notification sent to the user when the job is complete.
MessageId	string	The ID of the message. This parameter is not returned if the job fails.	799454621135656C7F815F198A76****
ErrorMessage	string	The error message. This parameter is not returned if the job is successful.	The resource operated InputFile is bad
ErrorCode	string	The error code. This parameter is not returned if the job is successful.	InvalidParameter
Input	object	The job input.
RoleArn	string	The ARN of the specified role. Format: acs:ram::$accountID:role/$roleName.	acs:ram::1:role/testrole
Object	string	The input file (OSS Object).	example.flv
Location	string	The data center where the input OSS bucket is located (OSS Location).	example-location
Bucket	string	The OSS bucket where the input file is stored.	example
Count	string	The number of captured images.	1
TileCount	string	The number of images in the mosaic.	7
UserData	string	The user-defined data.	testid-001
Code	string	The error code returned when the analysis fails. This parameter is not returned if the job is successful.	InvalidParameter
PipelineId	string	The pipeline ID.	b11c171cced04565b1f38f1ecc39****
Id	string	The ID of the snapshot job.	cc6cbef8e8d5481ca536f5d2a466****
RequestId	string	L'identifiant de la requête.	34BCAB31-2833-43A7-9FBD-B34302AB23EQ
NonExistSnapshotJobIds	object
String	array	La liste des identifiants de tâches d'instantanés inexistants.
	string	Les détails d'un identifiant de tâche d'instantané inexistant. Ce paramètre n'est pas renvoyé si aucune donnée n'existe.	c6d973c33d1c4b21bc39907d3b29****
NextPageToken	string	Le jeton pour la page suivante. Il s'agit d'un UUID de 32 bits. Ce paramètre est renvoyé lorsque le résultat de la requête est tronqué. La valeur de ce paramètre est mise à jour pour chaque requête.	b11c171cced04565b1f38f1ecc39****

Exemples

JSON format

{
  "SnapshotJobList": {
    "SnapshotJob": [
      {
        "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"
          },
          "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": "7",
        "UserData": "testid-001",
        "Code": "InvalidParameter",
        "PipelineId": "b11c171cced04565b1f38f1ecc39****",
        "Id": "cc6cbef8e8d5481ca536f5d2a466****"
      }
    ]
  },
  "RequestId": "34BCAB31-2833-43A7-9FBD-B34302AB23EQ",
  "NonExistSnapshotJobIds": {
    "String": [
      "c6d973c33d1c4b21bc39907d3b29****"
    ]
  },
  "NextPageToken": "b11c171cced04565b1f38f1ecc39****"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.