DescribeVodRefreshTasks - - Centre de documentation Alibaba Cloud

Vérifie si les tâches de purge et de préchargement ont pris effet.

Description de l'opération

Actuellement, l'adresse du service prend uniquement en charge Chine (Shanghai).
Si ni TaskId ni ObjectPath n'est spécifié, la première page de données (20 entrées) des 3 derniers jours est renvoyée par défaut. TaskId et ObjectPath peuvent être spécifiés en même temps.
Lorsque DomainName ou Status est spécifié, ObjectType est requis.

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.

vod:DescribeVodRefreshTasks

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
TaskId	string	Non	L'identifiant de la tâche utilisé pour consulter l'état de la purge.	70422****
ObjectPath	string	Non	Le chemin utilisé pour la requête. Une correspondance exacte est utilisée.	http://example.com/***.txt
PageNumber	integer	Non	Le numéro de page.	1
ObjectType	string	Non	Le type de tâche. Valeurs valides : file : purge de fichier. directory : purge de répertoire. preload : préchargement de fichier. Remarque Lorsque DomainName ou Status est spécifié, ObjectType est requis.	file
DomainName	string	Non	Le nom de domaine.	example.com
Status	string	Non	L'état de la tâche. Valeurs valides : Complete : terminé. Refreshing : en cours. Failed : échoué.	Complete
PageSize	integer	Non	Le nombre d'entrées par page. Valeur par défaut : 20. Valeur maximale : 50.	20
StartTime	string	Non	L'heure de début. Spécifiez l'heure au format yyyy-MM-ddTHH:mm:ssZ (UTC). Remarque Seules les données des 3 derniers jours peuvent être consultées.	2017-01-01T12:12:20Z
EndTime	string	Non	L'heure de fin. Spécifiez l'heure au format yyyy-MM-ddTHH:mm:ssZ (UTC).	2017-01-01T12:30:20Z

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	174F6032-AA26-470D-****-36F0EB205BEE
PageNumber	integer	Le numéro de page.	1
PageSize	integer	La taille de la page.	10
TotalCount	integer	Le nombre total d'entrées.	2
Tasks	object
Task	array<object>	La liste des tâches composée d'objets TaskItem.
	object
Status	string	The status. Valid values: Complete: completed. Refreshing: in progress. Failed: failed. Pending: pending.	Complete
CreationTime	string	The time when the task object was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2014-11-27T08:23:22Z
ObjectType	string	The task type. Valid values: file (default): file purge. directory: directory purge. preload: file prefetch.	file
Process	string	The progress percentage.	100%
Description	string	The error description returned when a purge or prefetch task fails. There are currently three types: Internal Error: an internal error occurred. Origin Timeout: the origin server response timed out. Origin Return StatusCode 5XX: the origin server returned a 5XX status code.	Internal Error
ObjectPath	string	The object path of the purge task.	http://example.com/****.txt
TaskId	string	The task ID.	704225667

Exemples

JSON format

{
  "RequestId": "174F6032-AA26-470D-****-36F0EB205BEE",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 2,
  "Tasks": {
    "Task": [
      {
        "Status": "Complete",
        "CreationTime": "2014-11-27T08:23:22Z",
        "ObjectType": "file",
        "Process": "100%",
        "Description": "Internal Error",
        "ObjectPath": "http://example.com/****.txt",
        "TaskId": "704225667"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidTaskId.Malformed	The specified TaskId is invalid.	Invalid TaskId
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	Both start time and end must be specified
400	MissingParameter.ObjectType	The ObjectType parameter is required if DomainName or ObjectType is specified.
400	InvalidStartTime.Malformed	The specified StartTime is invalid.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	End time is earlier than start time
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.
400	InvalidObjectType.ValueNotSupported	The specified ObjectType is not supported.
400	InvalidStatus.ValueNotSupported	The specified Status is not supported.
400	DomainNameOverLimit	A maximum of 500 domains are supported for each request.	Up to 500 domain names per request
400	InvalidTime	The query time cannot exceed the last 3 days.	The request time cannot be returned for more than 3 days.

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

Notes de version

Consultez Notes de version pour la liste complète.