- Solicitud HTTP
- Parámetros de ruta
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- TimeRange
- BillingMetricType
- MetricUsage
- DatedUsage
Obtiene estadísticas de uso de precios configurables.
Solicitud HTTP
GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/configurablePricingUsageStats}
La URL utiliza la sintaxis de transcodificación a gRPC.
Parámetros de ruta
Parámetros | |
---|---|
name |
Obligatorio. Nombre de ConfigurablePricingUsageStats que se va a obtener. Formato: projects/{project}/locations/{location}/configurablePricingUsageStats |
Los parámetros de consulta
Parámetros | |
---|---|
timeRange |
Opcional. El periodo de la agregación de uso. Si no se define endDate, se le asignará la fecha actual de forma predeterminada. Si no se define startDate, se le asignará el valor predeterminado de 30 días antes de endDate. |
metricTypes[] |
Opcional. Tipos de métricas de los que se va a devolver el uso. |
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Respuesta del método [EstimateBillingService.GetConfigurablePricingUsageStats].
Si la solicitud se realiza correctamente, el cuerpo de la respuesta proporciona datos con la siguiente estructura:
Representación JSON |
---|
{
"name": string,
"metricUsages": [
{
object ( |
Campos | |
---|---|
name |
Identificador. Nombre de ConfigurablePricingUsageStats. Formato: projects/{project}/locations/{location}/configurablePricingUsageStats |
metricUsages[] |
Lista de usos de métricas, uno por cada tipo de recurso solicitado que tenga datos en el periodo solicitado. |
Permisos de autorización
Debes disponer de uno de los siguientes permisos de OAuth:
https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/discoveryengine.readwrite
Para obtener más información, consulta el Authentication Overview.
TimeRange
El periodo de la agregación de uso.
Representación JSON |
---|
{ "startDate": { object ( |
Campos | |
---|---|
startDate |
Opcional. Fecha de inicio inclusiva de la agregación de uso. |
endDate |
Opcional. Fecha de finalización (inclusive) de la agregación de uso. |
BillingMetricType
Tipo de métrica de facturación de las estadísticas de uso.
Enumeraciones | |
---|---|
BILLING_METRIC_TYPE_UNSPECIFIED |
Valor predeterminado. |
DAILY_MDN_QPM |
Mediana diaria de las consultas por minuto de las solicitudes de búsqueda. |
DAILY_MIN_QPM |
QPM de solicitudes de búsqueda mínimas diarias. |
DAILY_MAX_QPM |
Máximo diario de solicitudes de búsqueda por minuto. |
DAILY_SEARCH_REQUEST |
Total de solicitudes de búsqueda diarias. |
TOTAL_STORAGE |
Número total de bytes de almacenamiento del índice principal. |
MetricUsage
El uso de una métrica en una lista de días.
Representación JSON |
---|
{ "metricType": enum ( |
Campos | |
---|---|
metricType |
El tipo de métrica. |
datedUsages[] |
Lista de usos de este tipo de recurso, ordenada cronológicamente por fecha. Se rellena en el caso de las métricas con agregación diaria, como DAILY_MDN_QPM. |
totalUsages[] |
Lista del número total de usos de este tipo de recurso. |
DatedUsage
Lista de usos de un día concreto.
Representación JSON |
---|
{
"date": {
object ( |
Campos | |
---|---|
date |
Fecha del uso. |
usage |
El valor de uso en la fecha. |