- HTTP リクエスト
- パスパラメータ
- クエリ パラメータ
- リクエストの本文
- レスポンスの本文
- 認可スコープ
- TimeRange
- BillingMetricType
- MetricUsage
- DatedUsage
構成可能な料金の使用状況統計情報を取得します。
HTTP リクエスト
GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/configurablePricingUsageStats}
この URL では gRPC Transcoding 構文を使用します。
パスパラメータ
| パラメータ | |
|---|---|
name |
必須。取得する ConfigurablePricingUsageStats の名前。形式: projects/{project}/locations/{location}/configurablePricingUsageStats |
クエリ パラメータ
| パラメータ | |
|---|---|
timeRange |
省略可。使用量の集計期間。endDate が設定されていない場合、デフォルトは現在の日付になります。startDate が設定されていない場合、デフォルトは endDate の 30 日前になります。 |
metricTypes[] |
省略可。使用状況を返す指標タイプ。 |
リクエストの本文
リクエストの本文は空にする必要があります。
レスポンスの本文
[EstimateBillingService.GetConfigurablePricingUsageStats] メソッドのレスポンス。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
| JSON 表現 |
|---|
{
"name": string,
"metricUsages": [
{
object ( |
| フィールド | |
|---|---|
name |
ID。ConfigurablePricingUsageStats の名前。形式: projects/{project}/locations/{location}/configurablePricingUsageStats |
metricUsages[] |
指標使用状況のリスト(リクエストされた期間にデータがあるリクエストされたリソースタイプごとに 1 つ)。 |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/discoveryengine.readwrite
詳細については、Authentication Overview をご覧ください。
TimeRange
使用量の集計期間。
| JSON 表現 |
|---|
{ "startDate": { object ( |
| フィールド | |
|---|---|
startDate |
省略可。使用状況の集計の開始日(その日付を含む)。 |
endDate |
省略可。使用状況の集計の終了日(その日付を含む)。 |
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 ( |
| フィールド | |
|---|---|
metricType |
指標タイプ。 |
datedUsages[] |
このリソースタイプの使用状況のリスト。日付順に並べ替えられています。これは、DAILY_MDN_QPM のような日次集計を行う指標に対してデータが入力されます。 |
totalUsages[] |
このリソースタイプの合計使用量のリスト |
DatedUsage
特定の一日の使用状況のリスト。
| JSON 表現 |
|---|
{
"date": {
object ( |
| フィールド | |
|---|---|
date |
使用状況の日付。 |
usage |
その日の使用量。 |