Method: projects.locations.queryConfigurablePricingUsageStats

Interroge les statistiques d'utilisation de la tarification configurable pour un projet.

Requête HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{project=projects/*}/locations/{location}:queryConfigurablePricingUsageStats

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
project

string

Obligatoire. Projet pour lequel interroger les statistiques d'utilisation. Format : projects/{project}
location

string

Obligatoire. Emplacement pour lequel interroger les statistiques d'utilisation.

Paramètres de requête

Paramètres
timeRange

object (TimeRange)

Facultatif. Période d'agrégation de l'utilisation. Si endDate n'est pas défini, la valeur par défaut est la date actuelle. Si startDate n'est pas défini, la valeur par défaut est 30 jours avant endDate.
metricTypes[]

enum (BillingMetricType)

Facultatif. Types de métriques pour lesquels renvoyer l'utilisation.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse pour la méthode [ProjectService.QueryConfigurablePricingUsageStats].

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "metricUsages": [
    {
      object (MetricUsage)
    }
  ]
}
Champs
metricUsages[]

object (MetricUsage)

Liste des utilisations des métriques, une pour chaque type de ressource demandé qui comporte des données dans la plage de dates demandée.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource project :

  • discoveryengine.projects.get

Pour en savoir plus, consultez la documentation IAM.

TimeRange

Période d'agrégation de l'utilisation.

Représentation JSON 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Champs
startDate

object (Date)

Facultatif. Date de début (incluse) de l'agrégation de l'utilisation.
endDate

object (Date)

Facultatif. Date de fin (incluse) de l'agrégation de l'utilisation.

BillingMetricType

Type de métrique de facturation pour les statistiques d'utilisation.

Enums
BILLING_METRIC_TYPE_UNSPECIFIED Valeur par défaut.
DAILY_MDN_QPM RPM médian quotidien des requêtes de recherche.
DAILY_MIN_QPM RPM minimal quotidien pour les requêtes de recherche.
DAILY_MAX_QPM RPM maximal quotidien pour les requêtes de recherche.
DAILY_SEARCH_REQUEST Nombre total de requêtes de recherche quotidiennes.
TOTAL_STORAGE Nombre total d'octets de stockage pour le cœur d'indexation.

MetricUsage

Utilisation d'une métrique sur une liste de jours.

Représentation JSON 
{
  "metricType": enum (BillingMetricType),
  "datedUsages": [
    {
      object (DatedUsage)
    }
  ],
  "totalUsage": number
}
Champs
metricType

enum (BillingMetricType)

Type de métrique.
datedUsages[]

object (DatedUsage)

Liste des utilisations pour ce type de ressource, triée par date de manière chronologique. Cette valeur est renseignée pour les métriques avec agrégation quotidienne, comme DAILY_MDN_QPM.
totalUsage

number

Utilisation totale pour ce type de ressource. Cette valeur est renseignée pour les métriques telles que TOTAL_STORAGE.

DatedUsage

Liste des utilisations pour un jour spécifique.

Représentation JSON 
{
  "date": {
    object (Date)
  },
  "usage": number
}
Champs
date

object (Date)

Date d'utilisation.
usage

number

Valeur d'utilisation à la date concernée.