Method: projects.locations.queryConfigurablePricingUsageStats

プロジェクトの構成可能な料金の使用状況統計情報をクエリします。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
project

string

必須。使用状況の統計情報をクエリするプロジェクト。形式: projects/{project}
location

string

必須。使用状況の統計情報をクエリする場所。

クエリ パラメータ

パラメータ
timeRange

object (TimeRange)

省略可。使用量の集計期間。endDate が設定されていない場合、デフォルトは現在の日付になります。startDate が設定されていない場合、デフォルトは endDate の 30 日前になります。
metricTypes[]

enum (BillingMetricType)

省略可。使用状況を返す指標タイプ。

リクエストの本文

リクエスト本文は空にする必要があります。

レスポンスの本文

[ProjectService.QueryConfigurablePricingUsageStats] メソッドのレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "metricUsages": [
    {
      object (MetricUsage)
    }
  ]
}
フィールド
metricUsages[]

object (MetricUsage)

指標使用状況のリスト（リクエストされた期間にデータがあるリクエストされたリソースタイプごとに 1 つ）。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

project リソースに対する次の IAM 権限が必要です。

  • discoveryengine.projects.get

詳細については、IAM のドキュメントをご覧ください。

TimeRange

使用量の集計期間。

JSON 表現 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
フィールド
startDate

object (Date)

省略可。使用状況の集計の開始日（その日付を含む）。
endDate

object (Date)

省略可。使用状況の集計の終了日（その日付を含む）。

BillingMetricType

使用状況統計情報の請求指標のタイプ。

列挙型
BILLING_METRIC_TYPE_UNSPECIFIED デフォルト値。
DAILY_MDN_QPM 1 日あたりの検索リクエスト QPM の中央値。
DAILY_MIN_QPM 1 日あたりの検索リクエスト QPM の最小値。
DAILY_MAX_QPM 1 日あたりの検索リクエスト QPM の最大値。
DAILY_SEARCH_REQUEST 1 日あたりの検索リクエストの合計数。
TOTAL_STORAGE インデックス登録コアの合計ストレージ バイト数。

MetricUsage

一連の日付における指標の使用状況。

JSON 表現 
{
  "metricType": enum (BillingMetricType),
  "datedUsages": [
    {
      object (DatedUsage)
    }
  ],
  "totalUsage": number
}
フィールド
metricType

enum (BillingMetricType)

指標タイプ。
datedUsages[]

object (DatedUsage)

このリソースタイプの使用状況のリスト。日付順に並べ替えられています。これは、DAILY_MDN_QPM のような日次集計を行う指標に対してデータが入力されます。
totalUsage

number

このリソースタイプの合計使用量。これは、TOTAL_STORAGE などの指標に対してデータが入力されます。

DatedUsage

特定の一日の使用状況のリスト。

JSON 表現 
{
  "date": {
    object (Date)
  },
  "usage": number
}
フィールド
date

object (Date)

使用状況の日付。
usage

number

その日の使用量。