Consulte les travaux de capture d'instantané.
Description de l'opération
Vous pouvez spécifier plusieurs identifiants de travaux de capture d'instantané (SnapshotJobIds) à interroger. Vous pouvez également effectuer une requête paginée sans spécifier d'identifiants de travaux de capture d'instantané en filtrant par des conditions telles que l'état de l'instantané, l'heure de création et la file d'attente MPS.
Vous pouvez interroger jusqu'à 10 travaux de capture d'instantané en un seul appel.
Par défaut, les résultats renvoyés sont triés par ordre décroissant de CreationTime.
Limites de QPS
La limite de QPS par utilisateur pour cette opération est de 100 appels par seconde. Si cette limite est dépassée, les appels d'API sont limités, ce qui peut affecter vos services. Appelez l'opération 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
|
mts:QuerySnapshotJobList |
list |
*Toutes les ressources.
|
Aucune | Aucune |
Paramètres de requête
|
Paramètre |
Type |
Requis |
Description |
Exemple |
| SnapshotJobIds |
string |
Non |
La liste des identifiants des travaux de capture d'instantané.
|
72dfa5e679ab4be9a3ed9974c736**** |
| NextPageToken |
string |
Non |
Le jeton pour la page suivante, qui est un UUID de 32 caractères.
|
cc6cbef8e8d5481ca536f5d2a466**** |
| MaximumPageSize |
integer |
Non |
Le nombre maximal d'entrées à renvoyer sur chaque page dans une requête paginée.
|
30 |
| State |
string |
Non |
L'état de l'instantané à interroger. Valeurs valides :
|
Snapshoting |
| StartOfJobCreatedTimeRange |
string |
Non |
L'heure la plus ancienne à laquelle le travail a été créé.
|
2014-01-10T12:00:00Z |
| EndOfJobCreatedTimeRange |
string |
Non |
L'heure la plus récente à laquelle le travail a été créé.
|
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 travaux de capture d'instantané. |
|
|
array<object> |
Les paramètres de réponse. |
||
| CreationTime |
string |
L'heure à laquelle le travail a été créé. L'heure est affichée en UTC et formatée conformément à la norme ISO 8601 au format YYYY-MM-DDTHH:mm:ssZ. |
2021-06-30T12:34:29Z |
| SnapshotConfig |
object |
Les configurations de capture d'instantané. |
|
| Time |
string |
L'heure de début de la capture d'instantané. Unité : millisecondes. |
4 |
| TileOut |
object |
Les configurations de sprite d'image. |
|
| Padding |
string |
L'espacement entre les images.
|
0 |
| Color |
string |
La couleur d'arrière-plan.
Remarque
Les mots-clés de couleur prennent en charge trois formats. Par exemple, le noir peut être représenté par Black, black ou #000000. |
black |
| CellSelStep |
string |
La taille du pas pour la sélection d'une image unique. |
3 |
| CellHeight |
string |
La hauteur d'une image unique. Valeur par défaut : la hauteur de la résolution de sortie de l'instantané. |
8 |
| CellWidth |
string |
La largeur d'une image unique. Valeur par défaut : la largeur de la résolution de sortie de l'instantané. |
8 |
| Margin |
string |
La largeur du cadre extérieur.
|
0 |
| 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. 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 d'instantané.
|
10 |
| FrameType |
string |
Le type d'instantané. Valeurs valides :
|
intra |
| Width |
string |
La largeur de l'image d'instantané de sortie. |
8 |
| Height |
string |
La hauteur de l'image d'instantané de sortie. |
8 |
| OutputFile |
object |
Les configurations OSS pour la sortie de l'instantané. |
|
| 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 l'instantané (objet OSS). |
example.png |
| Location |
string |
Le centre de données où réside le compartiment OSS pour la sortie de l'instantané (emplacement OSS). |
example-location |
| Bucket |
string |
Le compartiment OSS où le fichier de sortie de l'instantané est stocké. |
example |
| Num |
string |
Le nombre d'instantanés. Si ce paramètre est spécifié, des instantanés séquentiels sont capturés. |
10 |
| TileOutputFile |
object |
Les configurations 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ù réside 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. Les valeurs sont des nombres à virgule flottante avec deux décimales. Les valeurs peuvent être en double et soumises dans le désordre, et sont triées par MPS. Vous pouvez spécifier jusqu'à 100 points temporels. Si ce paramètre est spécifié, ne spécifiez pas Num, Time ou Interval. Sinon, l'erreur InvalidParameter.Ambiguity est signalée. |
[10050, 50000, 110000, 1000500, 1100500] |
|
| State |
string |
L'état de l'instantané. Valeurs valides :
|
Snapshoting |
| Message |
string |
Le message d'erreur renvoyé lorsque la capture de l'instantané échoue. Ce paramètre n'est pas renvoyé si le travail réussit. |
The resource operated InputFile is bad |
| MNSMessageResult |
object |
Le résultat de la notification MNS envoyée à l'utilisateur à la fin du travail. |
|
| MessageId |
string |
L'identifiant du message renvoyé lorsque la notification réussit. Ce paramètre n'est pas renvoyé si la notification échoue. |
799454621135656C7F815F198A76**** |
| ErrorMessage |
string |
Le message d'erreur renvoyé lorsque la notification échoue. Ce paramètre n'est pas renvoyé si la notification réussit. |
The resource operated InputFile is bad |
| ErrorCode |
string |
Le code d'erreur renvoyé lorsque la notification échoue. Ce paramètre n'est pas renvoyé si la notification réussit. |
InvalidParameter |
| Input |
object |
L'entrée du travail. |
|
| 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ù réside 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. |
7 |
| UserData |
string |
Les données utilisateur personnalisées. |
testid-001 |
| Code |
string |
Le code d'erreur renvoyé lorsque la capture de l'instantané échoue. Ce paramètre n'est pas renvoyé si le travail réussit. |
InvalidParameter |
| PipelineId |
string |
L'identifiant de la file d'attente MPS. |
b11c171cced04565b1f38f1ecc39**** |
| Id |
string |
L'identifiant du travail de capture d'instantané. |
cc6cbef8e8d5481ca536f5d2a466**** |
| RequestId |
string |
L'identifiant de la requête. |
34BCAB31-2833-43A7-9FBD-B34302AB23EQ |
| NonExistSnapshotJobIds |
object |
||
| String |
array |
La liste des identifiants de travaux de capture d'instantané inexistants. |
|
|
string |
Les détails des identifiants de travaux de capture d'instantané inexistants. Ce paramètre n'est pas renvoyé si aucune donnée n'est disponible. |
c6d973c33d1c4b21bc39907d3b29**** |
|
| NextPageToken |
string |
Le jeton pour la page suivante, qui est un UUID de 32 caractères. Ce paramètre est renvoyé et mis à jour à chaque requête lorsque les résultats de la requête dépassent une page. |
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.