דוחות של רשימות

אתם יכולים להציג רשימה של דוחות בפרויקט Google Cloud כדי לזהות דוחות שאתם רוצים לקרוא או למחוק לפני תאריך התפוגה.

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

gcloud

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

  • הגדירו שה-CLI של gcloud ישתמש בזהות המאוחדת שלכם.

    איך נכנסים ל-CLI של gcloud באמצעות הזהות המאוחדת?

  • כדי לאתחל את ה-CLI של gcloud, הריצו את הפקודה הבאה: 

    gcloud init

  • אחרי שתאתחלו את ה-CLI של gcloud, עדכנו אותו והתקינו את הרכיבים הנדרשים: 

    gcloud components update
gcloud components install beta

    • למידע נוסף על הגדרת אימות בסביבת ייצור, ראו את המאמר בנושא הגדרת 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. הגדירו שה-CLI של gcloud ישתמש בזהות המאוחדת שלכם.

        איך נכנסים ל-CLI של gcloud באמצעות הזהות המאוחדת?

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

        gcloud auth application-default login

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

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

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

    REST

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

      מתקינים את ה-CLI של Google Cloud ואז נכנסים ל-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 list כדי להציג את רשימת הדוחות בפרויקט.

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

    מחליפים את PROJECT_ID במזהה של Google Cloud הפרויקט שכולל את משאבי הדוחות שרוצים להציג ברשימה.

    הפקודה gcloud מטפלת אוטומטית בהחלפה בין דפים, ומחזירה את כל המשאבים המבוקשים.

    Python

    קוד ה-Python הבא משתמש ב-AppOptimizeClient.list_reports() כדי להציג רשימה של דוחות בפרויקט.

    from google.cloud import appoptimize_v1beta

project_id = "PROJECT_ID"

# Create the App Optimize client and request the project's reports
client = appoptimize_v1beta.AppOptimizeClient()
request = appoptimize_v1beta.ListReportsRequest(
    parent=f"projects/{project_id}/locations/global"
)
page_result = client.list_reports(request=request)

# Iterate over the list of reports and display each one
for response in page_result:
    print(response)

    מחליפים את PROJECT_ID במזהה של Google Cloud הפרויקט שכולל את משאבי הדוחות שרוצים להציג ברשימה.

    ספריית הלקוח מטפלת בחלוקה לדפים באופן אוטומטי, ומחזירה תוצאות מהאיטרטור.

    REST

    כדי להציג את רשימת הדוחות של פרויקט, משתמשים בפקודה curl הבאה:

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

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

    • ‫PROJECT_ID: המזהה של Google Cloud הפרויקט שמכיל את משאבי הדוחות שרוצים להציג.
    • ‫PAGE_SIZE: המספר המקסימלי של הדוחות שיוחזרו בכל דף. אם לא מציינים ערך, ממשק ה-API משתמש בערך ברירת מחדל. יכול להיות שהשרת יחזיר פחות דוחות ממה שביקשתם.

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

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

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

    אם התשובה כוללת מחרוזת nextPageToken, זה אומר שיש עוד דוחות לאחזור.

    בודקים את התשובה לשדה nextPageToken. אם הטוקן קיים, מריצים את הפקודה הבאה curl כדי לאחזר את הדף הבא, כולל פרמטר השאילתה pageToken. אפשר להמשיך להשתמש בפרמטר pageSize.

    curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://appoptimize.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/reports?pageToken=NEXT_PAGE_TOKEN&pageSize=PAGE_SIZE"

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

    • ‫NEXT_PAGE_TOKEN: הערך של nextPageToken שהתקבל בתגובה הקודמת.
    • ‫PAGE_SIZE: גודל הדף שרוצים להגדיר לבקשה הזו.

    חוזרים על התהליך עד שהתגובה לא מכילה יותר nextPageToken, שמציין שכל הדוחות אוחזרו.

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