Method: projects.locations.queryConfigurablePricingUsageStats

Consulta estatísticas de uso de preços configuráveis para um projeto.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
project

string

Obrigatório. O projeto para consultar as estatísticas de uso. Formato: projects/{project}
location

string

Obrigatório. O local para consultar as estatísticas de uso.

Parâmetros de consulta

Parâmetros
timeRange

object (TimeRange)

Opcional. O período da agregação de uso. Se endDate não estiver definido, o padrão será a data atual. Se "startDate" não estiver definido, o padrão será 30 dias antes de "endDate".
metricTypes[]

enum (BillingMetricType)

Opcional. Os tipos de métricas para retornar o uso.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta do método [ProjectService.QueryConfigurablePricingUsageStats].

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "metricUsages": [
    {
      object (MetricUsage)
    }
  ]
}
Campos
metricUsages[]

object (MetricUsage)

Uma lista de usos de métricas, um para cada tipo de recurso solicitado que tem dados no período especificado.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso project:

  • discoveryengine.projects.get

Para mais informações, consulte a documentação do IAM.

TimeRange

O período da agregação de uso.

Representação JSON 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Campos
startDate

object (Date)

Opcional. A data de início inclusiva da agregação de uso.
endDate

object (Date)

Opcional. A data de término inclusiva da agregação de uso.

BillingMetricType

tipo de métrica de faturamento para estatísticas de uso.

Tipos enumerados
BILLING_METRIC_TYPE_UNSPECIFIED Valor padrão.
DAILY_MDN_QPM QPM mediana diária de solicitações de pesquisa.
DAILY_MIN_QPM QPM diária mínima de solicitações de pesquisa.
DAILY_MAX_QPM QPM máximo diário de solicitações de pesquisa.
DAILY_SEARCH_REQUEST Total de solicitações de pesquisa diárias.
TOTAL_STORAGE Total de bytes de armazenamento para indexação principal.

MetricUsage

O uso de uma métrica em uma lista de dias.

Representação JSON 
{
  "metricType": enum (BillingMetricType),
  "datedUsages": [
    {
      object (DatedUsage)
    }
  ],
  "totalUsage": number
}
Campos
metricType

enum (BillingMetricType)

O tipo de métrica.
datedUsages[]

object (DatedUsage)

A lista de usos para esse tipo de recurso, classificada cronologicamente por data. Isso é preenchido para métricas com agregação diária, como DAILY_MDN_QPM.
totalUsage

number

O uso total desse tipo de recurso. Isso é preenchido para métricas como TOTAL_STORAGE.

DatedUsage

Uma lista de usos para um dia específico.

Representação JSON 
{
  "date": {
    object (Date)
  },
  "usage": number
}
Campos
date

object (Date)

A data do uso.
usage

number

O valor de uso na data.