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

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X.
מידע

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

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

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

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

apigee

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

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

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

apiproxy

מתאר את שרת ה-proxy של ה-API.

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

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
apiproxy.name מחרוזת קריאה בלבד השם של שרת ה-API של שרת ה-API. לדוגמה, "My Proxy". בקשה לשרת proxy
apiproxy.revision מחרוזת קריאה בלבד מספר הגרסה של שרת proxy ל-API. לדוגמה, "6". בקשה לשרת proxy

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

application

מאגר לנכס application.basepath.

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

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

client

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

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

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
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. לדוגמה: יום רביעי, 21 באוגוסט 2013 19:16:47 UTC.

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

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

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

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

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

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

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

ערך חותמת הזמן שמציין מתי שרת ה-proxy התחיל לקבל את הבקשה מהלקוח המקור ב-ProxyEndpoint. הערך הזה הוא מספר שלם (ארוך) של 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 סיים להחזיר את התגובה לאפליקציית הלקוח המקורית. הערך הזה הוא מספר שלם (ארוך) של 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. הערך הזה מבוטא כמספר שלם (ארוך) של 64 ביט שמכיל את מספר אלפיות השנייה שחלפו מאז חצות, ב-1 בינואר 1970 לפי שעון UTC. PostClientFlow
client.ssl.enabled מחרוזת קריאה בלבד

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

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

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

בקשה לשרת proxy

current

מכיל מידע על הזרימה הנוכחית של שרת ה-proxy של ה-API.

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

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

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

environment

מאגר לנכס environment.name.

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

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

error

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

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

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
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

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

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
fault.fault_name מחרוזת קריאה בלבד fault_name הוא השם של התקלה, כפי שמתואר בטבלה שגיאות בזמן ריצה שכלולה בכל נושא הפניה למדיניות. שגיאה

is

מאגר לנכס is.error.

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

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
is.error בוליאני קריאה בלבד

סימון שגיאה.

בקשה לשרת proxy

loadbalancing

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

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

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
loadbalancing.failedservers Array of Strings קריאה בלבד

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

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

'true' אם החלופה מופעלת ל-TargetServer הופעל במהלך איזון עומסים ב-TargetEndpoint.

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

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

יעד התגובה

message

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

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

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
message message קריאה/כתיבה

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

בקשה לשרת 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 מחרוזת קריאה/כתיבה

הערך של הערך הספציפי של הכותרת N בהודעה, בבקשה או בתגובה, בהתאם למצב הזרימה. 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 מחרוזת קריאה/כתיבה

הערך של פרמטר השאילתה N בהודעה. לדוגמה, אם 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 אל "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? בקהילת 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=nicola&surname=tesla".

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

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

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

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

בקשה לשרת proxy

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

messageid

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

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

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
messageid מחרוזת קריאה בלבד

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

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

בקשה לשרת proxy

organization

מאגר לנכס organization.name.

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

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
organization.name מחרוזת קריאה בלבד

שם הארגון.

בקשה לשרת proxy

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

proxy

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

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

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
proxy.basepath מחרוזת קריאה בלבד

הערך של נתיב הבסיס בהגדרת שרת ה-proxy של ה-API. הנתיב הבסיסי הוא מקטע ה-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'), ביחד עם כל הפרמטרים של השאילתה.

אם מגדירים נתיב בסיס דינמי בהגדרות של שרת ה-API של ה-API, למשל "/v2/*/weatherapi", המשתנה הזה מוגדר לנתיב הדינמי ("/v2/*/weatherapi"), על אף שהנתיב הבסיסי ממיר לערך סטטי, כמו '/v2/foo/weatherapi'.

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

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

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

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

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

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

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

לדוגמה, בבקשה ל-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.

request

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

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

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

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
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 מחרוזת קריאה/כתיבה

הערך של פרמטר הטופס הספציפי N בהודעה. לדוגמה, אם מחרוזת הטופס היא '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 ולא על אפס.

לדוגמה, אם הכותרת 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 של השירות לקצה העורפי הוא "https://example.com/rest/api/בש", אבל הערך של request.path הוא "/rest/api/minute".

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

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

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

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

לדוגמה, אם 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 אל "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, עיינו במאמר איך מבצעים איטרציה של איסוף מ-"request.queryparams.names" ב-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 העברת הודעה קריאה בלבד

בקשה מסוג TransportMessage שהיא אובייקט דו-מיני.

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

בשרת proxy ל-API, שרת ה-proxy <BasePath> ב-ProxyEndpoint (בנוסף לכתובת ה-URL הבסיסית של שרת ה-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=Dud" לכתובת ה-URL הזו.

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

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

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

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

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

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

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

בקשה לשרת proxy

response

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

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

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
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 מחרוזת קריאה/כתיבה

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

לדוגמה, אם הכותרת 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:

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
route.name מחרוזת קריאה בלבד

השם של <RouteRule> שהופעל ב-ProxyEndpoint. לדוגמה, "default". RouteRule מפנה יעד של API proxy ל-API לצורך הפעלה.

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

השם של TargetEndpoint שבוצע. לדוגמה, "default".

בקשת יעד

router

מאגר לנכס router.uuid, שהוצא משימוש.

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

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
router.uuid מחרוזת קריאה בלבד

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

בקשה לשרת proxy

servicecallout

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

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

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
servicecallout.policy_name.expectedcn מחרוזת קריאה/כתיבה

השם המשותף הצפוי של ה-TargetEndpoint, כפי שמוזכר במדיניות ServiceCallout. יש לכך משמעות רק כאשר TargetEndpoint מתייחס לנקודת קצה (endpoint) של TLS/SSL.

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

כתובת ה-URL של Targetendpoint במדיניות מסוימת של Serviceהסברים.

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

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

בקשה לשרת proxy

system

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

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

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
system.interface.interface_name מחרוזת קריאה בלבד

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

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

שם רצף המודעות שבו פועל שרת ה-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 ארוך קריאה בלבד

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

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

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

בקשה לשרת proxy

target

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

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

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
target.basepath מחרוזת קריאה בלבד

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

לדוגמה, נניח ששרת 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 מתייחס לנקודת קצה (endpoint) של TLS/SSL.

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

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

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

השם המשותף הצפוי של ה-TargetEndpoint. יש לכך משמעות רק כאשר TargetEndpoint מתייחס לנקודת קצה (endpoint) של TLS/SSL.

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

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

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

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

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

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

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

היעד שאליו ההודעה מגיעה מנקודת הקצה.

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

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

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

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

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

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

יעד התגובה
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'. הערך הזה הוא מספר שלם (ארוך) של 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'. הערך הזה הוא מספר שלם (ארוך) של 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'. הערך הזה הוא מספר שלם (ארוך) של 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'. הערך הזה הוא מספר שלם (ארוך) של 64 ביט, שמציין את מספר אלפיות השנייה שחלפו מאז חצות, ב-1 בינואר 1970 לפי שעון UTC.

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

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

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

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

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

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

בקשת יעד

variable

מאגר לנכס variable.expectedcn.

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

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
variable.expectedcn מחרוזת קריאה/כתיבה

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

בקשה לשרת proxy

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

virtualhost

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

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

מאפיין (property) סוג קריאה/כתיבה תיאור ההיקף מתחיל
virtualhost.aliases.values Array of Strings קריאה בלבד

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

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

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

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

מחזירה את הערך 'true' אם TLS/SSL מופעל בהגדרת המארח הווירטואלי.

בקשה לשרת proxy

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