DescribeWafUsageData - Edge Security Acceleration - Centre de documentation Alibaba Cloud

Description de l'opération

Durée de stockage maximale : 93 jours.
Plage de temps de requête maximale : 31 jours.
Plage de temps par défaut : 24 heures.

Toutes les heures sont exprimées en UTC+0.

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.

esa:DescribeWafUsageData

get

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
StartTime	string	Non	Le début de la plage de temps à interroger. Spécifiez l'heure selon la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure doit être en UTC+0.	2022-08-10T00:00:00Z
EndTime	string	Non	La fin de la plage de temps à interroger. Spécifiez l'heure selon la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure doit être en UTC+0. Remarque L'heure de fin doit être postérieure à l'heure de début.	2022-08-10T23:59:59Z
SiteId	integer	Non	L'identifiant du site. Vous pouvez appeler l'opération ListSites pour obtenir l'identifiant du site.	123456****
SplitBy	string	Non	La clé de regroupement. Vous pouvez définir ce paramètre sur domain. domain : regroupe les données par nom de domaine.	domain
Interval	string	Non	La granularité temporelle pour les données de requête, en secondes. Les valeurs valides varient en fonction de la plage de temps spécifiée par StartTime et EndTime : Moins de 3 jours : les valeurs valides sont 300, 3600 et 86400. Valeur par défaut : 300. De 3 à 31 jours (31 jours exclus) : les valeurs valides sont 3600 et 86400. Valeur par défaut : 3600. 31 jours ou plus : la seule valeur valide est 86400. Valeur par défaut : 86400.	300
RecordName	string	Non	Le nom de l'enregistrement de domaine. Vous pouvez appeler l'opération ListSites pour obtenir le nom de l'enregistrement de domaine.	test.example.com

Éléments de réponse

Élément	Type	Description	Exemple
	object
EndTime	string	La fin de la plage de temps pour les données renvoyées. L'heure est selon la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure est en UTC+0.	2022-08-10T23:59:59Z
StartTime	string	Le début de la plage de temps à interroger. Spécifiez l'heure selon la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure doit être en UTC+0.	2022-08-10T00:00:00Z
RequestId	string	L'identifiant de la requête.	C370DAF1-C838-4288-A1A0-9A87633D2***
UsageData	array<object>	Les données renvoyées.
	object	Les données renvoyées.
ObserveCount	integer	Le nombre de requêtes observées.	123
RecordName	string	Le nom de l'enregistrement de domaine.	test.example.com
BlockCount	integer	Le nombre de requêtes bloquées.	123
AccessCount	integer	Le nombre de requêtes avec un accès normal.	123
TimeStamp	string	Le début de l'intervalle de temps. L'heure est selon la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure est en UTC+0.	2022-08-10T00:00:00Z

Exemples

JSON format

{
  "EndTime": "2022-08-10T23:59:59Z",
  "StartTime": "2022-08-10T00:00:00Z",
  "RequestId": "C370DAF1-C838-4288-A1A0-9A87633D2***",
  "UsageData": [
    {
      "ObserveCount": 123,
      "RecordName": "test.example.com",
      "BlockCount": 123,
      "AccessCount": 123,
      "TimeStamp": "2022-08-10T00:00:00Z"
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParameter	Parameter verification failed. Check your configurations and try again.	Parameter verification failed. Check your configurations and try again.
400	TooManyRequests	Too many requests.Please try again later.	Requests are too frequent, please try again later.
400	QuotaCheckFailed.Function	The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.	The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time you entered is earlier than the start time. Please check and try again.
400	InvalidParameter.TimeRange	The specified time range exceeds the limit. Adjust it and try again.	The specified time range exceeds the limit. Adjust it and try again.
400	InvalidParameter.Field	The specified Field is invalid.	The specified Field is invalid. For more information, see OpenAPI Documentation .
400	InvalidTime.Malformed	Specified start time or end time is malformed.	The specified time format is incorrect. The time must conform to the yyyy-MM-ddTHH:mm:ssZ format. Please enter it correctly and try again.

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

Notes de version

Consultez Notes de version pour la liste complète.