/v1 מחזירה את אותה מעטפת ומבצעת עימוד
באותו אופן: מבוסס אסימון, קדימה בלבד.
מעטפת הרשימה
string
תמיד
"list".array
עמוד המשאבים, בסדר יציב ודטרמיניסטי.
string | null
יש להעביר ערך זה בתור
page_token בבקשה הבאה כדי לאחזר את העמוד הבא.
null כאשר אין עוד תוצאות.boolean
האם קיימות תוצאות נוספות מעבר לעמוד זה.
פרמטרים של הבקשה
integer
ברירת מחדל:"25"
גודל העמוד. מספר שלם בין 1 ל-500. ערכים מחוץ לטווח זה גורמים להחזרת
400 עם הקוד invalid_request.string
הערך
next_page_token מהתגובה הקודמת. יש להשמיט אותו בעמוד הראשון.חריגה:
GET /v1/cohorts/{id}/members מחזיר לכל היותר 50 שורות בכל
עמוד, גם אם מבקשים limit גבוה יותר. has_more ו-
next_page_token ממשיכים לשקף את יתרת הקבוצה האמיתית.apikey:secret או secret:).
יש להגדיר את BASE למארח האזורי של הארגון — ראו
Regions.
סריקת רשימה
יש לטעון אתLIVING_SECURITY_API_KEY ממנהל הסודות שלכם, כפי שמוצג ב-quickstart.
דוגמה זו דורשת entity:read; ייתכן שהמפתח ששימש במדריך הבקשה הראשונה
יזדקק להענקה נוספת זו. יש להתקין את requests עבור Python או jq עבור
דוגמת ה-shell. בשתי הדוגמאות מצוינת גרסה מקובעת, המסננים נשארים ללא שינוי, וניתובים מחדש נדחים.
הן נעצרות בשגיאות ולאחר 1,000 עמודים, ואינן מדווחות על סריקה
חלקית כעל סריקה שהושלמה. זמן הקריאה (read timeout) ב-Python מגביל חוסר פעילות, ולא את
משך העבודה הכולל; יש להגדיר מועד סיום לעבודה באינטגרציה שלכם.
יש לבקש עמודים עד ש-next_page_token הוא null. מומלץ להעדיף limit=500 בקריאות
בכמות גדולה, כדי לכסות את האוסף בפחות בקשות — ראו
מגבלות קצב.
שמירה על מסננים יציבים במהלך העימוד
אסימוני עמוד הם מצביעים אטומים וחתומים. כל אסימון קשור לארגון, לחשבון השירות המאומת, לגרסת החוזה ולקבוצת המסננים המדויקת של הבקשה שיצרה אותו. שינוי של כל אחד מאלה באמצע הסריקה — לדוגמה, הוספת מסנןtype בעמוד השני — מחזיר 400 עם הקוד
invalid_request על הפרמטר page_token:
400 Invalid request
נקודות קצה של רשימות דוחות פרמטרי שאילתה שאינם נתמכים באמצעות
400
invalid_request שמציין את שם הפרמטר. יש לעיין במסמך העזר של כל נקודת קצה כדי לראות אילו
מסננים נתמכים בה.טיפול באוסף שנקטע או משתנה
דוגמאות אלה אינן מנסות שוב באופן אוטומטי לאחר שגיאות. עבור429, יש לכבד את Retry-After
ולפעול לפי הנחיות הניסיון החוזר המוגבלות. בעת ניסיון חוזר של קריאה, יש לשמור על אותו
אזור, אותו חשבון שירות, אותה גרסה, אותם מסננים ואותו אסימון עמוד
שעובד בהצלחה לאחרונה. החלפת אישורים אינה מעניקה גישה:
כל בקשה עדיין בודקת את ההרשאות הנוכחיות.
קריאה מרובת עמודים אינה תמונת מצב של האוסף. שורות עשויות להשתנות בזמן
שאתם עוברים עליו. יש לעבד משאבים לפי id היציב שלהם ולהפוך כתיבות במורד הזרם
לאידמפוטנטיות; הפעלה מחדש עשויה להחזיר שורה שוב. אם אסימון נדחה,
יש לבדוק את שגיאת page_token ולתקן את הבקשה לפני שמתחילים מחדש
מהעמוד הראשון. אין להשליך בשקט נתונים שכבר עובדו ואין לסמן
ייצוא שנקטע כהושלם. לקבלת סכומים מדויקים לצורכי דיווח, יש להשתמש במשאב הדיווח המתאים
ולא להתייחס לסריקת רשימה חיה כאל תמונת מצב.
