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)

זה שינוי אופציונלי. טווח הזמן של צבירת נתוני השימוש. אם לא מוגדר תאריך סיום, ברירת המחדל היא התאריך הנוכחי. אם לא מגדירים את startDate, ברירת המחדל היא 30 ימים לפני endDate.
metricTypes[]

enum (BillingMetricType)

זה שינוי אופציונלי. סוגי המדדים שרוצים לקבל לגביהם נתוני שימוש.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

תשובה לשיטה [ProjectService.QueryConfigurablePricingUsageStats].

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "metricUsages": [
    {
      object (MetricUsage)
    }
  ]
}
שדות
metricUsages[]

object (MetricUsage)

רשימה של שימושים במדדים, אחד לכל סוג משאב שנתבקש שיש לו נתונים בטווח התאריכים שצוין בבקשה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב project:

  • discoveryengine.projects.get

מידע נוסף מופיע במאמרי העזרה בנושא IAM.

TimeRange

טווח הזמן של צבירת נתוני השימוש.

ייצוג ב-JSON 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
שדות
startDate

object (Date)

זה שינוי אופציונלי. תאריך ההתחלה של צבירת נתוני השימוש, כולל התאריך עצמו.
endDate

object (Date)

זה שינוי אופציונלי. תאריך הסיום של צבירת נתוני השימוש, כולל התאריך הזה.

BillingMetricType

סוג מדד החיוב לנתוני השימוש.

טיפוסים בני מנייה (enum)
BILLING_METRIC_TYPE_UNSPECIFIED ערך ברירת המחדל.
DAILY_MDN_QPM ממוצע יומי של בקשות חיפוש חציוניות לדקה.
DAILY_MIN_QPM QPM מינימלי יומי של בקשות חיפוש.
DAILY_MAX_QPM מקסימום יומי של בקשות חיפוש לדקה (QPM).
DAILY_SEARCH_REQUEST המספר הכולל של בקשות החיפוש היומיות.
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

ערך השימוש בתאריך.