הסבר על משתני זרימה

אתם צופים במסמכי התיעוד של Apigee Edge.
אפשר לעבור אל מסמכי התיעוד של Apigee X.
מידע

בקטע הזה מופיע מידע על משתני התהליך.

ב-Apigee Edge מוגדרים משתני הזרימה הבאים:

apigee              loadbalancing        route
apiproxy            message              router
application         messageid            servicecallout
client              organization         system
current             proxy                target
environment         ratelimit            variable
error               request              virtualhost
is                  response
                               

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

apigee

משתנה עזר שמספק מידע על זמן ההפעלה של המדיניות.

בטבלה הבאה מפורטים המאפיינים של המשתנה apigee:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
apigee.metrics.policy.policy_name.timeTaken מספר שלם קריאה בלבד הזמן, בננו-שניות, שלקח למדיניות להתבצע. מדיניות

apiproxy

תיאור של שרת ה-proxy ל-API.

בטבלה הבאה מפורטים המאפיינים של המשתנה apiproxy:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
apiproxy.name מחרוזת קריאה בלבד שם ה-API proxy. לדוגמה, "הפרוקסי שלי". בקשה משרת proxy
apiproxy.revision מחרוזת קריאה בלבד מספר הגרסה של proxy ל-API. לדוגמה, '6'. בקשה משרת proxy

מידע נוסף על עבודה עם שרתי proxy ל-API זמין במאמר הסבר על ממשקי API ושרתי proxy ל-API.

application

קונטיינר של המאפיין application.basepath.

בטבלה הבאה מפורטים המאפיינים של המשתנה application:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
application.basepath מחרוזת קריאה בלבד נתיב הבסיס של הפריסה (שצוין במהלך פריסת ה-API). בקשה משרת proxy

client

האפליקציה או המערכת ששלחו בקשה לנתב Edge.

בטבלה הבאה מפורטים המאפיינים של המשתנה client:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
client.cn מחרוזת קריאה בלבד

השם הנפוץ שצוין באישור TLS/SSL שהוצג על ידי אפליקציית הלקוח.

בקשה משרת proxy
client.country מחרוזת קריאה בלבד

המדינה באישור TLS/SSL שמוצג על ידי אפליקציית הלקוח.

בקשה משרת proxy
client.email.address מחרוזת קריאה בלבד

כתובת האימייל באישור TLS/SSL שמוצג על ידי אפליקציית הלקוח.

בקשה משרת proxy
client.host מחרוזת קריאה בלבד

כתובת ה-IP של מארח ה-HTTP שמשויכת לבקשה שהתקבלה ב-ProxyEndpoint.

בקשה משרת proxy
client.ip מחרוזת קריאה בלבד

כתובת ה-IP של הלקוח או המערכת ששולחים את ההודעה לנתב Edge. לדוגמה, יכולה להיות כאן כתובת ה-IP של הלקוח המקורי או כתובת ה-IP של מאזן העומסים.

בקשה משרת proxy
client.locality מחרוזת קריאה בלבד

המיקום (העיר) באישור TLS/SSL שהלקוח מציג.

בקשה משרת proxy
client.organization מחרוזת קריאה בלבד הארגון באישור TLS/SSL שהלקוח מציג. (לא בהכרח שווה לארגון ב-Apigee Edge). בקשה משרת proxy
client.organization.unit מחרוזת קריאה בלבד

היחידה הארגונית באישור ה-TLS/SSL שהלקוח הציג.

בקשה משרת proxy
client.port מספר שלם קריאה בלבד

יציאת ה-HTTP שמשויכת לבקשת הלקוח המקורית אל ProxyEndpoint.

בקשה משרת proxy
client.received.end.time מחרוזת קריאה בלבד

השעה, בפורמט מחרוזת, שבה ה-proxy סיים לקבל את הבקשה מהלקוח המקורי ב-ProxyEndpoint. לדוגמה: Wed, 21 Aug 2013 19:16:47 UTC.

ערך הזמן הזה הוא ייצוג המחרוזת של כמות חותמת הזמן התואמת של 32 ביט. לדוגמה, המחרוזת 'Wed, 21 Aug 2013 19:16:47 UTC' מתאימה לערך חותמת הזמן 1377112607413.

בקשה משרת proxy
client.received.end.timestamp ארוך קריאה בלבד

ערך חותמת הזמן שמציין מתי ה-proxy סיים לקבל את הבקשה מהלקוח המקורי ב-ProxyEndpoint. הערך הזה הוא מספר שלם (long) של 64 ביט שמכיל את מספר אלפיות השנייה שחלפו מאז חצות, ב-1 בינואר 1970 UTC.

בקשה משרת proxy
client.received.start.time מחרוזת קריאה בלבד

השעה, בפורמט מחרוזת, שבה ה-Proxy התחיל לקבל את הבקשה מהלקוח המקורי ב-ProxyEndpoint. לדוגמה: Wed, 21 Aug 2013 19:16:47 UTC

ערך הזמן הזה הוא ייצוג המחרוזת של כמות חותמת הזמן התואמת של 32 ביט. לדוגמה, המחרוזת 'Wed, 21 Aug 2013 19:16:47 UTC' מתאימה לערך חותמת הזמן 1377112607413.

בקשה משרת proxy
client.received.start.timestamp ארוך קריאה בלבד

ערך חותמת הזמן שמציין מתי ה-proxy התחיל לקבל את הבקשה מהלקוח המקורי ב-ProxyEndpoint. הערך הזה הוא מספר שלם (long) של 64 ביט שמכיל את מספר אלפיות השנייה שחלפו מאז חצות, ב-1 בינואר 1970 UTC.

בקשה משרת proxy
client.scheme מחרוזת קריאה בלבד

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

בקשה משרת proxy
client.sent.end.time מחרוזת קריאה בלבד

השעה, שמוצגת כמחרוזת, שבה ה-Proxy סיים לשלוח את התגובה מ-ProxyEndpoint ללקוח. לדוגמה: "Wed, 21 Aug 2013 19:16:47 UTC".

הערך הזה הוא ייצוג מחרוזתי של client.sent.end.timestamp התואם בן 32 הביטים. לדוגמה, המחרוזת Wed, 21 Aug 2013 19:16:47 UTC מתאימה לערך חותמת הזמן 1377112607413.

PostClientFlow
client.sent.end.timestamp ארוך קריאה בלבד ערך חותמת הזמן שמציין מתי ה-ProxyEndpoint סיים להחזיר את התגובה לאפליקציית הלקוח המקורית. הערך הזה הוא מספר שלם (long) בן 64 ביט שמכיל את מספר אלפיות השנייה שחלפו מאז חצות, ב-1 בינואר 1970 UTC. PostClientFlow
client.sent.start.time מחרוזת קריאה בלבד השעה, בפורמט מחרוזת, שבה ProxyEndpoint התחיל להחזיר את התשובה לאפליקציית הלקוח המקורית. לדוגמה, "Wed, 21 Aug 2013 19:16:47 UTC".

הערך הזה הוא ייצוג מחרוזתי של client.sent.start.timestamp התואם בן 32 הביטים. לדוגמה, המחרוזת Wed, 21 Aug 2013 19:16:47 UTC מתאימה לערך חותמת הזמן 1377112607413.

PostClientFlow
client.sent.start.timestamp ארוך קריאה בלבד השעה שבה ה-proxy התחיל לשלוח את התגובה ללקוח מ-ProxyEndpoint. הערך הזה מיוצג כמספר שלם (long) של 64 ביט שמכיל את מספר המילישניות שחלפו מאז חצות, ב-1 בינואר 1970 UTC. PostClientFlow
client.ssl.enabled מחרוזת קריאה בלבד

הערך הוא true אם ProxyEndpoint מוגדר ל-TLS/SSL, אחרת הערך הוא false.

בקשה משרת proxy
client.state מחרוזת קריאה בלבד

המצב באישור TLS/SSL שהוצג על ידי הלקוח.

בקשה משרת proxy

current

כולל מידע על התהליך הנוכחי של שרת ה-API הפרוקסי.

בטבלה הבאה מפורטים המאפיינים של המשתנה current:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
current.flow.name מחרוזת קריאה בלבד השם של הרצף שמופעל כרגע (לדוגמה, PreFlow,‏ PostFlow או השם של רצף מותנה). בקשה משרת proxy
current.flow.description מחרוזת קריאה בלבד התיאור של התהליך שמופעל כרגע. זהה לערך של האלמנט <Description> בהגדרות ה-XML של התהליך. בקשה משרת proxy

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

environment

קונטיינר למאפיין environment.name.

בטבלה הבאה מפורטים המאפיינים של המשתנה environment:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
environment.name מחרוזת קריאה בלבד שם הסביבה שבה בוצעה העסקה. בקשה משרת proxy

error

אובייקט הקשרי שמייצג הודעת שגיאה בתהליך השגיאה.

בטבלה הבאה מפורטים המאפיינים של המשתנה error:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
error message קריאה/כתיבה שגיאה מסוג message, שהוא אובייקט הקשרי בתהליך השגיאה. שגיאה
error.content מחרוזת קריאה/כתיבה תוכן השגיאה. שגיאה
error.message מחרוזת קריאה בלבד

הודעה שמשויכת לשגיאה, שהערך שלה זמין רק לפני ההפעלה של זרימת השגיאה.

שגיאה
error.status.code מספר שלם קריאה בלבד

קוד מצב ה-HTTP שמשויך לשגיאה. לדוגמה, '400'.

שגיאה
error.reason.phrase מחרוזת קריאה בלבד

הסיבה שמשויכת לשגיאה. לדוגמה: "בקשה שגויה".

שגיאה
error.transport.message TransportMessage קריאה בלבד

כל שגיאה מהסוג TransportMessage.

שגיאה
error.state מספר שלם קריאה בלבד

המצב בתהליך העבודה שבו אירעה שגיאה.

שגיאה
error.header.header_name מחרוזת קריאה/כתיבה

קבלת או הגדרת כותרת התגובה.

שגיאה

fault

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

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
fault.fault_name מחרוזת קריאה בלבד fault_name הוא שם השגיאה, כפי שמתואר בטבלה Runtime errors שכלולה בכל נושא policy reference. שגיאה

is

קונטיינר למאפיין is.error.

בטבלה הבאה מפורטים המאפיינים של המשתנה is:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
is.error בוליאני קריאה בלבד

דגל שגיאה.

בקשה משרת proxy

loadbalancing

מספק מידע על סטטוס איזון העומסים של TargetEndpoint.

בטבלה הבאה מפורטים המאפיינים של המשתנה loadbalancing:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
loadbalancing.failedservers Array of Strings קריאה בלבד

רשימה של שרתי יעד שנכשלו במהלך איזון העומסים ב-TargetEndpoint.

תשובה ליעד
loadbalancing.isfallback בוליאני קריאה בלבד

‫true אם הגיבוי מופעל עבור TargetServer שהופעל במהלך איזון העומסים ב-TargetEndpoint.

תשובה ליעד
loadbalancing.targetserver מחרוזת קריאה בלבד

הפעלת TargetServer במהלך איזון עומסים ב-TargetEndpoint. ההגדרה הזו מוגדרת רק אם האלמנט <Path> מוגדר בזמן הגדרת האלמנט של מאזן העומסים.

תשובה ליעד

message

אובייקט הקשר, עם אותו ערך כמו request בתהליך הבקשה, כמו response בתהליך התשובה או כמו error בתהליך השגיאה.

בטבלה הבאה מפורטים המאפיינים של המשתנה message:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
message message קריאה/כתיבה

אובייקט הקשר, עם אותו ערך כמו request בבקשת Flow או כמו response בתגובת Flow או כמו error ב-Error flow.

בקשה משרת proxy
message.content מחרוזת קריאה/כתיבה

התוכן של הבקשה, התשובה או הודעת השגיאה.

בקשה משרת proxy
message.formparam.param_name מחרוזת קריאה/כתיבה

הערך של פרמטר הטופס שצוין.

בקשה משרת proxy
message.formparam.param_name.
 values
אוסף קריאה בלבד

כל הערכים של פרמטר הטופס שצוין בהודעה.

בקשה משרת proxy
message.formparam.param_name.
 values.count
מספר שלם קריאה בלבד

ספירה של ערכי פרמטרים של הטופס שצוינו בהודעה./p>

בקשה משרת proxy
message.formparams.count מספר שלם קריאה בלבד

מספר כל הפרמטרים של הטופס בהודעה.

בקשה משרת proxy
message.formparams.names אוסף קריאה בלבד

הערך של כל פרמטרי הטופס בהודעה.

בקשה משרת proxy
message.formstring מחרוזת קריאה בלבד

הערך של מחרוזת הטופס בהודעה.

בקשה משרת proxy
message.header.header_name מחרוזת קריאה/כתיבה

קבלת או הגדרת הערך של כותרת ה-HTTP שצוינה בהודעה. אם הכותרת מכילה פסיק, בזמן הקריאה תקבלו רק את קטע הטקסט עד הפסיק הראשון. אם רוצים את כל הכותרת, משתמשים בטופס request.header.header_name.
 values

בקשה משרת proxy
message.header.header_name.N מחרוזת קריאה/כתיבה

הערך של הכותרת הספציפית Nth בהודעה, בין אם מדובר בבקשה או בתשובה, בהתאם למצב של התהליך. ב-Apigee Edge, ערכי הטקסט של הכותרות מופרדים באמצעות פסיקים. שימו לב שהאינדקס שהערך שלו משמש ל-N מבוסס על 1, ולא על 0.

לדוגמה: אם הכותרת Cache-control היא public,maxage=16544, אז הערך המוחזר של message.header.cache-control.1 הוא maxage=16544.

בקשה משרת proxy
message.header.header_name.
 values
אוסף קריאה בלבד

כל הערכים של שם כותרת ה-HTTP שצוין בהודעה.

בקשה משרת proxy
message.header.header_name.
 values.count
מספר שלם קריאה בלבד

מספר הערכים של שם כותרת ה-HTTP שצוין בהודעה.

בקשה משרת proxy
message.headers.count מספר שלם קריאה בלבד

מספר כל כותרות ה-HTTP בהודעה.

בקשה משרת proxy
message.headers.names אוסף קריאה בלבד

הערך של כל כותרות ה-HTTP בהודעה

בקשה משרת proxy
message.path מחרוזת קריאה/כתיבה

הנתיב המלא של הודעת הבקשה בכתובת ה-URL, לא כולל פרמטרים של שאילתה.

בקשה משרת proxy
message.queryparam.param_name מחרוזת קריאה בלבד

הפונקציה מחזירה את פרמטר השאילתה של ההודעה שצוין.

בקשה משרת proxy
message.queryparam.param_name.N מחרוזת קריאה/כתיבה

הערך של הפרמטר Nth בשאילתה בהודעה. לדוגמה, אם הערך של request.querystring הוא a=hello&a=world, אז ערך ההחזרה של message.queryparam.a.1 הוא hello.

לדוגמה, כדי לכתוב כמה ערכים עבור שם פרמטר שאילתה יחיד, כמו type=siteid:1&type=language:us-en&type=currency:USD, צריך להגדיר את הפרמטרים הבאים:

  • message.queryparam.type.1 ל-siteid:1
  • message.queryparam.type.2 to "language:en-us"
  • message.queryparam.type.3 להודעה "currency:USD"
בקשה משרת proxy
message.queryparam.param_name.
 values
אוסף קריאה בלבד

כל הערכים של פרמטר שאילתה מסוים בהודעה, בפורמט של רשימת ערכים מופרדים באמצעות פסיק.

לדוגמה, אם מחרוזת השאילתה היא a=hello&a=world, אז הערך של message.queryparam.a.values הוא '['hello', 'world']'.

בקשה משרת proxy
message.queryparam.param_name.
 values.count
מספר שלם קריאה בלבד

המספר הכולל של פרמטר שאילתה ספציפי שמשויך לבקשה שנשלחה אל ProxyEndpoint מאפליקציית הלקוח.

בקשה משרת proxy
message.queryparams.count מספר שלם קריאה בלבד

המספר הכולל של כל פרמטרי השאילתה שמשויכים לבקשה שנשלחה אל ProxyEndpoint מאפליקציית הלקוח.

בקשה משרת proxy
message.queryparams.names אוסף קריאה בלבד

רשימה של כל שמות הפרמטרים של השאילתה שמשויכים לבקשה שנשלחה אל ProxyEndpoint מאפליקציית הלקוח.

כדי לבצע איטרציה על שמות של פרמטרים של שאילתה באמצעות JavaScript, אפשר לעיין בפוסט הבא בקהילת Apigee: How do you iterate Collection from "request.queryparams.names" in JS? (איך מבצעים איטרציה על אוסף מתוך request.queryparams.names ב-JS?) בקהילת Apigee.

בקשה משרת proxy
message.querystring מחרוזת קריאה בלבד

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

לדוגמה, בבקשה http://api.apifactory.com/inventors?name=nick&surname=danger, הערך של message.querystring הוא name=nick&surname=danger.

בקשה משרת proxy
message.reason.phrase מחרוזת קריאה בלבד

הסיבה לתגובה של הודעת התגובה מהיעד.

תשובה ליעד
message.status.code מספר שלם קריאה בלבד

קוד הסטטוס של HTTP של הודעת התגובה מהיעד.

תשובה ליעד
message.transport.message TransportMessage קריאה בלבד

הודעה מסוג TransportMessage, שהיא אובייקט הקשרי.

בקשה משרת proxy
message.uri מחרוזת קריאה בלבד

נתיב ה-URI המלא (אחרי כתובת ה-URL של הדומיין), כולל פרמטרים של שאילתה.

לדוגמה, עבור הבקשה http://api.apifactory.com/inventors?name=nikola&surname=tesla, המשתנה הזה מחזיר את הערך inventors?name=nikola&surname=tesla.

בקשה משרת proxy
message.verb מחרוזת קריאה בלבד

פועל ה-HTTP ‏ (GET,‏ PUT,‏ POST,‏ DELETE וכו') שמשויך לבקשה.

בקשה משרת proxy
message.version מחרוזת קריאה/כתיבה

גרסת ה-HTTP שמשויכת לבקשה שנשלחה אל ProxyEndpoint מאפליקציית הלקוח.

בקשה משרת proxy

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

messageid

מאגר למזהה הייחודי הגלובלי של הבקשה.

בטבלה הבאה מפורטים המאפיינים של המשתנה messageid:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
messageid מחרוזת קריאה בלבד

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

המזהה הזה נרשם ביומני השגיאות של Edge כדי ליצור קורלציה בין messageid לבין השגיאות.

בקשה משרת proxy

organization

קונטיינר של המאפיין organization.name.

בטבלה הבאה מפורטים המאפיינים של המשתנה organization:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
organization.name מחרוזת קריאה בלבד

שם הארגון.

בקשה משרת proxy

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

proxy

הגדרת שרת ה-proxy של ה-API.

בטבלה הבאה מפורטים המאפיינים של המשתנה proxy:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
proxy.basepath מחרוזת קריאה בלבד

הערך של Base Path (נתיב בסיסי) בהגדרת ה-API proxy. נתיב הבסיס הוא קטע ה-URI שמופיע אחרי המארח בכתובת ה-URL. כתובות URI של זרימה מותנית פועלות לפי נתיב הבסיס.

בכתובת ה-URL ‏http://myorg-test.apigee.net/v2/weatherapi/forecastrss?w=12797282:

  • המארח הוא myorg-test.apigee.net (שכולל את שם הארגון והסביבה)
  • נתיב הבסיס הוא '/v2/weatherapi'

הדרך היחידה לדעת את זה היא לבדוק את ההגדרה של שרת ה-proxy של ה-API או את הערך של המשתנה proxy.basepath. סיומת הנתיב של ה-proxy מופיעה אחרי נתיב הבסיס ("/forecastrss"), יחד עם פרמטרים של שאילתה.

אם מגדירים Base Path דינמי בהגדרות של API proxy, כמו ‎/v2/*/weatherapi, המשתנה הזה מוגדר לנתיב הדינמי (‎/v2/*/weatherapi), גם אם הנתיב הבסיסי מוגדר לערך סטטי, כמו ‎/v2/foo/weatherapi.

בקשה משרת proxy
proxy.client.ip מחרוזת קריאה בלבד

כתובת X-Forwarded-For של השיחה הנכנסת, שהיא כתובת ה-IP ש-Edge קיבל מהלחיצת יד האחרונה של TCP חיצוני. יכול להיות שמדובר בלקוח שמתקשר או במאזן עומסים.

בקשה משרת proxy
proxy.name מחרוזת קריאה בלבד

מאפיין השם שהוגדר ל-ProxyEndpoint.

בקשה משרת proxy
proxy.pathsuffix מחרוזת קריאה בלבד

הערך של הסיומת של נתיב הבסיס של שרת proxy ל-API שנשלח מהלקוח ומתקבל ב-ProxyEndpoint.

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

לדוגמה, בבקשה אל http://myorg-test.apigee.net/v2/weatherapi/forecastrss?w=12797282, הסיומת של נתיב הבסיס היא '/forecastrss'.

בקשה משרת proxy
proxy.url מחרוזת קריאה בלבד

הפונקציה מקבלת את כתובת ה-URL המלאה שמשויכת לבקשת ה-proxy שהתקבלה על ידי ProxyEndpoint, כולל כל פרמטר של שאילתה שקיים. המארח של כתובת ה-URL יהיה תמיד localhost אם ה-proxy מופעל עם <LocalTargetConnection> כדי לבצע שרשור של proxy.

דוגמה ליצירת כתובת URL של request באמצעות המארח המקורי מופיעה במאמר הודעות בקשה לגישה.

בקשה משרת proxy

מידע נוסף על עבודה עם שרתי proxy ל-API זמין במאמר הסבר על ממשקי API ושרתי proxy ל-API.

ratelimit

המאפיין הזה מאוכלס כשמדיניות Quota או SpikeArrest מופעלת.

בטבלה הבאה מפורטים המאפיינים של המשתנה ratelimit:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
ratelimit.policy_name.allowed.count ארוך קריאה בלבד הפונקציה מחזירה את מספר המכסות המותרות. PostClientFlow
ratelimit.policy_name.used.count ארוך קריאה בלבד הפונקציה מחזירה את המכסה הנוכחית בשימוש בתוך מרווח זמן של מכסה. PostClientFlow
ratelimit.policy_name.available.count ארוך קריאה בלבד הפונקציה מחזירה את מספר המכסות הזמינות במרווח המכסות. PostClientFlow
ratelimit.policy_name.exceed.count ארוך קריאה בלבד מחזירה 1 אחרי שחרגתם מהמכסה. PostClientFlow
ratelimit.policy_name.total.exceed.count ארוך קריאה בלבד מחזירה 1 אחרי שחרגתם מהמכסה. PostClientFlow
ratelimit.policy_name.expiry.time ארוך קריאה בלבד

הפונקציה מחזירה את השעה לפי שעון UTC (באלפיות השנייה), שקובעת מתי המכסה פג ומתי מתחיל מרווח הזמן החדש של המכסה.

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

PostClientFlow
ratelimit.policy_name.identifier מחרוזת קריאה בלבד מחזירה את ההפניה למזהה (הלקוח) שמצורפת למדיניות PostClientFlow
ratelimit.policy_name.class.allowed.count ארוך קריאה בלבד מחזירה את מספר המכסות המותרות שהוגדר בכיתה PostClientFlow
ratelimit.policy_name.class.used.count ארוך קריאה בלבד החזרת המכסה שהייתה בשימוש בכיתה PostClientFlow
ratelimit.policy_name.class.available.count ארוך קריאה בלבד מחזירה את מספר המקומות שזמינים בכיתה PostClientFlow
ratelimit.policy_name.class.exceed.count ארוך קריאה בלבד מחזירה את מספר הבקשות שחורגות מהמגבלה בכיתה במרווח המכסה הנוכחי PostClientFlow
ratelimit.policy_name.class.total.exceed.count ארוך קריאה בלבד הפונקציה מחזירה את המספר הכולל של בקשות שחרגו מהמגבלה בכיתה בכל מרווחי המכסה, כך שהיא הסכום של class.exceed.count בכל מרווחי המכסה. PostClientFlow
ratelimit.policy_name.failed בוליאני קריאה בלבד

השדה הזה מציין אם המדיניות נכשלה (true או false).

PostClientFlow

למידע נוסף, קראו את המאמרים הבאים:

request

הבקשה המלאה, כולל מטען ייעודי (payload) אם יש כזה.

מידע נוסף על נתוני בקשות זמין במאמר איך נתוני בקשות מועברים לשרת העורפי?

בטבלה הבאה מפורטים המאפיינים של המשתנה request:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
request message קריאה בלבד

הבקשה המלאה, כולל מטען ייעודי (payload) אם יש כזה.

בקשה משרת proxy
request.content מחרוזת קריאה/כתיבה

קבלת המטען הייעודי (payload) של הודעת הבקשה או הגדרתו.

בקשה משרת proxy
request.formparam.param_name מחרוזת קריאה/כתיבה

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

בקשה משרת proxy
request.formparam.param_name.
 values
אוסף קריאה בלבד

כל הערכים של פרמטר מסוים בטופס בבקשה, בפורמט של רשימה מופרדת בפסיקים.

לדוגמה, אם מטען הייעודי הוא ‎"a=hello&x=greeting&a=world"‎, אז הערך של request.formparam.a.values הוא ‎ "['hello', 'world']"‎.

בקשה משרת proxy
request.formparam.param_name.
 values.count
מספר שלם קריאה בלבד

מספר כל הערכים של פרמטר הטופס שצוין שמשויכים לבקשה.

בקשה משרת proxy
request.formparam.param_name.N מחרוזת קריאה/כתיבה

הערך של הפרמטר Nth של טופס מסוים בהודעה. לדוגמה, אם מחרוזת הטופס היא 'a=hello&a=world', אז ערך ההחזרה של request.formparam.a.1 הוא 'hello'.

בקשה משרת proxy
request.formparams.count מספר שלם קריאה בלבד

המספר של כל הפרמטרים של הטופס שמשויכים לבקשה שנשלחה מאפליקציית הלקוח.

בקשה משרת proxy
request.formparams.names אוסף קריאה בלבד

רשימה של כל שמות הפרמטרים של הטופס שמשויכים לבקשה.

בקשה משרת proxy
request.formstring מחרוזת קריאה בלבד

ה-formparam המלא בבקשה שנשלחה מאפליקציית הלקוח.

לדוגמה, name=test&type=first&group=A.

בקשה משרת proxy
request.header.header_name מחרוזת קריאה/כתיבה

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

אם רוצים את הכותרת המלאה, משתמשים בטופס request.header.header_name.values.

בקשה משרת proxy
request.header.header_name.N מחרוזת קריאה/כתיבה

הערך של כותרת מסוימת מספר N בבקשה. ‫Apigee Edge מפצל ערכי טקסט של כותרות באמצעות פסיקים. שימו לב שהאינדקס שמשמש לקביעת הערך של N מתחיל מ-1 ולא מ-0.

לדוגמה, אם הכותרת Cache-control היא public, maxage=16544, הערך המוחזר של request.header.cache-control.1 הוא maxage=16544.

בקשה משרת proxy
request.header.header_name.
 values
אוסף קריאה בלבד

כל הערכים של כותרת מסוימת בבקשה.

בקשה משרת proxy
request.header.header_name.
 values.count
מספר שלם קריאה בלבד

מספר כל הערכים של כותרת מסוימת בבקשה.

בקשה משרת proxy
request.headers.count מספר שלם קריאה בלבד

מספר כל הכותרות בבקשה.

בקשה משרת proxy
request.headers.names אוסף קריאה בלבד

השמות של כל הכותרות בבקשה.

בקשה משרת proxy
request.path מחרוזת קריאה בלבד

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

לדוגמה, אם מזהה המשאבים האחיד (URI) של שירות ה-Backend הוא ‎"https://example.com/rest/api/latest", אז הערך של request.path הוא ‎ "/rest/api/latest".

בקשה משרת proxy
request.queryparam.param_name מחרוזת קריאה/כתיבה

הערך של פרמטר שאילתה מסוים שנמצא בבקשה.

בקשה משרת proxy
request.queryparam.param_name.N מחרוזת קריאה/כתיבה

הערך של פרמטר השאילתה Nth בבקשה.

לדוגמה, אם request.querystring הוא a=hello&a=world, אז ערך ההחזרה של request.queryparam.a.1 הוא hello.

לדוגמה, כדי לכתוב כמה ערכים עבור שם פרמטר שאילתה יחיד, כמו type=siteid:1&type=language:us-en&type=currency:USD, צריך להגדיר את הפרמטרים הבאים:

  • request.queryparam.type.1 ל-siteid:1
  • request.queryparam.type.2 to "language:en-us"
  • request.queryparam.type.3 להודעה "currency:USD"
בקשה משרת proxy
request.queryparam.param_name.
 values
אוסף קריאה בלבד

כל הערכים של פרמטר שאילתה מסוים בבקשה, בפורמט של רשימה מופרדת בפסיקים.

לדוגמה, אם request.querystring הוא 'a=hello&b=lovely&a=world', אז הערך של request.queryparam.a.values הוא '['hello', 'world']'.

בקשה משרת proxy
request.queryparam.param_name.
 values.count
מספר שלם קריאה בלבד

הספירה של כל הערכים של פרמטר שאילתה מסוים בבקשה.

בקשה משרת proxy
request.queryparams.count מספר שלם קריאה בלבד

מספר פרמטרי השאילתה בבקשה.

בקשה משרת proxy
request.queryparams.names אוסף קריאה בלבד

השמות של כל הפרמטרים של השאילתה בבקשה.

כדי לבצע איטרציה על שמות של פרמטרים של שאילתה באמצעות JavaScript, אפשר לעיין במאמר How do you iterate Collection from "request.queryparams.names" in JS? בקהילת Apigee.

בקשה משרת proxy
request.querystring מחרוזת קריאה בלבד

הרשימה המלאה של פרמטרים של שאילתות בבקשה שנשלחה מאפליקציית הלקוח.

לדוגמה, אם הבקשה היא "http://host.com/123?name=first&surname=second&place=address", המשתנה הזה מחזיר את הערך "name=first&surname=second&place=address".

בקשה משרת proxy
request.transportid מחרוזת קריאה בלבד

המזהה של הבקשה כאובייקט מסוג TransportMessage, שהוא אובייקט הקשרי.

בקשה משרת proxy
request.transport.message Transport-Message קריאה בלבד

בקשה מסוג TransportMessage, שהיא אובייקט הקשרי.

בקשה משרת proxy
request.uri מחרוזת קריאה בלבד

ב-API proxy, ה-proxy‏ <BasePath> ב-ProxyEndpoint (בנוסף לכתובת הבסיסית של ה-proxy) ממופה לכתובת ה-URL של שירות היעד ב-TargetEndpoint. לדוגמה:

<ProxyEndpoint>
...
  <BasePath>/my-mock-proxy</BasePath>

מפנה אל

<TargetEndpoint>
...
  <HTTPTargetConnection>
    http://mocktarget.apigee.net
  </HTTPTargetConnection>

בבקשה, ‏request.uri הוא נתיב הבסיס של ה-proxy + שארית הכתובת, כולל פרמטרים של שאילתות.

בתגובה, ‏request.uri הוא החלק שנותר מהכתובת, כולל פרמטרים של שאילתה, אחרי HTTPTargetConnection.

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

נניח שמתבצעת הקריאה הבאה לשרת ה-proxy לדוגמה שלנו, עם נתיב בסיס של ‎/my-mock-proxy:

http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude

ה-Proxy קורא:

http://mocktarget.apigee.net

שמוסיפה את המחרוזת ‎/user?user=Dude לכתובת ה-URL.

  • בקשה: request.uri = "/my-mock-proxy/user?user=Dude"
  • תשובה: request.uri = "/user?user=Dude"
בקשה משרת proxy (שונה בתגובה)
request.url מחרוזת קריאה בלבד

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

לדוגמה, אם מבצעים קריאה לשרת proxy לדוגמה http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude, ונקודת היעד היא http://example.com:8080, הערך יהיה:

  • בקשה: לא רלוונטי
  • תגובה: "http://example.com/user?user=Dude"
תשובה ליעד
request.verb מחרוזת קריאה בלבד

פועל ה-HTTP שבו נעשה שימוש בבקשה. לדוגמה, GET,‏ PUT ו-DELETE.

בקשה משרת proxy
request.version מחרוזת קריאה בלבד

גרסת ה-HTTP של הבקשה. לדוגמה, '1.1'.

בקשה משרת proxy

response

התשובה המלאה, כולל מטען ייעודי (payload) אם יש.

בטבלה הבאה מפורטים המאפיינים של המשתנה response:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
response message קריאה/כתיבה

הודעת תגובה מלאה שמוחזרת על ידי היעד.

תשובה ליעד
response.content מחרוזת קריאה/כתיבה

תוכן המטען הייעודי (payload) של הודעת התגובה שהוחזרה על ידי היעד.

תשובה ליעד
response.formparam.param_name מחרוזת קריאה/כתיבה

הערך של פרמטר טופס בתגובה.

תשובה ליעד
response.formparam.param_name.
 values.count
מספר שלם קריאה בלבד

ספירה של כל הערכים של פרמטר הטופס שצוין בתשובה.

תשובה ליעד
response.formparams.count מספר שלם קריאה בלבד

ספירה של כל הפרמטרים של הטופס בתגובה.

תשובה ליעד
response.formparams.names אוסף קריאה בלבד

השמות של כל הפרמטרים של הטופס בתגובה.

תשובה ליעד
response.header.header_name מחרוזת קריאה/כתיבה

מקבלת או מגדירה את הערך של כותרת HTTP שצוינה בתגובה.

אם טקסט הכותרת כולל פסיק, מערכת Apigee Edge מסיקה שיש כמה ערכים. בדוגמה הזו, הפונקציה response.header.header_name מחזירה רק את הערך הראשון.

כדי לקרוא את הכותרת כולה, משתמשים בפורמט response.header.header_name.values.

תשובה ליעד
response.header.header_name.
 values
אוסף קריאה בלבד

כל הערכים של כותרת HTTP שצוינה בתגובה.

תשובה ליעד
response.header.header_name.
 values.count
מספר שלם קריאה בלבד

מספר כל הערכים של כותרת ה-HTTP שצוינה בתגובה.

תשובה ליעד
response.header.header_name.N מחרוזת קריאה/כתיבה

הערך של הכותרת הספציפית Nth בתגובה. ‫Apigee Edge מפצל ערכי טקסט של כותרות באמצעות פסיקים. שימו לב שהאינדקס שמשמש לקביעת הערך של N מתחיל מ-1 ולא מ-0.

לדוגמה, אם הכותרת Cache-control היא public, maxage=16544, אז הפונקציה response.header.cache-control.1 מחזירה maxage=16544.

תשובה ליעד
response.headers.count מספר שלם קריאה בלבד

מספר כל הכותרות בתגובה.

תשובה ליעד
response.headers.names אוסף קריאה בלבד

השמות של כל הכותרות בתגובה.

תשובה ליעד
response.reason.phrase מחרוזת קריאה/כתיבה

הביטוי שמתאר את הסיבה לתשובה לבקשה מסוימת.

תשובה ליעד
response.status.code מספר שלם קריאה/כתיבה

קוד התגובה שמוחזר לבקשה. אפשר להשתמש במשתנה הזה כדי לשנות את קוד הסטטוס של התשובה, שמאוחסן ב-message.status.code. מידע נוסף זמין במאמר message.

תשובה ליעד
response.transport.message מחרוזת קריאה בלבד

תגובה מסוג TransportMessage, שהיא אובייקט הקשרי.

תשובה ליעד

route

מציין את השמות של <RouteRule> ו-TargetEndpoint.

בטבלה הבאה מפורטים המאפיינים של המשתנה route:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
route.name מחרוזת קריאה בלבד

השם של <RouteRule> שהופעל ב-ProxyEndpoint. לדוגמה, 'default'. ‫RouteRule מפנה אל TargetEndpoint של API proxy כדי לבצע אותו.

בקשת טירגוט
route.target מחרוזת קריאה בלבד

השם של TargetEndpoint שהופעל. לדוגמה, 'ברירת מחדל'.

בקשת טירגוט

router

קונטיינר למאפיין router.uuid, שיצא משימוש.

בטבלה הבאה מפורטים המאפיינים של המשתנה router:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
router.uuid מחרוזת קריאה בלבד

הוצאה משימוש והחזרה של null. (בעבר, המזהה הייחודי האוניברסלי (UUID) של הנתב שמטפל ב-proxy).

בקשה משרת proxy

servicecallout

מתאר את TargetEndpoint של מדיניות ServiceCallout.

בטבלה הבאה מפורטים המאפיינים של המשתנה servicecallout:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
servicecallout.policy_name.expectedcn מחרוזת קריאה/כתיבה

השם הנפוץ הצפוי של TargetEndpoint שאליו מתייחסת מדיניות ServiceCallout. הערך הזה רלוונטי רק כש-TargetEndpoint מתייחס לנקודת קצה של TLS/SSL.

בקשה משרת proxy
servicecallout.policy_name.target.url מחרוזת קריאה/כתיבה

כתובת ה-URL של TargetEndpoint עבור מדיניות ServiceCallout מסוימת.

בקשה משרת proxy
servicecallout.requesturi מחרוזת קריאה/כתיבה

מזהה המשאבים האחיד (URI) של TargetEndpoint עבור מדיניות ServiceCallout. ה-URI הוא כתובת ה-URL של TargetEndpoint בלי הפרוטוקול והדומיין.

בקשה משרת proxy

system

מציינים את כתובת ה-IP של המערכת וגם פרטים על ה-proxy.

בטבלה הבאה מפורטים המאפיינים של המשתנה system:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
system.interface.interface_name מחרוזת קריאה בלבד

כתובת ה-IP של המערכת.

בקשה משרת proxy
system.pod.name מחרוזת קריאה בלבד

שם ה-Pod שבו שרת ה-Proxy פועל.

בקשה משרת proxy
system.region.name מחרוזת קריאה בלבד

השם של מרכז הנתונים באזור שבו ה-proxy פועל.

בקשה משרת proxy
system.time מחרוזת קריאה בלבד

הזמן שבו המשתנה הזה נקרא. לדוגמה, 'Wed, 21 Aug 2013 19:16:47 UTC'.

הערך הזה הוא ייצוג המחרוזת של הערך המתאים של system.timestamp. לדוגמה, הערך 'Wed, 21 Aug 2013 19:16:47 UTC' תואם לערך חותמת הזמן '1377112607413'.

בקשה משרת proxy
system.time.year מספר שלם קריאה בלבד

חלק השנה של system.time.

בקשה משרת proxy
system.time.month מספר שלם קריאה בלבד

רכיב החודש של system.time.

בקשה משרת proxy
system.time.day מספר שלם קריאה בלבד

החלק של היום בחודש מתוך system.time.

בקשה משרת proxy
system.time.dayofweek מספר שלם קריאה בלבד

החלק של היום בשבוע ב-system.time.

בקשה משרת proxy
system.time.hour מספר שלם קריאה בלבד

חלק השעה של system.time.

בקשה משרת proxy
system.time.minute מספר שלם קריאה בלבד

חלק הדקות של system.time.

בקשה משרת proxy
system.time.second מספר שלם קריאה בלבד

החלק השני של system.time.

בקשה משרת proxy
system.time.millisecond מספר שלם קריאה בלבד

החלק של אלפיות השנייה ב-system.time.

בקשה משרת proxy
system.time.zone מחרוזת קריאה בלבד

אזור הזמן של המערכת.

בקשה משרת proxy
system.timestamp ארוך קריאה בלבד

מספר שלם (long) של 64 ביט שמייצג את הזמן שבו המשתנה הזה נקרא. הערך הוא מספר אלפיות השנייה שעברו מאז חצות, ב-1 בינואר 1970 UTC. לדוגמה, "1534783015000".

בקשה משרת proxy
system.uuid מחרוזת קריאה בלבד

ה-UUID של מעבד ההודעות שמטפל ב-Proxy.

בקשה משרת proxy

target

מתאר את היעד של הבקשה.

בטבלה הבאה מפורטים המאפיינים של המשתנה target:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
target.basepath מחרוזת קריאה בלבד

נתיב המשאב (לא כולל הדומיין) לשירות היעד, לא כולל פרמטרים של שאילתות, שמוגדר ב-TargetEndpoint של ה-proxy.

לדוגמה, נניח שפרוקסי של API קורא ליעד הבא:

<TargetEndpoint name="default">
...
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
  </HTTPTargetConnection>

בדוגמה הזו, הערך של target.basepath הוא '/user'.

אם היעד היה:

<TargetEndpoint name="default">
...
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>

הערך של target.basepath יהיה null.

בקשת טירגוט
target.copy.pathsuffix בוליאני קריאה/כתיבה

אם הערך הוא true, הבקשה שמועברת מ-ProxyEndpoint אל TargetEndpoint שומרת על הסיומת של הנתיב (הקטע של נתיב ה-URI שאחרי ה-URI שמוגדר בנתיב הבסיסי של ProxyEndpoint).

בקשת טירגוט
target.copy.queryparams בוליאני קריאה/כתיבה

אם הערך הוא true, הבקשה מועברת מ-ProxyEndpoint אל TargetEndpoint ושומרת על פרמטרים של שאילתה.

בקשת טירגוט
target.country מחרוזת קריאה בלבד

המדינה שבה הונפק אישור ה-TLS/SSL שמוצג על ידי שרת היעד

תשובה ליעד
target.cn מחרוזת קריאה בלבד

השם המקובל של TargetEndpoint. הערך הזה רלוונטי רק כש-TargetEndpoint מפנה לנקודת קצה של TLS/SSL.

בקשת טירגוט
target.email.address מחרוזת קריאה בלבד

כתובת האימייל של אישור ה-TLS/SSL שמוצג על ידי שרת היעד

תשובה ליעד
target.expectedcn מחרוזת קריאה/כתיבה

השם המקובל הצפוי של TargetEndpoint. הערך הזה רלוונטי רק כש-TargetEndpoint מתייחס לנקודת קצה של TLS/SSL.

בקשה משרת proxy
target.host מחרוזת קריאה בלבד

שם הדומיין של שירות היעד שמחזיר את התגובה ל-API Proxy.

תשובה ליעד
target.ip מחרוזת קריאה בלבד

כתובת ה-IP של שירות היעד שמחזיר את התגובה ל-API Proxy.

תשובה ליעד
target.locality מחרוזת קריאה בלבד

המיקום (העיר) של אישור ה-TLS/SSL שמוצג על ידי שרת היעד

תשובה ליעד
target.name מחרוזת קריאה בלבד

יעד שאליו ההודעה מגיעה מ-TargetEndpoint.

בקשת טירגוט
target.organization מחרוזת קריאה בלבד

הארגון של אישור ה-TLS/SSL שמוצג על ידי שרת היעד.

תשובה ליעד
target.organization.unit מחרוזת קריאה בלבד

היחידה הארגונית של אישור TLS/SSL שמוצג על ידי שרת היעד.

תשובה ליעד
target.port מספר שלם קריאה בלבד

מספר היציאה של שירות היעד שמחזיר את התגובה ל-API proxy.

תשובה ליעד
target.received.end.time מחרוזת קריאה בלבד

השעה, בפורמט מחרוזת, שבה TargetEndpoint סיים לקבל את התשובה מהיעד. לדוגמה, 'Wed, 21 Aug 2013 19:16:47 UTC'.

ערך הזמן הזה הוא ייצוג המחרוזת של כמות חותמת הזמן התואמת של 32 ביט. לדוגמה, המחרוזת 'Wed, 21 Aug 2013 19:16:47 UTC' תואמת לערך חותמת הזמן '1377112607413'.

תשובה ליעד
target.received.end.
  timestamp
ארוך קריאה בלבד

ערך חותמת הזמן שמציין מתי TargetEndpoint סיים לקבל את התגובה מהיעד. לדוגמה, "1534783015000". הערך הזה הוא מספר שלם (long) בן 64 ביט שמציין את מספר אלפיות השנייה שחלפו מאז חצות, ב-1 בינואר 1970 לפי שעון UTC.

תשובה ליעד
target.received.start.time מחרוזת קריאה בלבד

השעה, בפורמט מחרוזת, שבה התחיל TargetEndpoint לקבל את התשובה מהיעד. לדוגמה, 'Wed, 21 Aug 2013 19:16:47 UTC'.

ערך הזמן הזה הוא ייצוג המחרוזת של כמות חותמת הזמן התואמת של 32 ביט. לדוגמה, הערך 'Wed, 21 Aug 2013 19:16:47 UTC' תואם לערך חותמת הזמן '1377112607413'.

תשובה ליעד
target.received.start.
  timestamp
ארוך קריאה בלבד

ערך חותמת הזמן שמציין מתי TargetEndpoint התחיל לקבל את התגובה מהיעד. לדוגמה, "1534783015000". הערך הזה הוא מספר שלם (long) בן 64 ביט שמציין את מספר אלפיות השנייה שחלפו מאז חצות, ב-1 בינואר 1970 לפי שעון UTC.

תשובה ליעד
target.scheme מחרוזת קריאה בלבד

היקף ההרשאות מתחיל: תגובת היעד
סוג: מחרוזת
הרשאה: קריאה/כתיבה

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

בקשת טירגוט
target.sent.end.time מחרוזת קריאה בלבד

השעה, בפורמט מחרוזת, שבה ה-proxy הפסיק לשלוח את הבקשה לכתובת ה-URL שצוינה ב-TargetEndpoint. לדוגמה, 'Wed, 21 Aug 2013 19:16:47 UTC'.

ערך הזמן הזה הוא ייצוג המחרוזת של כמות חותמת הזמן התואמת של 32 ביט. לדוגמה, הערך 'Wed, 21 Aug 2013 19:16:47 UTC' תואם לערך חותמת הזמן '1377112607413'.

בקשת טירגוט
target.sent.end.timestamp ארוך קריאה בלבד

ערך חותמת הזמן שמציין מתי ה-proxy סיים לשלוח את הבקשה לכתובת ה-URL שצוינה ב-TargetEndpoint. לדוגמה, "1377112607413". הערך הזה הוא מספר שלם (long) של 64 ביט שמכיל את מספר המילישניות שחלפו מאז חצות, ב-1 בינואר 1970 UTC.

בקשת טירגוט
target.sent.start.time מחרוזת קריאה בלבד

השעה, בפורמט מחרוזת, שבה שרת ה-proxy התחיל לשלוח את הבקשה לכתובת ה-URL שצוינה ב-TargetEndpoint. לדוגמה, 'Wed, 21 Aug 2013 19:16:47 UTC'.

ערך הזמן הזה הוא ייצוג המחרוזת של כמות חותמת הזמן התואמת של 32 ביט. לדוגמה, הערך 'Wed, 21 Aug 2013 19:16:47 UTC' תואם לערך חותמת הזמן '1377112607413'.

בקשת טירגוט
target.sent.start.timestamp ארוך קריאה בלבד

ערך חותמת הזמן שמציין מתי ה-proxy התחיל לשלוח את הבקשה לכתובת ה-URL שצוינה ב-TargetEndpoint. לדוגמה, "1534783015000". הערך הזה הוא מספר שלם (long) של 64 ביט שמציין את מספר אלפיות השנייה שחלפו מאז חצות, ב-1 בינואר 1970 לפי שעון UTC.

בקשת טירגוט
target.ssl.enabled בוליאני קריאה בלבד

האם TargetEndpoint פועל ב-TLS/SSL.

בקשה משרת proxy
target.state מחרוזת קריאה בלבד

המצב של אישור ה-TLS/SSL שמוצג על ידי שרת היעד.

תשובה ליעד
target.url מחרוזת קריאה/כתיבה

כתובת ה-URL שמוגדרת בקובץ ה-XML של TargetEndpoint או כתובת היעד הדינמית (אם target.url מוגדר במהלך זרימת ההודעות). המשתנה לא כולל רכיבי נתיב נוספים או פרמטרים של שאילתה. הפונקציה מחזירה ערך null אם היא מופעלת מחוץ להיקף או אם היא לא מוגדרת.

בקשת טירגוט

variable

קונטיינר של המאפיין variable.expectedcn.

בטבלה הבאה מפורטים המאפיינים של המשתנה variable:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
variable.expectedcn מחרוזת קריאה/כתיבה

משתנה שנחשף לשם הנפוץ אם הוא פועל ב-TLS/SSL.

בקשה משרת proxy

מידע נוסף על עבודה עם TLS זמין במאמר מבוא ל-TLS/SSL.

virtualhost

מציינים פרטים על המארח הווירטואלי.

בטבלה הבאה מפורטים המאפיינים של המשתנה virtualhost:

נכס סוג קריאה/כתיבה תיאור התחלת ההיקף
virtualhost.aliases.values Array of Strings קריאה בלבד

כינויי מארח של המארח הווירטואלי שאליו מגיעה בקשה מסוימת.

בקשה משרת proxy
virtualhost.name מחרוזת קריאה בלבד

השם של המארח הווירטואלי שמשרת את בקשת הלקוח המקורית.

בקשה משרת proxy
virtualhost.ssl.enabled בוליאני קריאה בלבד

הפונקציה מחזירה true אם TLS/SSL מופעל בהגדרות של המארח הווירטואלי.

בקשה משרת proxy

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