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

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

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

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

מכיל מידע על תהליך ה-proxy הנוכחי של ה-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 מחרוזת קריאה בלבד

משפט הסיבה שמשויך לשגיאה. לדוגמה: 'Bad Request'.

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

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

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

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

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

אחזור או הגדרה של כותרת התגובה.

שגיאה

fault

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

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

is

מאגר של המאפיין is.error.

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

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

דגל שגיאה.

בקשת proxy

loadbalancing

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

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

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

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

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

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

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

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

תגובת היעד

message

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

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

נכס סוג קריאה/כתיבה תיאור היקף הבדיקה מתחיל
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 מחרוזת קריאה/כתיבה

הערך של פרמטר השאילתה 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 ל-'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: איך מבצעים איטרציה על אוסף מ-"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 מחרוזת קריאה בלבד

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

תגובת היעד
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 בהגדרת שרת ה-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"), יחד עם כל פרמטר השאילתה.

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

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

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

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

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

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

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

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

בקשת 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 ולא ב-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) של שירות הקצה העורפי הוא "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 ל-'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 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=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", הערך הוא:

  • בקשה: n/a
  • תשובה: "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 מחרוזת קריאה/כתיבה

הערך של הכותרת ה-N הספציפית בתגובה. מערכת 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". כלל מסלול מפנה ל-TargetEndpoint של שרת proxy ל-API כדי לבצע אותו.

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

השם של TargetEndpoint שהופעל. לדוגמה, 'default'.

בקשה לטירגוט

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

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

מזהה ה-UUID של מעבד ההודעות שמטפל בשרת ה-proxy.

בקשת proxy

target

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

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

נכס סוג קריאה/כתיבה תיאור היקף הבדיקה מתחיל
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 מתייחס לנקודת קצה מסוג TLS/SSL.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Scope begins: תגובת היעד
Type: מחרוזת
Permission: קריאה/כתיבה

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

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

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

ערך הזמן הזה הוא ייצוג המחרוזת של כמות חותמת הזמן המתאימה באורך 32 ביט. לדוגמה, 'רביעי, 21 באוגוסט 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 ביט. לדוגמה, 'רביעי, 21 באוגוסט 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 או כתובת ה-URL של היעד הדינמי (אם 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

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