DescribeVodDomainHitRateData - - Centre de documentation Alibaba Cloud

Consulte le taux de hit en octets (pourcentage d'octets servis depuis le cache) des noms de domaine accélérés.

Description de l'opération

Actuellement, le point de terminaison de cette opération d'API prend uniquement en charge Chine (Shanghai).
Les requêtes par lot sont prises en charge. Vous pouvez interroger les données de jusqu'à 500 noms de domaine à la fois.
Si vous ne spécifiez pas StartTime et EndTime, l'opération d'API renvoie par défaut les données des 24 dernières heures. Si vous spécifiez StartTime et EndTime, l'opération d'API renvoie les données pour la plage horaire spécifiée.

Granularité temporelle des données renvoyées

En fonction de la plage horaire spécifiée par StartTime et EndTime, si Interval n'est pas spécifié, la granularité temporelle par défaut des données renvoyées, la plage horaire correspondante des données historiques pouvant être interrogées et le délai des données sont les suivants :

Granularité temporelle	Plage horaire pour une requête unique	Plage horaire des données historiques pouvant être interrogées	Délai des données
5 minutes	Plage horaire pour une requête unique < 3 jours	93 jours	15 minutes
1 heure	3 jours ≤ Plage horaire pour une requête unique < 31 jours	186 jours	Généralement 3 à 4 heures
1 jour	31 jours ≤ Plage horaire pour une requête unique ≤ 366 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.

vod:DescribeVodDomainHitRateData

get

*Toutes les ressources.

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DomainName	string	Non	Le nom de domaine accéléré à interroger. Si vous ne spécifiez pas ce paramètre, les données regroupées de tous les noms de domaine accélérés sont renvoyées par défaut. Les requêtes par lot sont prises en charge. Séparez les noms de domaine multiples par des virgules (,). Vous pouvez interroger jusqu'à 500 noms de domaine à la fois. Vous pouvez vous connecter à la console ApsaraVideo VOD et choisir Gestion de la configuration > Configuration de la distribution > Noms de domaine dans le volet de navigation gauche pour afficher les noms de domaine accélérés ajoutés à ApsaraVideo VOD. Vous pouvez également appeler l'opération DescribeVodUserDomains pour interroger la liste des noms de domaine accélérés.	example.com
StartTime	string	Non	L'heure de début 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 UTC.	2024-01-20T13:59:58Z
EndTime	string	Non	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 UTC. Remarque L'heure de fin doit être postérieure à l'heure de début.	2024-01-20T14:59:58Z
Interval	string	Non	La granularité temporelle des données à interroger. Unité : secondes. Valeurs valides : 300, 3600 et 86400. Si vous ne spécifiez pas ce paramètre ou si vous spécifiez une valeur non prise en charge, la valeur par défaut est utilisée. En fonction de la plage horaire spécifiée par StartTime et EndTime, les granularités temporelles prises en charge sont les suivantes : Moins de 3 jours : 300 (par défaut), 3600 et 86400. De 3 à 31 jours (hors 31 jours) : 3600 (par défaut) et 86400. Plus de 31 jours : 86400 (par défaut).	300

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les résultats renvoyés.
EndTime	string	L'heure de fin des données. L'heure est affichée selon la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ en UTC.	2024-01-20T14:59:58Z
StartTime	string	L'heure de début des données. L'heure est affichée selon la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ en UTC.	2024-01-20T13:59:58Z
RequestId	string	L'identifiant de la requête.	D94E471F-1A27-442E-552D-D4D2000C****
DomainName	string	Le nom de domaine accéléré.	example.com
DataInterval	string	L'intervalle de temps entre chaque entrée de données, qui indique la granularité temporelle des données. Unité : secondes.	300
HitRateInterval	object
DataModule	array<object>	La liste des données de taux de hit en octets pour chaque intervalle de temps.
	object
Value	string	Le taux de hit en octets global.	100
TimeStamp	string	L'horodatage des données. Le format de date suit la norme ISO 8601 et utilise le fuseau UTC.	2024-01-20T13:59:58Z
HttpsValue	string	Le taux de hit en octets HTTPS.	50

Exemples

JSON format

{
  "EndTime": "2024-01-20T14:59:58Z",
  "StartTime": "2024-01-20T13:59:58Z",
  "RequestId": "D94E471F-1A27-442E-552D-D4D2000C****",
  "DomainName": "example.com",
  "DataInterval": "300",
  "HitRateInterval": {
    "DataModule": [
      {
        "Value": "100",
        "TimeStamp": "2024-01-20T13:59:58Z",
        "HttpsValue": "50"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	L'heure de début et l'heure de fin doivent toutes deux être spécifiées.
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.	L'heure de début et l'heure de fin ne correspondent pas.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.

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

Notes de version

Consultez Notes de version pour la liste complète.