מילון מונחים

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

המושגים הבאים הם רעיונות נפוצים שיש להם משמעות ייחודית ב-Apigee.

A

נתיב בסיס ומשאבים של API
‫
API מורכב מנתיב בסיס ומקבוצה של משאבים (שנקראים גם נתיבי משאבים). לכל API מגדירים כתובת URL אחת של שורש (שנקראת גם נתיב בסיס) וכמה נתיבי משאבים. אפשר לחשוב על API כפשוטו כאוסף של כתובות URI, שלכולן יש נתיב בסיס משותף. כדי להקל על ניהול ממשקי ה-API, ‏ Apigee מוסיף לכתובות ה-URI הגולמיות האלה שמות ותיאורים לתצוגה.
צרכן API
מונח שמשמעותו זהה למפתח אפליקציות, שמשתמש בממשקי ה-API שנוצרו על ידי ספק API.
מפתח API
מהנדס/ת תוכנה בארגון ספק API שיוצר/ת ממשקי API. מפתחי אפליקציות (צרכני API) משתמשים בממשקי ה-API האלה כדי לפתח אפליקציות.
מוצר API
אוסף של משאבי API (מזהי URI) בשילוב עם תוכנית שירות, שמוצגים למפתחים כחבילה. מוצר ה-API יכול לכלול גם מטא-נתונים ספציפיים לעסק שלכם לצורך מעקב או ניתוח. אפשר לייצר הכנסות ממשאב אחד או יותר על ידי הכללתם במוצר API, שאותו אפשר לארוז בחבילת API לצורך מונטיזציה.
ספק API
ספק API יוצר ממשקי API (באמצעות Apigee) לשימוש של צרכני API (מפתחי אפליקציות).
proxy ל-API
פרוקסי שפועל כחזית לממשק ה-API הקיים. במקום לקרוא ל-API הקיים, המפתחים מתחילים לקרוא ל-API החדש שנוצר על ידי Apigee. ה-Facade הזה מפריד את הממשק הציבורי שלכם מממשק ה-API של הקצה העורפי, ומגן על המפתחים מפני שינויים בקצה העורפי. בנוסף, הוא מאפשר לכם לחדש בקצה בלי להשפיע על צוותי הפיתוח הפנימיים. בזמן שאתם מבצעים שינויים בבק-אנד, המפתחים ממשיכים לקרוא לאותו API ללא הפרעה. בתרחישים מתקדמים יותר, Apigee מאפשר לחשוף כמה ממשקים לאותו API, וכך להתאים אישית את החתימה של API כדי לענות על הצרכים של נישות שונות של מפתחים בו-זמנית.
ממשקי API של Apigee
נקודות הקצה שבהן אפשר להשתמש כדי להגדיר סביבות, ארגונים, proxy ל-API ושירותים היברידיים אחרים.
מפַתח אפליקציות
מפתחי אפליקציות רושמים את האפליקציות שלהם אצל ספק API, וכך הם מקבלים את מפתחות ה-API שהם צריכים כדי לשלוח קריאות לשרתי ה-proxy של ספק ה-API.
אפליקציות
המפתחים שלכם משתמשים באפליקציות כדי לגשת למשאבים במוצרי ה-API שלכם. כשיוצרים אפליקציה, בוחרים את מוצר ה-API שרוצים לכלול, ומערכת Apigee יוצרת מפתח. לכל אפליקציה יש מפתח יחיד שמאפשר גישה לכמה מוצרי API. האפליקציות מאפשרות לכם לקבוע למי תהיה גישה למשאבים שלכם. אתם יכולים לקבוע למי תהיה גישה למוצרי ה-API שלכם על ידי ביטול ורענון של המפתח של האפליקציה. אפשר גם לשלוט בגישה לחבילות של משאבים על ידי ביטול או מחיקה של הגישה למוצרים באפליקציה.

B

פרטי יתרה
למפתח עם חשבון בתשלום מראש, היתרה בחשבון המפתח.

C

Cassandra

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

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

מידע נוסף זמין במאמר בנושא מידע על מישור זמן הריצה.

תשתית ניהול מרכזית (או מישור)
ראו מישור הניהול.
קובץ אימג' של קונטיינר
פרטים בתמונה.
מישור הבקרה
ראו מישור הניהול.

D

deploy

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

מפתח
מפתח מתייחס לתפקיד שמשתמש Apigee יכול לבצע. יש שני סוגים של מפתחים ב-Apigee:
  • מפתחים של שרתי proxy ל-API – יוצרים את שרתי ה-proxy ל-API ומחילים מדיניות.
  • מפתחי אפליקציות – יוצרים אפליקציות שצורכות שרתי proxy ל-API.
תוכנית תמחור לפי קטגוריית מפתחים
תוכנית תמחור שחלה על כל המפתחים בקטגוריה מסוימת וזמינה לרכישה על ידי כל המפתחים בקטגוריה הזו.
תוכנית תעריפים למפתחים
תוכנית תמחור שחלה על מפתח ספציפי וזמינה לרכישה רק על ידי אותו מפתח.

E

סביבה

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

קבוצת סביבות

קבוצת סביבות היא קבוצה של סביבות Apigee עם שם מארח אחד או יותר. שם המארח הוא חלק מכתובת ה-URL שמשמשת להפעלת שרתי proxy של API שנפרסו בכל סביבה בקבוצת הסביבות.

מגבלה מפורשת
מידע נוסף על הגבלה בהתאמה אישית

G

GCR
מאגר קונטיינרים של Google.
GKE
‫
Google Kubernetes Engine. סביבה מנוהלת על ידי Google שמוכנה לייצור, לפריסת אפליקציות בקונטיינרים ב-Kubernetes. ‫GKE מאפשר לכם להתחיל לעבוד עם Kubernetes במהירות, כי הוא מבטל לחלוטין את הצורך להתקין, לנהל ולהפעיל אשכולות Kubernetes משלכם.

I

מאגר תמונות
קבוצה של תמונות מאגרי משותפות.
מגבלה משתמעת
מגבלה (כמו מגבלת היתרה מההפקדה למפתחים) שהוגדרה על ידי המונטיזציה.
תעבורת נתונים נכנסת (Ingress) / בקר תעבורת נתונים נכנסת (Ingress)
אפליקציה מבוססת-קונטיינר שמנתבת תנועה מחוץ לאשכול לשירותים בתוך האשכול.

K

KMS
Key Management Service. מאחסן ומציג מפתחות וטוקנים של OAuth להצפנה ולפענוח של תעבורה. ‫Apigee KMS מנהל מפתחות לאפליקציות, למפתחים ולמוצרי API.
KVM
מפת ערכי מפתח. אוסף מותאם אישית של צמדי מחרוזות מפתח/ערך מוצפנים או לא מוצפנים. מידע נוסף מופיע במאמר שימוש במיפוי ערכי מפתח.
מכונת ניהול של Kubernetes
המחשב המקומי שמשמש להרצת פקודות באשכול Kubernetes. המכונה הזו היא בדרך כלל מכונת מחשב שולחני שיש לה גישה למכונות הווירטואליות של Kubernetes.

M

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

‫API לנתוני זמן ריצה מתקשר עם מאגר הנתונים של זמן הריצה המקומי (Cassandra). הוא משמש כספק API של Apigee API ציבורי כדי לגשת לנתוני זמן ריצה ולנהל אותם.

‫MART היא אפליקציה חסרת מצב, בדיוק כמו מעבדי הודעות. זו אפליקציה בקונטיינר של Kubernetes.

מידע נוסף זמין במאמר בנושא מידע על מישור זמן הריצה.

צומת ראשי
מונח ב-Kubernetes לתיאור צומת שכולל את apiserver,‏ cloud-controller-manager ‏ (CCM),‏ scheduler ו-kube-controller-manager.
מעבד בקשות

(Apigee hybrid בלבד) מעבד ההודעות מעריך בקשה נכנסת, מפעיל מדיניות של Apigee וקורא למערכות העורפיות ולמערכות אחרות כדי לאחזר נתונים. אחרי שהתשובות האלה מתקבלות, מעבד ההודעות מעצב תשובה ומחזיר אותה ללקוח.

ה-MP הוא פריסה של Kubernetes. הוא מוגדר לסביבת Apigee אחת, ומצביע על ספריית משנה בהיקף מוגבל במערכת הקבצים המשותפת שאליה המרכז מספק נתונים.

ה-MP הוא תהליך שדורש הרבה משאבים, ולכן הוא צריך להיות בצומת עובד נפרד מ-Cassandra.

מידע נוסף זמין במאמר בנושא מידע על מישור זמן הריצה.

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

N

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

O

פתיחת התאמה
התאמה שעדיין לא שויכה במסמכי חיוב שפורסמו.
חודש חיוב פתוח
חודש קלנדרי מלא שבו לא פורסמו מסמכי חיוב סופיים.
קוד פתוח של Kubernetes
הטמעה לדוגמה של Kubernetes. מידע על Kubernetes זמן הריצה של Apigee Hybrid פועל ב-Kubernetes בקוד פתוח ובגרסאות מבוססות קוד פתוח של Kubernetes שתואמות ל-CNCF.
ארגון

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

כדי להתקין את Apigee או את Apigee Hybrid ולהשתמש בהם, צריך שיהיה לכם ארגון Apigee שמקושר לפרויקט ב-Google Cloud. הפעולה הזו מתבצעת כשיוצרים את הארגון בתהליך שנקרא הקצאת הרשאות.

ארגון Apigee לא זהה לארגון ב-Google Cloud. אם יש אפשרות לפרשנות כפולה, במסמך צריך לציין שהארגון הוא ארגון Apigee.

מידע נוסף זמין במאמר סוגי ארגונים.

P

pod
פוד הוא אבן הבניין הבסיסית של Kubernetes: היחידה הקטנה והפשוטה ביותר במודל האובייקטים של Kubernetes שיוצרים או פורסים. ‫A pod represents a running process on your cluster.
היתרה מהפקדה
סכום כסף שזמין למפתח שמשלם מראש כדי לשלם מראש על חבילות API.
מפתחים שמשלמים מראש
מפתח שמשלם מראש על השימוש במוצר API. הכספים מנוכים מהיתרה של מפתח שמשתמש במינוי בתשלום מראש כשנעשה שימוש במוצר ה-API. המפתח חייב לשמור על היתרה מההפקדה שתספיק לרכישת מוצר ה-API. ספק ה-API מקצה למפתחים סטטוס של תשלום מראש או תשלום לאחר השימוש.
מדיניות
שלב עיבוד שמופעל כיחידת לוגיקה אטומית וניתנת לשימוש חוזר בתהליך של API. מדיניות טיפוסית כוללת העברת בקשות לנקודת הקצה המתאימה, שינוי פורמט של הודעה, אכיפת בקרת גישה, קריאה לשירותים מרוחקים כדי לקבל מידע נוסף, הסתרת מידע אישי רגיש ממשתמשים חיצוניים, בדיקת תוכן ההודעה לאיתור איומים פוטנציאליים, שמירת תגובות נפוצות במטמון כדי לשפר את הביצועים וכו'. יכול להיות שהמדיניות תופעל באופן מותנה על סמך התוכן או ההקשר של הודעת בקשה או תגובה. לדוגמה, יכול להיות שמדיניות טרנספורמציה תופעל כדי להתאים אישית את פורמט התגובה אם הודעת הבקשה נשלחה מסמארטפון.
מפתח בתשלום מאוחר
מפתח שמקבל חיוב חודשי על השימוש במוצרי API. ‫ המפתח משלם על השימוש במוצרי API בהתאם לתנאי התשלום שמוגדרים בתוכניות התמחור. ספק ה-API מקצה למפתחים סטטוס של תשלום לאחר השימוש או תשלום מראש.
שרת proxy
נקרא גם proxy ל-API. proxy ל-API הוא שכבת הפשטה שמשמשת כחזית לממשקי ה-API של השירותים לקצה העורפי, ומספקת תכונות עם ערך מוסף כמו אבטחה, הגבלת קצב של יצירת בקשות, מכסות, ניתוח נתונים ועוד.
נקודת קצה של שרת proxy
נקודת קצה (endpoint) של proxy מגדירה את אופן האינטראקציה של שרת ה-proxy ל-API עם אפליקציות לקוח. מגדירים את נקודת הקצה של ה-proxy עם נתיב בסיס שהוא חלק מכתובת ה-URL שה-API Proxy מגיב לה. כתובת ה-URL היא בפורמט https://hostname/basepath/pathsuffixes. מידע נוסף זמין במאמר בנושא יצירת שרת proxy של API.

R

תוכנית תמחור
מפרט של העמלות, החיובים האחרים וחלוקת ההכנסות על השימוש במוצרי API שמוצעים בחבילת API עם מונטיזציה.
בקר שכפול
מתזמן מחדש פודים ומטפל בתיקון עצמי של פודים.
משאב, נתיב משאב
‫
מושג שקשור ל-RESTful, נתיב משאב הוא מזהה משאבים אחיד (URI) שמזהה את נתיב הרשת למשאב נתון.
גרסה
חבילה ממוספרת עם בקרת גרסאות של הגדרות וכללי מדיניות, שמאוגדת בשרת proxy של API. המונח הזה שונה מגרסה, שהוא ממשק ה-API שפונה למפתחים. מידע נוסף מופיע בקטע 'גרסה' בהמשך.
מישור זמן הריצה

שירותי Apigee Hybrid שאתם מנהלים באשכול Kubernetes משלכם, קיימים במישור זמן הריצה. השירותים האלה מתקשרים דרך חשבונות שירות עם מישור הניהול.

כולל MART,‏ Synchronizer,‏ Message Processors,‏ Cassandra ורכיבים נוספים.

מידע נוסף זמין במאמר בנושא מידע על מישור זמן הריצה.

runtime instance
אפשר להגדיר את Apigee עם כמה מופעי זמן ריצה, אחד לכל אזור גיאוגרפי. אפשר לצרף סביבה אחת או יותר למופע של זמן ריצה, וכך לספק זמינות גבוהה (HA) לשרתי proxy של API באזורים שונים.

S

שירות

מונח כללי לאפליקציות בקונטיינרים שפועלות באשכול Kubernetes במישור זמן הריצה. השירותים האלה כוללים את MART,‏ Synchronizer,‏ Message Processors ו-Cassandra.

מידע נוסף זמין במאמר בנושא מידע על מישור זמן הריצה.

צומת עם שמירת מצב
‫
צומת באשכול שנדרש לו אחסון מתמיד כדי לשמור על המצב. איך מגדירים מאגרי צמתים ייעודיים
צומת בלי שמירת מצב
צומת באשכול שלא נדרש בו אחסון מתמיד. מידע נוסף זמין במאמר בנושא הגדרת מאגרי צמתים ייעודיים.
Synchronizer

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

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

מידע נוסף זמין במאמר בנושא מידע על מישור זמן הריצה.

T

נקודת קצה של היעד

נקודת קצה (endpoint) של יעד מגדירה את האופן שבו שרת ה-proxy ל-API מתקשר עם השירותים בקצה העורפי. מגדירים את נקודת הקצה של היעד להעברת בקשות לשירות הבק-אנד המתאים, כולל הגדרת הגדרות אבטחה, פרוטוקול HTTP או HTTPS ופרטי חיבור אחרים. מידע נוסף על שינוי נקודת הקצה של היעד

להוסיף כסף
הפעולה שמבצע מפתח עם תשלום מראש כדי להוסיף כסף ליתרה מההפקדה.
transaction_success_def" id="transaction_success_def">transaction success
המשתנה
למונטיזציה, אם נעשה בו שימוש, מציין אם מתבצעת מונטיזציה של טרנזקציה ב-API. אפשר להשתמש במשתנה הזה כדי לשנות את התנהגות ברירת המחדל, שמבוססת על קוד סטטוס ה-HTTP. משתני מונטיזציה

U

UAP

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

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

UDCA

סוכן אוניברסלי לאיסוף נתונים. שירות שפועל בתוך ה-pod של איסוף הנתונים במישור זמן הריצה, שמחלץ נתוני ניתוח, ניפוי באגים ומצב פריסה ושולח אותם אל UAP.

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

V

גרסה אחת ()
הגרסה של ממשק ה-API שפונה למפתחים. לדוגמה, pivotaltracker.com/services/v3, or api.enterprise.apigee.com/v1. (המונח הזה שונה מ-revision, שהוא חבילה ממוספרת של הגדרות ומדיניות עם ניהול גרסאות, שמאוגדת ב-proxy ל-API. בקיצור, לממשקי API יש גרסאות, ולשרתי proxy ל-API יש גרסאות.
נפח אחסון
נפח אחסון משותף שכל האפליקציות שמבוססות על קונטיינרים יכולות להשתמש בו בתוך פוד.