פתרון בעיות בהגדרת ADC

כאן מתוארות חלק מהבעיות הנפוצות שאתם עשויים להיתקל בהן במהלך השימוש ב-Application Default Credentials.

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

פרטי הכניסה של המשתמש לא תקינים

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

יש שני סוגים של ממשקי API של Google Cloud :

  • ממשקי API שמבוססים על משאבים: הממשקים האלה משתמשים בפרויקט שמשויך למשאבים שאליהם מתבצעת הגישה, לצורכי חיוב ומכסה.

  • ממשקי API שמבוססים על לקוחות: הממשקים האלה משתמשים בפרויקט שמשויך ללקוח שבאמצעותו מתבצעת הגישה למשאבים, לצורכי חיוב ומכסה.

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

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

  • לעדכן את קובץ ה-ADC כדי להשתמש בפרויקט אחר לצורכי המכסות:

    gcloud auth application-default set-quota-project YOUR_PROJECT
    
  • אם אתם משתמשים ב-CLI של gcloud כדי לשלוח קריאה ל-API, אתם יכולים להגדיר את הפרויקט לחיוב מכסות בהגדרות של ה-CLI של gcloud:

    gcloud config set billing/quota_project YOUR_PROJECT
    
  • כשקוראים ישירות ל-API ל-REST או ל-RPC, תוכלו להשתמש בכותרת ה-HTTP x-goog-user-project בכל בקשה כדי לציין את הפרויקט לחיוב. לפרטים נוספים תוכלו לקרוא את המאמר הגדרה של פרויקט לצורכי מכסה בבקשת REST.

כדי להשתמש בפרויקט לחיוב צריך ב-IAM את ההרשאה serviceusage.services.use. ההרשאה serviceusage.services.use כלולה בתפקיד Service Usage Consumer ב-IAM. אם אין לכם את ההרשאה serviceusage.services.use לאף פרויקט, צרו קשר עם אדמין האבטחה או עם Project Owner שיוכל להקצות לכם את התפקיד Service Usage Consumer בפרויקט.

סקירה כללית על פרויקטים לצורך חיוב במכסות במאמר הגדרת הפרויקט לצורכי מכסה מוסבר איך מגדירים את הפרויקט לצורכי מכסה בדרכים נוספות.

פרטי כניסה שגויים

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

  • אם אתם משתמשים ב- Google Cloud באמצעות ה-CLI של gcloud בסביבה מקומית, ודאו שאתם מבינים באילו פרטי כניסה אתם משתמשים. כשמשתמשים ב-CLI של gcloud, צריך להשתמש בפרטי הכניסה שסיפקתם ל-CLI של gcloud באמצעות הפקודה gcloud auth login. אתם לא אמורים להשתמש בפרטי הכניסה שסיפקתם ל-ADC. מידע נוסף על שתי קבוצות פרטי הכניסה האלה זמין במאמר הגדרת אימות ב-CLI של gcloud והגדרת ADC.

  • רק אם משתמשים במפתחות של חשבונות שירות או בקובץ JSON אחר ל-ADC, חשוב לוודא שמשתנה הסביבה GOOGLE_APPLICATION_CREDENTIALS מוגדר. פרטי הכניסה שמוגדרים במשתנה הסביבה מקבלים עדיפות על פני פרטי כניסה אחרים, כולל איחוד זהויות של עומסי עבודה ל-GKE.

  • מוודאים שחשבון המשתמש שמעביר את הבקשה כולל את התפקידים הנדרשים ב-IAM. אם משתמשים בפרטי כניסה של משתמש, צריך להקצות את התפקידים לכתובת האימייל שמשויכת לחשבון המשתמש. אם משתמשים בחשבון שירות, צריך להקצות את התפקידים הנדרשים לחשבון השירות.

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

אין מספיק היקפי הרשאות לאימות

אם בקשת ה-API מחזירה את הערך Request had insufficient authentication scopes עם הסיבה ACCESS_TOKEN_SCOPE_INSUFFICIENT, טוקן הגישה לא כולל היקף שה-API דורש. הקצאת תפקידי IAM לא פותרת את השגיאה הזו.

כדי לפתור את השגיאה:

  1. מזהים את ה-API מהשדות service ו-method בפרטי השגיאה.

  2. מוצאים את ההיקף שה-API דורש במאמרי העזרה של ה-API או במאמר היקפי OAuth 2.0 ל-Google APIs. רוב ממשקי ה-API של Google Cloud מקבלים את ההיקף https://www.googleapis.com/auth/cloud-platform. לממשקי API של Google Workspace נדרשים היקפי הרשאות משלהם.

  3. בודקים אילו היקפי הרשאות יש לאסימון. בסביבה שבה מתרחשת השגיאה, מריצים את הפקודה הבאה ובודקים את השדה scope:

    curl "https://oauth2.googleapis.com/tokeninfo?access_token=$(gcloud auth application-default print-access-token)"
  4. מוסיפים את ההיקף החסר במקום שבו פרטי הכניסה מקבלים את ההיקפים שלהם:

הסוג של פרטי הכניסה לא מזוהה

אם לבקשת ה-API מוחזרת הודעת שגיאה שכוללת את הטקסט Error creating credential from JSON. Unrecognized credential type, צריך לוודא שאתם משתמשים בפרטי כניסה תקינים. אי אפשר להעביר את פרטי הכניסה ל-ADC באמצעות קובצי Client-ID.

השגיאה שמוחזרת לפרטי כניסה מקומיים מהתחזות לחשבון שירות

לא כל ספריות האימות תומכות בפרטי כניסה מקובץ ADC מקומי שנוצר באמצעות התחזות לחשבון שירות. אם הקריאה מחזירה שגיאה שדומה ל-Neither metadata server or valid service account credentials are found, אי אפשר להשתמש בפרטי כניסה מקומיים של התחזות למשימה הזו.

כדי למנוע את השגיאה הזו, צרו את קובץ ה-ADC מפרטי הכניסה של המשתמש או הריצו את הקוד בסביבה שיש בה שרת מטא-נתונים זמין (כמו Compute Engine).

הפרויקט הלא ידוע 764086051850 שימש לבקשה

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

מידע נוסף זמין במאמר פרטי הכניסה של משתמש לא תקינים.

הגישה נחסמת כשמשתמשים בהיקפי הרשאות

אם אתם מנסים ליצור קובץ ADC מקומי ומוחזרת שגיאה כמו This app is blocked או Access blocked: Authorization Error, יכול להיות שאתם מנסים להשתמש בהיקפים שלא נתמכים על ידי פקודת ברירת המחדל להגדרת ADC. בדרך כלל הבעיה הזו נגרמת כשמוסיפים היקפי הרשאות לאפליקציות מחוץ ל- Google Cloud, כמו Google Drive.

כברירת מחדל, טוקני הגישה שנוצרים מקובץ ADC מקומי שנוצר עם פרטי הכניסה של המשתמש כוללים את ההיקף https://www.googleapis.com/auth/cloud-platform ברמת הענן. כדי לציין היקפים באופן מפורש, משתמשים בדגל --scopes עם הפקודה gcloud auth application-default login.

כדי להוסיף היקפי הרשאות לשירותים מחוץ ל- Google Cloud, כמו Google Drive, אפשר לבצע אחת מהפעולות הבאות: