משימה של קריאה לנקודת קצה של REST

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

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

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

    אם בשילוב שלכם מוגדרים גם פרופיל OAuth 2.0 וגם חשבון שירות בניהול המשתמש, כברירת מחדל נעשה שימוש בפרופיל OAuth 2.0 לאימות. אם לא מוגדר פרופיל OAuth 2.0 ולא מוגדר חשבון שירות שמנוהל על ידי המשתמש, הביצוע ייכשל.

  • אם לשילוב שלכם מצורף חשבון שירות, צריך להקצות לחשבון השירות הזה את תפקיד ה-IAM הנדרש, על סמך כתובת ה-URL של נקודת הקצה של REST. לדוגמה, אם כתובת ה-URL של נקודת הקצה של REST קוראת לשירות Cloud Storage, צריך להעניק את תפקיד ה-IAM הנדרש לשירות Cloud Storage.

    במאמר ניהול הגישה לחשבונות שירות מוסבר איך נותנים לחשבון שירות תפקיד.

  • מוודאים שVPC Service Controls לא מוגדר עבור Application Integration בפרויקט Google Cloud .

הגדרת המשימה Call REST Endpoint

כדי להגדיר את המשימה Call REST Endpoint:

  1. נכנסים לדף Application Integration במסוף Google Cloud .

    מעבר אל Application Integration

  2. בתפריט הניווט, לוחצים על Integrations (שילובים).

    מוצג הדף Integrations (שילובים) עם רשימה של כל השילובים שזמינים בפרויקט בענן של Google.

  3. בוחרים שילוב קיים או לוחצים על יצירת שילוב כדי ליצור שילוב חדש.

    אם יוצרים שילוב חדש:

    1. מזינים שם ותיאור בחלונית יצירת שילוב.
    2. בוחרים אזור לשילוב.
    3. בוחרים חשבון שירות לאינטגרציה. אפשר לשנות או לעדכן את פרטי חשבון השירות של שילוב בכל שלב מחלונית סיכום השילוב בסרגל הכלים של השילוב.
    4. לוחצים על יצירה. השילוב החדש שנוצר ייפתח בכלי השילובים.

  4. בסרגל הניווט של כלי העריכה של השילוב, לוחצים על משימות כדי לראות את רשימת המשימות והמחברים הזמינים.
  5. לוחצים על הרכיב Call REST Endpoint (התקשרות לנקודת קצה של REST) וגוררים אותו אל עורך השילובים.
  6. לוחצים על הרכיב Call REST Endpoint בכלי העיצוב כדי להציג את חלונית ההגדרות של המשימה Call REST Endpoint.
  7. מגדירים את השדות שיוצגו באמצעות מאפייני ההגדרה של המשימה, כמו שמפורט בטבלה שבהמשך.

    השינויים במאפיינים נשמרים אוטומטית.

מאפייני ההגדרה

בטבלה הבאה מתוארים מאפייני התצורה של המשימה Call REST Endpoint.

נכס סוג הנתונים תיאור
תווית String אופציונלי: מוסיפים תווית למשימה.
אימות String אופציונלי: הגדרה ואחסון של פרטי האימות לחיבורים למערכות חיצוניות. מידע נוסף זמין במאמר יצירת פרופילי אימות ב-Application Integration.
כתובת ה-URL הבסיסית של נקודת הקצה String כתובת URL של נקודת קצה מסוג REST בלי הפרמטרים של השאילתה.
שיטת HTTP לא זמין שיטת ה-HTTP שבה רוצים להשתמש.

אפשר לבחור כל אחת משיטות ה-HTTP הבאות:

  • מחיקה
  • GET
  • התקדם אל
  • PATCH
  • POST
  • PUT
פרמטרים של מחרוזת שאילתה בכתובת URL מפתח מחרוזת השאילתה : מחרוזת

ערך: מחרוזת

פרמטרים של שאילתה שנדרשים לקריאה ל-API בארכיטקטורת REST.

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

כותרות HTTP מפתח כותרת HTTP: ‏ מחרוזת

ערך: מחרוזת

כותרות HTTP שנדרשות לקריאה ל-API בארכיטקטורת REST.

כותרות ה-HTTP הן בצורה של צמדי מפתח/ערך, כאשר המפתח הוא שם המפתח והערך הוא הערך התואם של המפתח. כדי להזין יותר מצמד מפתח/ערך אחד, לוחצים על סמל הפלוס.

מעקב אחר הפניות אוטומטיות בוליאני מעקב אחרי הפניות לכתובות URL אחרות.

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

  • True : המערכת קוראת לכתובת ה-URL שאליה מתבצעת ההפניה אם כתובת ה-URL הבסיסית של נקודת הקצה מועברת לכתובת URL אחרת.
  • False: לא מתבצעת קריאה לכתובת ה-URL שההפניה אליה מתבצעת אם כתובת ה-URL הבסיסית של נקודת הקצה מועברת לכתובת URL אחרת.
המשימה צריכה להיכשל בשגיאת HTTP בוליאני אסטרטגיה לטיפול בחריגים כשקריאה ל-API בארכיטקטורת REST נכשלת. הפעולה Call REST Endpoint נכשלת אם קוד תגובת HTTP הוא 4xx או 5xx. רשימה של קודי שגיאה מופיעה במאמר קודי שגיאה. במקרה של קודי תגובה אחרים של HTTP, מחזירים קוד שגיאה והודעת שגיאה בתגובה.

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

  • ‫True : מוצגת חריגה.
  • ‫False: לא נזרק חריג. אבל מחזירה את קוד השגיאה ואת הודעת השגיאה בתגובה.
כותרת תגובה (<שם המשימה>) String כותרת תגובה לא דחוסה מהתגובה של ממשקי ה-API ל-REST.
גוף התגובה (<שם המשימה>) String גוף התגובה הלא דחוס מהתגובה של ממשקי ה-API ל-REST.
סטטוס התגובה (<שם המשימה>) String קוד תגובת ה-HTTP והטקסט של הקוד התואם מהתגובה של ממשקי ה-API ל-REST.

שיטות מומלצות

מידע על מכסות השימוש שחלות על המשימה Call REST Endpoint זמין במאמר מכסות שימוש.

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

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

בבלוג How to retry Rest Caller Task based on Response Status (איך לנסות שוב את המשימה Rest Caller בהתאם לסטטוס התגובה) מוסבר איך לטפל באסטרטגיות של ניסיון חוזר לשגיאות 4xx או 5xx.

מכסות ומגבלות

מידע על מכסות ומגבלות זמין במאמר מכסות ומגבלות.

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