אחזור מטא-נתונים של דוח

כדי לבדוק את הגדרות הדוח, כמו ההיקף והמדדים שלו, או כדי לבדוק את מועד התפוגה שלו, משתמשים ב-App Optimize API כדי לקבל את המטא-נתונים של הדוח.

בקשת ה-API הזו לא מחזירה את שורות הנתונים בפועל בדוח. כדי להוריד את המידע הזה, צריך לקרוא את נתוני הדוח.

לפני שמתחילים

gcloud

במסוף Google Cloud , מפעילים את Cloud Shell.

הפעלת Cloud Shell

בחלק התחתון של Google Cloud המסוף יתחיל סשן של Cloud Shell ותופיע הודעה של שורת הפקודה. Cloud Shell היא סביבת מעטפת שבה ה-CLI של Google Cloud מותקן ומוגדרים ערכים לפרויקט הקיים. הסשן יופעל תוך כמה שניות.

למידע נוסף על הגדרת אימות בסביבת ייצור, ראו את המאמר בנושא הגדרת Application Default Credentials לקוד שפועל ב- Google Cloud במאמרי העזרה בנושא אימות ב- Google Cloud .

Python

  1. מתקינים את ספריית הלקוח של Python עבור App Optimize API.

  2. כדי להשתמש בסביבת פיתוח מקומית בדוגמאות של Python שבדף הזה, מתקינים ומפעילים את ה-CLI של gcloud, ואז מגדירים את Application Default Credentials באמצעות פרטי הכניסה של המשתמש.

    1. התקינו את ה-CLI של Google Cloud.

    2. אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

    3. אם אתם משתמשים במעטפת מקומית, אתם צריכים ליצור פרטי כניסה לאימות מקומי עבור חשבון המשתמש: 

      gcloud auth application-default login

      אם אתם משתמשים ב-Cloud Shell, אין צורך לבצע את הפעולה הזו.

      אם מוחזרת שגיאת אימות ואתם משתמשים בספק זהויות חיצוני (IdP), ודאו ש נכנסתם ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

    למידע נוסף, ראו הגדרת ADC לסביבת פיתוח מקומית במאמרי העזרה בנושא אימות Google Cloud .

    למידע נוסף על הגדרת אימות בסביבת ייצור, ראו את המאמר בנושא הגדרת Application Default Credentials לקוד שפועל ב- Google Cloud במאמרי העזרה בנושא אימות ב- Google Cloud .

REST

כדי להשתמש בסביבת פיתוח מקומית בדוגמאות של API בארכיטקטורת REST שבדף הזה, צריך להשתמש בפרטי הכניסה שאתם נותנים ל-CLI של gcloud.

    התקינו את ה-CLI של Google Cloud.

    אם אתם משתמשים בספק זהויות חיצוני (IdP), קודם אתם צריכים להיכנס ל-CLI של gcloud באמצעות המאגר המאוחד לניהול זהויות.

מידע נוסף מופיע במאמר אימות לשימוש ב-REST במסמכי האימות של Google Cloud .

למידע נוסף על הגדרת אימות בסביבת ייצור, ראו את המאמר בנושא הגדרת Application Default Credentials לקוד שפועל ב- Google Cloud במאמרי העזרה בנושא אימות ב- Google Cloud .

התפקידים הנדרשים

כדי לקבל את ההרשאות שנדרשות לקריאת מטא-נתונים של דוח, צריך לבקש מהאדמין להקצות לכם את תפקיד ה-IAM ‏App Optimize Viewer (roles/appoptimize.viewer) בפרויקט שכולל את משאב הדוח. כדי לקרוא הסבר על מתן תפקידים, ראו איך מנהלים את הגישה ברמת הפרויקט, התיקייה והארגון.

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

אחזור מטא-נתונים של דוח

כדי לאחזר את המטא-נתונים של דוח, פועלים לפי ההוראות של השיטה המועדפת:

gcloud

משתמשים בפקודה gcloud beta app-optimize reports describe כדי לקבל את המטא-נתונים של דוח.

gcloud beta app-optimize reports describe REPORT_ID \
  --project=PROJECT_ID \
  --location=global

מחליפים את מה שכתוב בשדות הבאים:

  • ‫PROJECT_ID: המזהה של Google Cloud הפרויקט שכולל את משאב הדוח שרוצים לאחזר.
  • ‫REPORT_ID: המזהה של הדוח לאחזור. המזהה הזה צוין כשנוצר הדוח, ואפשר לקבל אותו על ידי הצגת רשימת הדוחות.

Python

קוד ה-Python הבא משתמש ב-AppOptimizeClient.get_report() כדי לאחזר את המטא-נתונים של דוח.

from google.cloud import appoptimize_v1beta

project_id = "PROJECT_ID"
report_id = "REPORT_ID"
name = f"projects/{project_id}/locations/global/reports/{report_id}"

# Create the App Optimize client and request the report's metadata
client = appoptimize_v1beta.AppOptimizeClient()
request = appoptimize_v1beta.GetReportRequest(name=name)
response = client.get_report(request=request)

# Display the metadata
print(response)

מחליפים את מה שכתוב בשדות הבאים:

  • ‫PROJECT_ID: המזהה של Google Cloud הפרויקט שכולל את משאב הדוח שרוצים לאחזר.
  • ‫REPORT_ID: המזהה של הדוח לאחזור. המזהה הזה צוין כשנוצר הדוח, ואפשר לקבל אותו על ידי הצגת רשימת הדוחות.

REST

משתמשים בפקודה curl הבאה כדי לקבל את המטא-נתונים של הדוח:

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://appoptimize.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/reports/REPORT_ID"

מחליפים את מה שכתוב בשדות הבאים:

  • ‫PROJECT_ID: המזהה של Google Cloud הפרויקט שכולל את משאב הדוח שרוצים לאחזר.
  • ‫REPORT_ID: המזהה של הדוח לאחזור. המזהה הזה צוין כשנוצר הדוח, ואפשר לקבל אותו על ידי הצגת רשימת הדוחות.

אם הבקשה תתבצע בהצלחה, ה-API יחזיר תגובת JSON שתכיל את המטא-נתונים של הדוח. זו דוגמה לתשובה מוצלחת, כולל המאפיין והמדד שנבחרו, היקף הפרויקט והמועד שבו הדוח אמור לפוג:

{
  "name": "projects/PROJECT_ID/locations/global/reports/REPORT_ID",
  "dimensions": [
    "location",
    "product_display_name",
    "project",
    "resource",
    "resource_type"
  ],
  "scopes": [
    {
      "project": "projects/PROJECT_ID"
    }
  ],
  "filter": "hour >= now - duration(\"168h\")",
  "expireTime": "2026-02-05T18:50:25.273833857Z",
  "metrics": [
    "cost",
    "cpu_mean_utilization"
  ]
}

המאמרים הבאים