DescribeDomainUsageData - - Centre de documentation Alibaba Cloud

Consulte les données d'utilisation des noms de domaine dans une région de facturation spécifique.

Description de l'opération

Fréquence d'appel par utilisateur : 10 appels par seconde.
Granularité temporelle prise en charge : en fonction de la durée maximale d'une requête unique, le paramètre de requête Interval prend en charge différentes granularités temporelles pour les données interrogées. La plage de temps correspondante des données historiques interrogeables et la latence des données sont les suivantes :

Granularité temporelle	Durée maximale d'une requête unique	Plage de temps des données historiques interrogeables	Latence des données
5 minutes	3 jours	93 jours	15 minutes
1 heure	7 jours	186 jours	Généralement 3 à 4 heures
1 jour	31 jours	366 jours	Généralement 4 heures, jusqu'à 24 heures

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.

cdn:DescribeDomainUsageData

none

*Domaine.

acs:cdn:*:{#accountId}:domain/{#DomainName}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DomainName	string	Non	Le nom de domaine accéléré à interroger. Vous pouvez spécifier plusieurs noms de domaine séparés par des virgules (,). Un maximum de 100 noms de domaine peut être spécifié dans une seule requête. Remarque Si ce paramètre est laissé vide, les données fusionnées de tous les noms de domaine accélérés sous le compte sont renvoyées par défaut.	example.com
StartTime	string	Oui	L'heure de début des données à interroger. Spécifiez l'heure selon la norme ISO 8601 en temps UTC. Le format est yyyy-MM-ddTHH:mm:ssZ. Remarque La granularité temporelle des données interrogées est de 5 minutes.	2015-12-10T20:00:00Z
EndTime	string	Oui	L'heure de fin des données à interroger. Spécifiez l'heure selon la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure doit être en temps UTC. Remarque L'heure de fin doit être postérieure à l'heure de début, et la durée ne peut pas dépasser 31 jours.	2015-12-10T22:00:00Z
Field	string	Oui	Le type de données à interroger. Valeurs valides : bps : bande passante. traf : trafic. acc : nombre de requêtes. Remarque acc ne prend pas en charge les requêtes basées sur le paramètre Area.	bps
Type	string	Non	Le type de données d'utilisation à interroger. Valeurs valides : static : contenu statique. dynamic : contenu dynamique. all (par défaut) : tous les types.	static
DataProtocol	string	Non	Le protocole des données à interroger. Valeurs valides : http : HTTP. https : HTTPS. quic : QUIC. all (par défaut) : tous les protocoles précédents.	all
Area	string	Non	Le code de la région. Valeurs valides : CN (par défaut) : la Chine continentale. OverSeas : mondial (hors Chine continentale). AP1 : Asie-Pacifique 1. AP2 : Asie-Pacifique 2. AP3 : Asie-Pacifique 3. NA : Amérique du Nord. SA : Amérique du Sud. EU : Europe. MEAA : Moyen-Orient et Afrique. all : toutes les régions précédentes.	CN
Interval	string	Non	La granularité temporelle des données à interroger, en secondes. Valeurs valides : 300 (5 minutes), 3600 (1 heure) et 86400 (1 jour). Interval=300 : vous pouvez interroger les données des six derniers mois. La plage de temps maximale d'une requête unique est de 3 jours. Interval=3600 ou 86400 : vous pouvez interroger les données de l'année dernière. Si Interval n'est pas spécifié : la plage de temps maximale d'une requête unique est de 1 mois. Si la plage de temps de la requête est de 1 à 3 jours, les données sont renvoyées avec une granularité horaire. Si la plage de temps de la requête est de 4 jours ou plus, les données sont renvoyées avec une granularité quotidienne.	300
ServiceType	string	Non

Combinaisons de paramètres

Le tableau suivant décrit les correspondances entre les données de facturation et les valeurs des paramètres. Pour plus d'informations sur la façon d'appeler l'opération, consultez les exemples de requêtes.

Données de facturation	DataProtocol	Type	Field	Area
Trafic	all ou non spécifié	all ou non spécifié	traf	CN, OverSeas, AP1, AP2, AP3, NA, SA, EU, MEAA
Bande passante	all ou non spécifié	all ou non spécifié	bps	CN, OverSeas, AP1, AP2, AP3, NA, SA, EU, MEAA
Requête HTTPS pour du contenu statique	https	static	acc	all
Requêtes HTTP pour du contenu dynamique	http	dynamic	acc	all
Requêtes HTTPS pour du contenu dynamique	https	dynamic	acc	all
Requête QUIC pour du contenu dynamique (ressources)	quic	dynamic	acc	all
Requête QUIC pour du contenu statique (ressources)	quic	static	acc	all

Éléments de réponse

Élément	Type	Description	Exemple
	object	La liste des paramètres.
RequestId	string	L'identifiant de la requête.	B955107D-E658-4E77-B913-E0AC3D31693E
DomainName	string	Le nom de domaine accéléré.	example.com
StartTime	string	L'heure de début. L'heure est affichée selon la norme ISO 8601 en temps UTC.	2015-12-10T20:00:00Z
EndTime	string	L'heure de fin. L'heure est affichée selon la norme ISO 8601 en temps UTC.	2015-12-10T22:00:00Z
Type	string	Le type d'utilisation.	bps
Area	string	La région d'utilisation.	CN
DataInterval	string	L'intervalle de temps de chaque enregistrement, en secondes.	300
UsageDataPerInterval	object
DataModule	array<object>	Les données d'utilisation pour chaque intervalle de temps.
	object	Les données d'utilisation pour chaque intervalle de temps.
Value	string	La valeur d'utilisation.	423304182
TimeStamp	string	L'heure de début de la tranche de temps. Remarque Plusieurs valeurs TimeStamp renvoyées dans les données sont appelées tranches de temps. L'heure est affichée selon la norme ISO 8601 en temps UTC.	2015-12-10T21:30:00Z
PeakTime	string	L'heure à laquelle la bande passante de pointe est atteinte si Field est défini sur bps. Sinon, la valeur est identique à TimeStamp.	2015-12-10T21:30:00Z
SpecialValue	string	L'utilisation spéciale. Remarque Ce paramètre est utilisé pour marquer la valeur d'utilisation dans des cas particuliers. Vous pouvez ignorer ce paramètre si aucune facturation spéciale n'est impliquée.	423304182

Exemples

JSON format

{
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "DomainName": "example.com",
  "StartTime": "2015-12-10T20:00:00Z",
  "EndTime": "2015-12-10T22:00:00Z",
  "Type": "bps",
  "Area": "CN",
  "DataInterval": "300",
  "UsageDataPerInterval": {
    "DataModule": [
      {
        "Value": "423304182",
        "TimeStamp": "2015-12-10T21:30:00Z",
        "PeakTime": "2015-12-10T21:30:00Z",
        "SpecialValue": "423304182"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParameter	The specified parameter is invalid.	Une exception s'est produite lors de la suppression de la région de diffusion en direct.
400	InvalidParameterType	The specified Type is invalid.	Le paramètre Type est invalide. Vérifiez le paramètre et réessayez.
400	InvalidParameterField	The specified Field is invalid.	Le paramètre Field n'est pas valide. Vérifiez la valeur et réessayez.
400	InvalidParameterStartTime	The parameter StartTime is invalid.	Le paramètre StartTime est invalide.
400	InvalidParameterEndTime	The parameter EndTime is invalid.	Le paramètre EndTime n'est pas valide.
400	InvalidEndTime.Mismatch	Specified EndTime does not match the specified StartTime.	Vérifiez si les paramètres de temps sont corrects. L'heure de fin ne peut pas être antérieure ou égale à l'heure de début.
400	InvalidIntervalParameter	The specified Interval is invalid.	La granularité temporelle spécifiée n'est pas valide.
400	InvalidTimeSpan	The time span exceeds the limit.	L'intervalle de temps dépasse la limite. Consultez la documentation de l'API pour configurer un intervalle de temps de requête valide.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.
400	InvalidTime.Malformed	Specified StartTime or EndTime is malformed.	L'heure de début et l'heure de fin ne correspondent pas.

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

Notes de version

Consultez Notes de version pour la liste complète.