‫Google משתמשת בטכנולוגיית AI כדי לתרגם תוכן לשפה המועדפת עליך. בתרגומים כאלו עשויות להיות שגיאות.

הצגת דומיינים ברשימת ההיתרים

בדף הזה מופיעים דוגמאות לקוד ופרטים תפעוליים שמדגימים איך להציג ולאחזר דומיינים ספציפיים ברשימת ההיתרים באמצעות Allowlisted Domains API.

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

לפני שממשיכים עם המידע בדף הזה, צריך לבצע את המשימות הבאות:

לקרוא את המאמר סקירה כללית של Allowlisted Domains API.
מגדירים את API של דומיינים ברשימת ההיתרים.

הוספת דומיינים לרשימת ההיתרים

משתמשים ב-list method כדי לאחזר את כל הרשומות. אפשר גם לציין pageSize, pageToken או מחרוזת filter כדי לצמצם את התוצאות.

Python

def list_allowlisted_domains(
    service, page_size=None, page_token=None, domain_filter=None
):
  """Lists allowlisted domains."""
  try:
    filter_string = None
    if domain_filter:
      filter_string = f"domain = '{domain_filter}'"

    response = (
        service.allowlistedDomains()
        .list(
            pageSize=page_size, pageToken=page_token, filter=filter_string
        )
        .execute()
    )
    return response
  except Exception as e:
    print(f'An error occurred during list: {e}')
    return None

קבלת דומיין ספציפי

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

Python

def get_allowlisted_domain(service, resource_name):
  """Gets an allowlisted domain."""
  if not resource_name:
    print('Resource name is missing.')
    return None

  try:
    response = service.allowlistedDomains().get(name=resource_name).execute()
    return response
  except Exception as e:
    print(f'An error occurred during get: {e}')
    return None

טיפול בשגיאות

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

טיפול בשגיאות ברשימה

תנאי שגיאה	קוד הסטטוס של RPC	הודעת השגיאה	פתרון בעיות / נימוק
אין הרשאה למשאב	`PERMISSION_DENIED (403)`	`"Permission denied for allowlisted domain resource."`	• מוודאים שהמשתמש קיבל את ההיקף המתאים. • מוודאים שלמשתמש יש את ההרשאה הנדרשת. • כדאי לפנות לכתובת האימייל של איש הקשר כדי לוודא שהפרויקט או המשתמש נכללים ברשימת ההיתרים.
לא נמצא מספר לקוח עבור המשתמש	`NOT_FOUND (404)`	`"Customer ID not found for user."`	המשתמש שמחובר כרגע למערכת לא מקושר לדומיין תקין.
הרשימה השתנתה במהלך חלוקה לעמודים	`ABORTED`	`"List has been mutated. Please restart pagination."`	הרשימה הבסיסית של הדומיינים שונתה בזמן שביצעתם חלוקה לדפים. עליכם להפעיל מחדש את הפעולה `allowlistedDomains.list` מהדף הראשון. אם יש מוטציות מקבילות שמתבצעות, כדאי לאחזר את הרשימה המלאה בבת אחת.
צוין ערך לא תקין של מסנן דומיין	`INVALID_ARGUMENT (400)`	`"Invalid domain filter value provided. Error: <Error message>."`	צריך לבדוק את הדומיין שצוין בפרמטר הסינון של בקשת הרשימה כדי לוודא שהוא לא ריק או לא תקין מבחינת התחביר. מקרים שבהם צוינו פרמטרים לא תקינים של סינון: הפעולה `allowlistedDomains.list` נכשלה בגלל תחביר לא תקין או פעולה לא נתמכת שהועברה במסנן. בהודעת השגיאה יוסבר תרחיש השימוש המדויק. חשוב להקפיד להשתמש בפורמט הבא כדי לשלוח קריאה ל-API: `GET https://cloudidentity.googleapis.com/v1/allowlistedDomains?filter="domain = 'google.com'"`
ביטוי סינון לא תקין	`INVALID_ARGUMENT (400)`	`"Invalid filter expression: %s."`	ביטוי הסינון שהועבר בבקשה שגוי.
תנאים מורכבים לא אפשריים	`INVALID_ARGUMENT (400)`	`"Composite conditions (AND, OR, NOT) are not supported in the filter."`	המסנן לא תומך בתנאים מורכבים, מותר להשתמש רק בסינון לפי תנאי יחיד.
יש תמיכה רק באופרטור '='	`INVALID_ARGUMENT (400)`	`"Only '=' operator is supported in the filter."`	משתמשים באופרטור השוויון (`=`) לכל ביטויי המסננים. אין תמיכה בפעולות אחרות.
יש תמיכה רק בשדה 'דומיין'	`INVALID_ARGUMENT (400)`	`"Only 'domain' field is supported in the filter."`	המסנן צריך לטרגט את שדה הדומיין (לדוגמה, `domain = 'example.com'`). אין תמיכה בשדות אחרים.
הערך של החבר בצד שמאל לא תקין או שהוא צריך להיות מחרוזת	`INVALID_ARGUMENT (400)`	`"RHS of filter expression has invalid member value."` `"RHS of filter expression should be a string."`	הערך בצד שמאל של ביטוי המסנן חייב להיות מחרוזת (שם הדומיין).
גודל הדף הוא שלילי	`INVALID_ARGUMENT (400)`	`"Page size cannot be negative."`	חשוב לוודא שהפרמטר `pageSize` הוא מספר שלם לא שלילי.
טוקן דף לא חוקי	`INVALID_ARGUMENT (400)`	`"Invalid page token."`	השגיאה מציינת שהטוקן לא תקין או שתוקפו פג. חשוב לוודא שאתם משתמשים בטוקן המדויק והלא משונה שמופיע בשדה `nextPageToken` בתשובה הקודמת של רשימת המשתמשים. אם האימות נכשל, משמיטים את הפרמטר `pageToken` כדי להפעיל מחדש את המספור מהדף הראשון.

קבלת טיפול בשגיאות

תנאי שגיאה	קוד הסטטוס של RPC	הודעת השגיאה	פתרון בעיות / נימוק
אין הרשאה למשאב	`PERMISSION_DENIED (403)`	`"Permission denied for allowlisted domain resource."`	• מוודאים שהמשתמש קיבל את ההיקף המתאים. • מוודאים שלמשתמש יש את ההרשאה הנדרשת. • כדאי לפנות לכתובת האימייל של איש הקשר כדי לוודא שהפרויקט או המשתמש נכללים ברשימת ההיתרים.
לא נמצא מספר לקוח עבור המשתמש	`NOT_FOUND (404)`	`"Customer ID not found for user."`	המשתמש שמחובר כרגע למערכת לא מקושר לדומיין תקין.
הדומיין לא נמצא ברשימת ההיתרים	`NOT_FOUND (404)`	`"Allowlisted domain <domain> not found"`	הדומיין שצוין לא נמצא ברשימת ההיתרים.
שם המשאב לא תקין	`INVALID_ARGUMENT (400)`	`"Invalid resource name: <resourceName>."`	אימות הפורמט של שם המשאב: המחרוזת שמשמשת לפרמטר השם חייבת להיות בדיוק בפורמט `allowlistedDomains/UNIQUE_IDENTIFIER`.