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. Plage de dates de l'agrégation de l'utilisation. Si endDate n'est pas défini, la date actuelle est utilisée par défaut. Si startDate n'est pas défini, la date 30 jours avant endDate est utilisée par défaut.
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 à 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 de métriques, une pour chaque type de ressource demandé qui contient des données dans la plage de dates demandée.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la page 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

Plage de dates de l'agrégation de l'utilisation.

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

object (Date)

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

object (Date)

Facultatif. Date de fin (inclusive) 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 QPM médian quotidien des requêtes de recherche.
DAILY_MIN_QPM QPM minimal quotidien des requêtes de recherche.
DAILY_MAX_QPM QPM maximal quotidien des requêtes de recherche.
DAILY_SEARCH_REQUEST Total quotidien des requêtes de recherche.
TOTAL_STORAGE Nombre total d'octets de stockage pour l'indexation de base.

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ées par date dans l'ordre chronologique. Ce champ est renseigné pour les métriques avec agrégation quotidienne, comme DAILY_MDN_QPM.
totalUsage

number

Utilisation totale pour ce type de ressource. Ce champ est renseigné pour les métriques comme TOTAL_STORAGE.

DatedUsage

Liste des utilisations pour un jour spécifique.

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

object (Date)

Date de l'utilisation.
usage

number

Valeur de l'utilisation à la date.