מוצג המסמך של Apigee Edge.
עוברים אל
מסמכי תיעוד של Apigee X. מידע
ייצוג של המארח הווירטואלי
אובייקט ה-XML שבו משתמשים כדי להגדיר מארח וירטואלי מבוסס על הגרסה של Edge: Cloud או ענן פרטי.
אם אתם לקוחות של Private Cloud, עליכם לוודא שאתם משתמשים ב-XML הנכון עבור שבה אתם משתמשים ב-Edge.
ענן וענן פרטי 4.17.01 ואילך
<VirtualHost name="vhostName"> <Port>portNumber</Port> <BaseUrl>http://myCo.com</BaseUrl> <OCSPStapling>offOn</OCSPStapling> <HostAliases> <HostAlias>hostAlias</HostAlias> </HostAliases> <Interfaces> <!-- Private Cloud only --> <Interface>interfaceName</Interface> </Interfaces> <RetryOptions> <RetryOption>option</RetryOption> </RetryOptions> <ListenOptions> <ListenOption>option</ListenOption> </ListenOptions> <SSLInfo> <Enabled>trueFalse</Enabled> <ClientAuthEnabled>trueFalse</ClientAuthEnabled> <KeyStore>ref://keystoreRef</KeyStore> <KeyAlias>keyAlias</KeyAlias> <TrustStore>ref://truststoreRef</TrustStore> <IgnoreValidationErrors>trueFalse</IgnoreValidationErrors> </SSLInfo> <!-- UseBuiltInFreeTrialCert is for Edge Cloud only --> <UseBuiltInFreeTrialCert>trueFalse</UseBuiltInFreeTrialCert> <PropagateTLSInformation> <!-- PropagateTLSInformation is Alpha in the Cloud only --> <ConnectionProperties>trueFalse</ConnectionProperties> <ClientProperties>trueFalse</ClientProperties> </PropagateTLSInformation> <Properties> <Property name="proxy_read_timeout">timeout</Property> <Property name="keepalive_timeout">timeout</Property> <Property name="proxy_request_buffering">onOff</Property> <Property name="proxy_buffering">onOff</Property> <!-- ssl_protocols is Private Cloud only --> <Property name="ssl_protocols">protocolList</Property> <Property name="ssl_ciphers">cipherList</Property> </Properties> </VirtualHost>
ענן פרטי 4.16.01 עד 4.16.09
<VirtualHost name="vhostName"> <Port>portNumber</Port> <HostAliases> <HostAlias>hostAlias</HostAlias> </HostAliases> <Interfaces> <Interface>interfaceName</Interface> </Interfaces> <SSLInfo> <Enabled>trueFalse</Enabled> <ClientAuthEnabled>trueFalse</ClientAuthEnabled> <KeyStore>ref://keystoreRef</KeyStore> <KeyAlias>keyAlias</KeyAlias> <TrustStore>ref://truststoreRef</TrustStore> <IgnoreValidationErrors>trueFalse</IgnoreValidationErrors> </SSLInfo> </VirtualHost>
ענן פרטי 4.15.07 ו- מוקדם יותר
<VirtualHost name="vhostName"> <Port>portNumber</Port> <HostAliases> <HostAlias>hostAlias</HostAlias> </HostAliases> <Interfaces> <Interface>interfaceName</Interface> </Interfaces> <SSLInfo> <Enabled>trueFalse</Enabled> <ClientAuthEnabled>trueFalse</ClientAuthEnabled> <KeyStore>keystore</KeyStore> <KeyAlias>keyAlias</KeyAlias> <TrustStore>truststore</TrustStore> <IgnoreValidationErrors>trueFalse</IgnoreValidationErrors> <Ciphers> <Cipher>cipher</Cipher> <Cipher>cipher</Cipher> </Ciphers> <Protocols> <Protocol>protocol</Protocol> <Protocol>protocol</Protocol> </Protocols> </SSLInfo> </VirtualHost>
מאפייני תצורה של מארח וירטואלי
הטבלה הבאה מפרטת את המאפיינים שבהם משתמשים כדי להגדיר מארח וירטואלי:
מאפיינים | תיאור | ברירת מחדל | חובה | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
VirtualHost |
מציינת את השם של המארח הווירטואלי. משתמשים בשם הזה כדי להפנות למארח הווירטואלי כשמגדירים שרת proxy ל-API. התווים שבהם ניתן להשתמש במאפיין השם מוגבלים ל: A-Z0-9._\-$%. |
ללא | כן | ||||||||||||
יציאה |
מציינת את מספר היציאה שהמארח הווירטואלי משתמש בו. ודא שהיציאה פתוחה נתב Edge. אם מציינים יציאה ברכיב בענן: צריך לציין את היציאה 443 כשיוצרים מארח וירטואלי. אם המיקום שהושמט, כברירת מחדל היציאה מוגדרת ל-443. אם יש לך מארח וירטואלי קיים שמשתמש יציאה שאינה 443, אי אפשר לשנות את היציאה. לגרסאות 4.16.01 עד 4.17.05 של ענן פרטי: כשיוצרים מארח וירטואלי, מציין את יציאת הנתב שבה משתמש המארח הווירטואלי. לדוגמה, יציאה 9001. כברירת מחדל, הנתב פועל בתור המשתמש "apigee" שאין לו גישה אל יציאות עם הרשאות, בדרך כלל יציאות מגרסה 1024 ומטה. אם רוצים ליצור מארח וירטואלי שמקשרת את הנתב ליציאה מוגנת, צריך להגדיר את הנתב כך שיפעל משתמש שיש לו גישה ליציאות האלה. צפייה הגדרת מארח וירטואלי עבור עוד. בגרסאות של ענן פרטי לפני 4.16.01: הנתב יכול להאזין ל רק חיבור HTTPS אחד לכל מארח וירטואלי, ביציאה ספציפית, עם האישור שצוין. לכן, כמה מארחים וירטואליים לא יכולים להשתמש באותו מספר יציאה אם סיום TLS מתבצע בנתב ביציאה שצוינה. |
ללא | כן | ||||||||||||
BaseUrl | ביטול של כתובת ה-URL שהוצגה על ידי ממשק המשתמש של Edge עבור שרת proxy ל-API שנפרס בשרת הווירטואלי
מארח. שימושי כשיש מאזן עומסים חיצוני מול נתבי Edge. צפייה
הגדרת TLS
גישה ל-API של הענן הפרטי
הערך של |
ללא | לא | ||||||||||||
OCSPStapling |
לקוח OCSP (Online Certificate Status Protocol) שולח סטטוס בקשה למגיב OCSP כדי לקבוע אם אישור ה-TLS תקף. התגובה מציין אם אישור ה-TLS תקף ולא בוטל. כשהאפשרות הזו מופעלת, OCSP stapling מאפשר להשתמש ב-Edge, שישמש כשרת TLS ל-TLS חד-כיווני, כדי לשלוח שאילתה ישירות למגיב ה-OCSP ולאחר מכן לשמור את התשובה במטמון. לאחר מכן, Edge מחזיר את התשובה הזו ללקוח TLS, או מהדק אותה, כחלק מלחיצת היד של TLS. למידע נוסף, כדאי לעיין במאמר הפעלת OCSP בהקלדת השרת. לקבלת מידע נוסף. כדי להפעיל OCSP, צריך להפעיל TLS. כדי להפעיל, צריך להגדיר את הערך |
מושבתת | לא | ||||||||||||
HostAliases | |||||||||||||||
HostAlias |
שם ה-DNS הגלוי לציבור של המארח הווירטואלי בנתב, באופן אופציונלי כולל מספר יציאה. השילוב של שם הכינוי של המארח ומספר היציאה של המארח הווירטואלי חייב הוא ייחודי לכל המארחים הווירטואליים בהתקנת Edge. כלומר, כמה ארכיטקטורות וירטואליות למארחים יש אפשרות להשתמש באותו מספר יציאה אם יש להם כינויי מארח שונים. עליך ליצור רשומת DNS ורשומת CNAME שתואמות לכינוי של המארח ולמארח
הכינוי חייב להתאים למחרוזת שהלקוח מעביר בכותרת מספר היציאה ב- אפשר לקבוע כמה הגדרות של אפשר לכלול את הסימן "*" תו כללי לחיפוש בכינוי המארח. הסימן "*" התו הכללי לחיפוש יכול
יהיה רק בהתחלה (לפני התו '.') הראשון של כינוי המארח, ואי אפשר לשלב אותו עם תווים אחרים.
לדוגמה, בענן: אם יש לכם מארח וירטואלי קיים שמשתמש ביציאה אחרת מ-443, לא ניתן להוסיף או להסיר כינוי מארח. בענן פרטי: אם מגדירים את הכתובת החלופית של המארח באמצעות כתובת ה-IP את כתובות הנתבים שלכם ולא את רשומות ה-DNS, צריך להוסיף כינוי מארח נפרד לכל אחד מהם נתב, שמציין את כתובת ה-IP של כל נתב ויציאה של המארח הווירטואלי. |
ללא | כן | ||||||||||||
ממשקים | האפשרות זמינה רק ב-Edge לענן פרטי. | ||||||||||||||
ממשק |
מציינת את ממשקי הרשת שאליהם רוצים לקשר את לדוגמה, כדי לציין קישור של היציאה רק ל-en0: <Interfaces> <Interface>en0</Interface> </Interfaces> כדי לקבוע אילו ממשקים זמינים במערכת שלכם, מריצים את הפקודה "ifconfig -a" הפקודה. |
ללא | כל הממשקים | ||||||||||||
RetryOptions | זמין ל-Edge Cloud ול-Private Cloud 4.18.01 וכן מאוחר יותר. | ||||||||||||||
RetryOption |
הגדרת האופן שבו הנתב מגיב למארח הווירטואלי הזה כשמעבד ההודעות עובר למטה. אפשר לציין כמה ערכים באמצעות הפונקציה
אם מציינים כמה ערכים, הנתב משתמש באופרטור OR לוגי כדי לשלב ביניהם. לדוגמה: <RetryOptions> <RetryOption>http_599</RetryOption> <RetryOption>error</RetryOption> <RetryOption>timeout</RetryOption> <RetryOption>invalid_header</RetryOption> </RetryOptions> |
||||||||||||||
ListenOptions | זמין ב-Private Cloud בגרסה 4.18.01 ואילך וב-Edge שליחת בקשה לתמיכה של Apigee Edge ב-Cloud. | ||||||||||||||
ListenOption |
אם אתם משתמשים ב-ELB במצב העברה של TCP כדי לטפל בבקשות לנתבי Edge:
הנתב מתייחס לכתובת ה-IP של ה-ELB כאל כתובת ה-IP של הלקוח
את כתובת ה-IP של הלקוח בפועל. אם הנתב דורש את כתובת ה-IP האמיתית של הלקוח,
להפעיל את ערך ברירת המחדל של לדוגמה: <ListenOptions> <ListenOption>proxy_protocol</ListenOption> </ListenOptions> כדי לבטל את ההגדרה של |
||||||||||||||
SSLInfo | |||||||||||||||
מופעל |
מפעילה TLS/SSL חד-כיווני. עליך להגדיר מאגר מפתחות שמכיל את האישור מפתח פרטי. עבור Cloud: צריך להיות לכם אישור חתום על ידי ישות מהימנה, כמו Symantec או VeriSign. אי אפשר להשתמש באישור בחתימה עצמית או באישורי קצה שנחתמו על ידי רשות אישורים בחתימה עצמית. לענן: אם המארח הווירטואלי הקיים מוגדר לשימוש ביציאה מלבד 443, לא ניתן לשנות את הגדרת ה-TLS. כלומר, אי אפשר לשנות את הגדרת ה-TLS מ- מ'מושבת' ל'מושבת', או מ'מושבת' ל'מופעל'. |
false | לא | ||||||||||||
ClientAuthEnabled | מפעיל TLS דו-כיווני, או לקוח, בין Edge (שרת) לאפליקציה (לקוח) שמבצע את בקשה. כדי להפעיל TLS דו-כיווני צריך להגדיר מאגר אמון ב-Edge שמכיל את האישור מלקוח ה-TLS. | false | לא | ||||||||||||
KeyStore |
השם של מאגר המפתחות ב-Edge. ב-Apigee מומלץ להשתמש בהפניה כדי לציין את השם של מאגר המפתחות, יכול לשנות את מאגר המפתחות בלי להפעיל מחדש נתבים. ראו אפשרויות עבור הגדרת TLS לקבלת מידע נוסף. |
ללא | כן אם המדיניות מופעלת | ||||||||||||
KeyAlias | הכינוי שצוין כשהעלית את האישור ואת המפתח הפרטי למאגר המפתחות. שלך חייב לציין את כינוי השם באופן מילולי; אי אפשר להשתמש בהפניה. אפשרויות להגדרה TLS (אבטחת שכבת התעבורה). | ללא | כן אם המדיניות מופעלת | ||||||||||||
TrustStore |
השם של ה-Truststore ב-Edge שמכיל את האישור או את שרשרת האישורים
ל-TLS דו-כיווני. חובה אם הערך של ב-Apigee מומלץ להשתמש בהפניה כדי לציין את השם של ה-Truststore יכול לשנות את ה-Truststore בלי להפעיל מחדש את הנתבים. ראו אפשרויות עבור הגדרת TLS לקבלת מידע נוסף. |
ללא | לא | ||||||||||||
IgnoreValidationErrors |
אם הערך הוא True, הוא מציין להתעלם משגיאות באישור TLS. כמו " -k" אפשרות ל-cURL. האפשרות הזאת תקפה כשמגדירים TLS לשרתי יעד ונקודות קצה של יעד. כשמגדירים מארחים וירטואליים שמשתמשים ב-TLS דו-כיווני. בשימוש עם נקודת קצה (endpoint) או שרת יעד, אם מערכת הקצה העורפי משתמשת ב-SNI ומחזירה אישור עם שם מובחן (DN) שלא תואם לשם המארח, אין דרך מתעלם מהשגיאה והחיבור נכשל. |
false | לא | ||||||||||||
הצפנה |
ל-Edge for Private Cloud בגרסה 4.15.07 ובגרסאות קודמות בלבד. מציינת את הצפנים שנתמכים על ידי המארח הווירטואלי. אם לא הוגדרו צופנים, נאפשר את כל הצפנים שזמינים ל-JVM. כדי להגביל את הצפנים, צריך להוסיף את הרכיבים הבאים: <Ciphers> <Cipher>TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA</Cipher> <Cipher>TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256</Cipher> </Ciphers> |
כל האפשרויות נתמכות על ידי ה-JVM | לא | ||||||||||||
פרוטוקולים |
ל-Edge for Private Cloud בגרסה 4.15.07 ובגרסאות קודמות בלבד. מציינת אילו פרוטוקולים נתמכים על ידי המארח הווירטואלי. אם לא הוגדרו פרוטוקולים, כל הפרוטוקולים שזמינים ל-JVM יורשו. כדי להגביל פרוטוקולים, מוסיפים את הרכיבים הבאים: <Protocols> <Protocol>TLSv1</Protocol> <Protocol>TLSv1.2</Protocol> <Protocol>SSLv2Hello</Protocol> </Protocols> |
כל האפשרויות נתמכות על ידי ה-JVM | לא | ||||||||||||
UseBuiltInFreeTrialCert | זמין רק ב-Edge Cloud. | ||||||||||||||
UseBuiltInFreeTrialCert |
אם יש לכם חשבון Edge בתשלום ועדיין אין לכם אישור ומפתח TLS, תוכלו לבצע את הפעולות הבאות: ליצור מארח וירטואלי שמשתמש באישור ובמפתח תקופת הניסיון בחינם של Apigee. כלומר אפשר ליצור המארח הווירטואלי בלי ליצור קודם מאגר מפתחות. האישור לתקופת ניסיון בחינם של Apigee מוגדר לדומיין של למידע נוסף, ראו הגדרת מארח וירטואלי שמשתמשת באישור ובמפתח תקופת הניסיון בחינם של Apigee. |
false | לא | ||||||||||||
PropagateTLSInformation | זמין בגרסת אלפא ל-Edge Cloud בלבד. | ||||||||||||||
ConnectionProperties |
הפעלת התיעוד של פרטי חיבור ב-TLS על ידי Edge. לאחר מכן מידע זה יהיה זמין כמשתני זרימה בשרת proxy ל-API. למידע נוסף, ראו גישה לפרטי חיבור ל-TLS בשרת proxy ל-API לקבלת מידע נוסף. |
false | לא | ||||||||||||
ClientProperties |
הפעלת תיעוד פרטי אישורי לקוח שתועדו על ידי Edge ב-TLS דו-כיווני. לאחר מכן מידע זה יהיה זמין כמשתני זרימה בשרת proxy ל-API. למידע נוסף, ראו גישה לפרטי חיבור ל-TLS בשרת proxy ל-API לקבלת מידע נוסף. |
false | לא | ||||||||||||
נכסים | זמין ל-Edge Cloud ול-Private Cloud 4.17.01 וכן מאוחר יותר. | ||||||||||||||
proxy_read_timeout |
מגדיר את משך הזמן הקצוב לתפוגה, בשניות, בין מעבדי הודעות לבין הנתב. הנתב מנתק את החיבור ומחזיר תגובת HTTP 504 אם היא לא מקבלת תגובה ממעבד ההודעות לפני תום משך הזמן הזה. הערך של proxy_read_timeout צריך להיות גדול מערך היעד של הזמן הקצוב לתפוגה שבו נעשה שימוש
על ידי מעבד ההודעות. זה מבטיח שהנתב לא יפוג לפני
למעבד ההודעות יש זמן להחזיר תגובה. ברירת המחדל של יעד הזמן הקצוב לתפוגה של
מעבד ההודעות הוא 55 שניות ו-55, 000 אלפיות שנייה, לפי הגדרת
אסימון |
57 | לא | ||||||||||||
keepalive_timeout |
הגדרה של משך הזמן הקצוב לתפוגה (בשניות), בין הלקוח לנתב שולח בקשה שמכילה את הכותרת Keep-Alive. הנתב משאיר את החיבור פתוח עד לסיום משך הזמן. הנתב לא יסגור את החיבור אם הוא ממתין לתגובה ממעבד ההודעות. הזמן הקצוב לתפוגה מתחיל רק אחרי שהנתב מחזיר את התגובה ללקוח. |
65 | לא | ||||||||||||
ssl_ciphers |
הגדרת הצפנים שנתמכים על ידי המארח הווירטואלי תוך ביטול של הצפנים שמוגדרים כברירת מחדל בנתב. מציינים רשימת צפנים שמופרדת בנקודתיים, באופן הבא: <Property name="ssl_ciphers">HIGH:!aNULL:!MD5:!DH+3DES:!kEDH;</Property> מידע נוסף על התחביר והערכים המותרים על ידי האסימון הזה זמין בכתובת https://www.openssl.org/docs/man1.0.2/man1/ciphers.html. שים לב שהאסימון הזה משתמש בשמות ההצפנה של OpenSSL, כמו AES128-SHA256, ולא ב- שמות הצפנה של Java/JSSE, כמו TLS_RSA_WITH_AES_128_CBC_SHA256. |
גבוה:!aNULL:
!MD5: DH+3DES: !kEDH |
לא | ||||||||||||
ssl_protocols |
האפשרות זמינה רק ב-Edge לענן פרטי. מגדיר את פרוטוקולי ה-TLS שנתמכים על ידי המארח הווירטואלי, כרשימה מופרדת ברווחים, ביטול של פרוטוקולי ברירת המחדל שהוגדרו בנתב. הערה: אם שני מארחים וירטואליים חולקים את אותה יציאה, הם חייבים להגדיר
מציינים רשימה מופרדת ברווחים של פרוטוקולים TLS, בפורמט הבא: <Property name="ssl_protocols">TLSv1 TLSv1.2</Property> |
TLSv1 TLSv1.1 TLSv1.2 | לא | ||||||||||||
proxy_request_buffering |
מפעיל (מופעל) או משבית (מושבת) אחסון זמני של גוף הבקשה. כשתהליך אגירת הנתונים מופעל, הנתב מאחסן את כל גוף הבקשה לפני שליחתו למעבד ההודעות. אם המיקום יש שגיאה, הנתב יכול לנסות מעבד הודעות אחר. אם האפשרות מושבתת, תהליך אגירת הנתונים מושבת וגוף הבקשה נשלח למעבד ההודעות. מיד ברגע שהוא מתקבל. במקרה של שגיאה, הנתב לא מנסה שוב את למעבד הודעות אחר. |
מופעל | לא | ||||||||||||
proxy_buffering | המתג מפעיל (מופעל) או משבית (השבתה) של אגירת הנתונים של התגובה. כשתהליך אגירת הנתונים מופעל, הנתב מאחסן את התגובה. כשהאחסון במאגר הנתונים הזמני מושבת, התגובה מועברת ללקוח באופן סינכרוני, ברגע שהוא מתקבל בנתב. | מופעל | לא |