הפניה למשתני תהליך

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

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

בקטע הזה מופיע מידע על משתני זרימה נפוצים של Apigee:

apigee is request
apiproduct loadbalancing response
apiproxy message route
client messageid servicecallout
current mint system
environment organization target
error proxy variable
fault publishmessage
graphql ratelimit

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

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

apigee

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

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

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

apiproduct

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

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

מאפיין (property) סוג קריאה/כתיבה תיאור התחלת ההיקף
apiproduct.operation String לקריאה בלבד

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

לדוגמה, my-operation.

 בקשה משרת proxy
apiproduct.operation.resource String לקריאה בלבד

שם המשאב של הפעולה שתואמת לבקשה.

 בקשה משרת proxy
apiproduct.operation.methods מערך לקריאה בלבד

מערך של שיטות HTTP שהפעולה התואמת מאפשרת.

 בקשה משרת proxy
apiproduct.operation.attributes.key_name מערך לקריאה בלבד

הפונקציה מחזירה את ערך המאפיין המותאם אישית שתואם ל-key_name.

 בקשה משרת proxy

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

apiproxy

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

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

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

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

client

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

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

מאפיין (property) סוג קריאה/כתיבה תיאור התחלת ההיקף
client.cn String לקריאה בלבד

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

 בקשה משרת proxy
client.country String לקריאה בלבד

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

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

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

 בקשה משרת proxy
client.host String לקריאה בלבד

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

 בקשה משרת proxy
client.ip String לקריאה בלבד

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

 בקשה משרת proxy
client.locality String לקריאה בלבד

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

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

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

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

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

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

השעה, בפורמט מחרוזת, שבה ה-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 String לקריאה בלבד

השעה, שמוצגת כמחרוזת, שבה ה-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.resolved.ip String לקריאה בלבד

כתובת ה-IP של הלקוח אחרי שהמערכת פתרה אותה. זהו הערך שנקבע מתוך הגדרת רזולוציית כתובת IP של לקוח שהוגדרה, או מתוך אלגוריתם ברירת המחדל, אם לא צוינה הגדרת רזולוציית כתובת IP של לקוח. מידע נוסף זמין במאמר Client IP resolution.

 בקשה משרת proxy
client.scheme String לקריאה בלבד

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

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

השעה, שמוצגת כמחרוזת, שבה ה-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 String לקריאה בלבד השעה, בפורמט מחרוזת, שבה 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 String לקריאה בלבד

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

 בקשה משרת proxy
client.state String לקריאה בלבד

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

 בקשה משרת proxy

current

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

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

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

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

environment

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

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

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

error

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

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

מאפיין (property) סוג קריאה/כתיבה תיאור התחלת ההיקף
error message קריאה/כתיבה שגיאה מסוג message, שהוא אובייקט הקשרי בתהליך השגיאה. שגיאה
error.content String קריאה/כתיבה תוכן השגיאה. שגיאה
error.message String לקריאה בלבד

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

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

קוד סטטוס של HTTP שמשויך לשגיאה. לדוגמה, 400.

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

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

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

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

 שגיאה
error.header.header_name String קריאה/כתיבה

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

 שגיאה

fault

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

מאפיין (property) סוג קריאה/כתיבה תיאור התחלת ההיקף
fault.name String לקריאה בלבד שם התקלה, כפי שמתואר בטבלה Runtime errors שמופיעה בכל נושא policy reference. המשתנה הזה יכול להיות שימושי בתנאים שחלים על FaultRule. שגיאה
fault.reason String לקריאה בלבד הסיבה לתקלה. לדוגמה, אם מדיניות OASValidation מזהה שבקשה נכנסת לא עוברת אימות מול מפרט OpenAPI, היא תגדיר את המשתנה הזה למחרוזת שמתארת את שם המדיניות, שם המפרט והפרטים שמסבירים למה הבקשה לא עוברת אימות מול המפרט. מדיניות אחרת תגדיר את המשתנה הזה להודעות שמתאימות לשגיאות שלה. שגיאה
fault.category String לקריאה בלבד הקטגוריה. לדוגמה, אם השגיאה מתרחשת בשלב של מדיניות, המשתנה הזה עשוי להכיל את הערך Step. המשתנה הזה יכול להיות שימושי בתנאים שחלים על FaultRules. שגיאה
fault.subcategory String לקריאה בלבד קטגוריית המשנה. לדוגמה, אם מדיניות ה-OASValidation מזהה שבקשה לא מאומתת מול מפרט OpenAPI, היא תגדיר את המשתנה הזה ל-OASValidationFailure. המשתנה הזה יכול להיות שימושי בתנאים שחלים על FaultRules. שגיאה

graphql

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

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

מאפיין (property) סוג קריאה/כתיבה תיאור
graphql סוג מורכב קריאה בלבד/קריאה וכתיבה שאילתת ה-GraphQL הבסיסית. היקף
graphql.fragment סוג מורכב קריאה בלבד/קריאה וכתיבה הפניה לקטע ברירת המחדל של השאילתה הזו. היקף
graphql.fragment.count מספר שלם קריאה בלבד מספר הפרגמנטים שנוצרו על ידי שאילתת GraphQL הזו. היקף
graphql.fragment.INDEX.selectionSet.INDEX סוג קריאה בלבד/קריאה וכתיבה הפניה לקבוצת הבחירה באינדקס שצוין. היקף
graphql.fragment.INDEX.selectionSet.INDEX.name String קריאה בלבד/קריאה וכתיבה השם של קבוצת הבחירה באינדקס שצוין. היקף
graphql.fragment.INDEX.selectionSet.count מספר שלם קריאה בלבד מספר קבוצות הבחירה בקטע הזה. היקף
graphql.fragment.INDEX.selectionSet.name String קריאה בלבד/קריאה וכתיבה השם של קבוצת הבחירה שמוגדרת כברירת מחדל בקטע. היקף
graphql.operation סוג מורכב קריאה בלבד/קריאה וכתיבה הפניה לפעולת ברירת המחדל של השאילתה.

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

 היקף
graphql.operation.name String קריאה בלבד השם של פעולת ברירת המחדל של השאילתה. היקף
graphql.operation.operationType ספירה קריאה בלבד פעולת ברירת המחדל של סוג השאילתה שאפשר להריץ מול ה-proxy ל-API הזה. הערכים האפשריים הם query,‏ mutation או all. היקף
graphql.operation.selectionSet סוג מורכב הבחירה שמוגדרת כברירת מחדל לפעולת ברירת המחדל של השאילתה. היקף
graphql.operation.selectionSet.count מספר שלם קריאה בלבד מספר קבוצות הבחירה בפעולת ברירת המחדל של השאילתה. היקף
graphql.operation.selectionSet.name String קריאה בלבד השם של קבוצת הבחירה שמוגדרת כברירת מחדל בפעולה שמוגדרת כברירת מחדל בשאילתה. היקף
graphql.operation.selectionSet.INDEX מספר שלם קריאה בלבד הפניה לקבוצת הבחירה באינדקס שצוין ברשימה של קבוצות הבחירה. היקף
graphql.operation.selectionSet.INDEX.name String קריאה בלבד השם של הבחירה באינדקס שצוין ברשימת קבוצות הבחירה של הפעולה הזו. היקף
graphql.operation.selectionSet.INDEX.[selectionSet] סוג מורכב קריאה בלבד/קריאה וכתיבה אובייקט אחד או יותר של קבוצת בחירה נוספת.

אפשר לגשת לקבוצות של בחירות באופן רקורסיבי. לדוגמה, אחרי selectionSet.index אפשר להוסיף עוד selectionSet.index במקום נכס name. אחרי זה עוד אחד וכן הלאה עד שמגיעים לערך של <MaxCount> שהגדרתם במדיניות GraphQL.

היקף
graphql.operation.selectionSet.INDEX.directive סוג מורכב הפניה להנחיית ברירת המחדל בקבוצת הבחירה שצוינה. היקף
graphql.operation.selectionSet.INDEX.directive.count סוג מורכב היקף
graphql.operation.selectionSet.INDEX.directive.INDEX מספר שלם קריאה בלבד הפניה להנחיה באינדקס שצוין. היקף
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX מספר שלם קריאה בלבד הפניה לארגומנט באינדקס שצוין. היקף
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX.name String השם של הארגומנט באינדקס שצוין. היקף
graphql.operation.selectionSet.INDEX.directive.INDEX.argument.INDEX.value String הערך של הארגומנט באינדקס שצוין. היקף
graphql.operation.selectionSet.INDEX.directive.name String היקף
graphql.operation.variableDefinitions סוג מורכב הפניה לרשימה של הגדרות משתנים לפעולת ברירת המחדל של השאילתה. היקף
graphql.operation.variableDefinitions.count מספר שלם מספר הגדרות המשתנים לפעולת ברירת המחדל של השאילתה. היקף
graphql.operation.variableDefinitions.INDEX מספר שלם הפניה להגדרת המשתנה באינדקס שצוין. היקף
graphql.operation.variableDefinitions.INDEX.name String השם של הגדרת המשתנה באינדקס שצוין. היקף
graphql.operation.variableDefinitions.INDEX.type הסוג של הערך בהגדרת המשתנה באינדקס שצוין. היקף

is

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

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

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

דגל שגיאה.

 בקשה משרת proxy

loadbalancing

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

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

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

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

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

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

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

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

 תשובה ליעד

message

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

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

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

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

 בקשה משרת proxy
message.content String קריאה/כתיבה

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

 בקשה משרת proxy
message.content.as.base64 String לקריאה בלבד

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

 בקשה משרת proxy
message.content.as.url.safe.base64 String לקריאה בלבד

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

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

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

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

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

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

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

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

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

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

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

 בקשה משרת proxy
message.formparams.names.string String לקריאה בלבד

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

 בקשה משרת proxy
message.formstring String לקריאה בלבד

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

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

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

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

אם רוצים שהכותרת כולה תהיה מחרוזת, משתמשים במשתנה כמו message.header.header_name.values.string.

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

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

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

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

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

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

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

 בקשה משרת proxy
message.header.header_name.
 values.string		 String לקריאה בלבד

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

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

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

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

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

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

 בקשה משרת proxy
message.headers.names.string String לקריאה בלבד

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

 בקשה משרת proxy
message.path String קריאה/כתיבה

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

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

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

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

הערך של פרמטר השאילתה 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 מאפליקציית הלקוח.

 בקשה משרת proxy
message.queryparams.names.string String לקריאה בלבד

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

 בקשה משרת proxy
message.querystring String לקריאה בלבד

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

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

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

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

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

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

 בקשה משרת proxy
message.uri String לקריאה בלבד

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

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

 בקשה משרת proxy
message.verb String לקריאה בלבד

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

 בקשה משרת proxy
message.version String קריאה/כתיבה

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

 בקשה משרת proxy

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

messageid

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

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

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

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

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

 בקשה משרת proxy

mint

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

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

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

סימון שמציין אם בקשת ה-API חסומה. הערך הוא true אם is_subscription_found הוא false.

משתנה ה-Flow הזה זמין אם מדיניות MonetizationLimitsCheck מצורפת ל-proxy ל-API. משתני זרימה של MonetizationLimitsChecks

 בקשה משרת proxy
mint.limitscheck.is_subscription_found בוליאני לקריאה בלבד

דגל שמציין אם למפתח יש מינוי פעיל למוצר ה-API. הערך מוגדר כ-true אם למפתח יש מינוי.

משתנה ה-Flow הזה זמין אם מדיניות MonetizationLimitsCheck מצורפת ל-proxy ל-API. משתני זרימה של MonetizationLimitsChecks

 בקשה משרת proxy
mint.limitscheck.prepaid_developer_balance Numeric לקריאה בלבד

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

בקשה משרת proxy
mint.limitscheck.prepaid_developer_currency String לקריאה בלבד

המטבע של היתרה שזמינה במשתנה mint.limitscheck.prepaid_developer_balance. יכול לחול על מפתח אפליקציה ספציפי או על קבוצת אפליקציות.

 בקשה משרת proxy
mint.limitscheck.purchased_product_name String לקריאה בלבד

השם של מוצר ה-API המשויך.

משתנה ה-Flow הזה זמין אם מדיניות MonetizationLimitsCheck מצורפת ל-proxy ל-API. משתני זרימה של MonetizationLimitsChecks

 בקשה משרת proxy
mint.limitscheck.status_message String לקריאה בלבד

מידע נוסף על הביצוע של המדיניות MonetizationLimitsCheck למטרות ניפוי באגים.

משתנה ה-flow הזה זמין אם מדיניות MonetizationLimitsCheck מצורפת ל-proxy ל-API. מידע נוסף זמין במאמר משתני flow של MonetizationLimitsChecks.

 בקשה משרת proxy
mint.mintng_consumption_pricing_rates String לקריאה בלבד

עמלות מבוססות-צריכה.

מגדירים את העמלות כשיוצרים תוכנית מחירים.

 PostClientFlow
mint.mintng_consumption_pricing_type String לקריאה בלבד

סוג התמחור מבוסס-צריכה. לדוגמה: FIXED_PER_UNIT

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

 PostClientFlow
mint.mintng_currency String לקריאה בלבד

המטבע שבו מחושבות ההכנסות.

משתנה ה-Flow הזה מקבל את הערך של currency משתנה המונטיזציה.

 מדיניות DataCapture
mint.mintng_dev_share Numeric לקריאה בלבד

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

מגדירים את ההכנסה שתשותף עם המפתח או עם AppGroup כשיוצרים תוכנית תמחור.

 PostClientFlow
mint.mintng_is_apiproduct_monetized בוליאני לקריאה בלבד

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

משתנה הזרימה הזה מתווסף על ידי המדיניות VerifyAPIKey או VerifyAccessToken שמצורפת ל-proxy ל-API. איך מוסיפים מדיניות אימות

 בקשה משרת proxy
mint.mintng_price Numeric לקריאה בלבד

ההכנסה לחישוב החלק של המפתח.

למשתנה של התהליך יש את הערך של revShareGrossPrice משתנה המונטיזציה.

 המדיניות בנושא DataCapture ו-PostClientFlow
mint.mintng_price_multiplier Numeric לקריאה בלבד

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

למשתנה של התהליך יש את הערך של perUnitPriceMultiplier משתנה המונטיזציה.

 המדיניות בנושא DataCapture ו-PostClientFlow
mint.mintng_rate Numeric לקריאה בלבד

התעריף שחויב עבור הקריאה ל-API.

משתנה הזרימה הזה מציג את העמלה לפי שימוש לכל קריאה ל-API. מגדירים את העמלה לפי צריכה כשיוצרים תוכנית תמחור. אם הגדרתם את perUnitPriceMultiplier משתנה המונטיזציה במדיניות DataCapture, ‏ Apigee מחשב את עלות העסקה אחרי התחשבות בערך של המשתנה perUnitPriceMultiplier. מידע נוסף זמין במאמר מדדים בקטע Api price multiplier.

 PostClientFlow
mint.mintng_rate_before_multipliers Numeric לקריאה בלבד

התעריף שבו מחויבת הקריאה ל-API ללא החישוב של perUnitPriceMultiplier.

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

 PostClientFlow
mint.mintng_rate_plan_id String לקריאה בלבד

המזהה של תוכנית התמחור.

משתנה הזרימה הזה מתווסף על ידי המדיניות VerifyAPIKey או VerifyAccessToken שמצורפת ל-proxy ל-API. איך מוסיפים מדיניות אימות

 בקשה משרת proxy
mint.mintng_revenue_share_rates String לקריאה בלבד

שיעורי חלוקת ההכנסות.

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

 PostClientFlow
mint.mintng_revenue_share_type String לקריאה בלבד

סוג חלוקת ההכנסות. לדוגמה: FIXED

מגדירים את סוג חלוקת ההכנסות כשיוצרים תוכנית תמחור.

 PostClientFlow
mint.mintng_tx_success בוליאני לקריאה בלבד

המאפיין מציין אם העסקה מניבה רווחים.

משתנה ה-Flow הזה מקבל את הערך של transactionSuccess משתנה המונטיזציה.

 מדיניות DataCapture
mint.prepaid_updated_developer_usage Numeric לקריאה בלבד

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

השימוש מחושב על סמך הגדרת תוכנית התמחור והערך של משתנה המונטיזציה perUnitPriceMultiplier.

 PostClientFlow
mint.rateplan_end_time_ms Numeric לקריאה בלבד

זמן התפוגה של תוכנית התמחור באלפיות השנייה מאז ראשית זמן יוניקס (Unix epoch).

משתנה הזרימה הזה מתווסף על ידי המדיניות VerifyAPIKey או VerifyAccessToken שמצורפת ל-proxy ל-API. איך מוסיפים מדיניות אימות

 בקשה משרת proxy
mint.rateplan_start_time_ms Numeric לקריאה בלבד

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

משתנה הזרימה הזה מתווסף על ידי המדיניות VerifyAPIKey או VerifyAccessToken שמצורפת ל-proxy ל-API. איך מוסיפים מדיניות אימות

 בקשה משרת proxy
mint.status String לקריאה בלבד

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

 PostClientFlow
mint.status_code Numeric לקריאה בלבד

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

 PostClientFlow
mint.subscription_end_time_ms Numeric לקריאה בלבד

זמן התפוגה של המינוי למוצר ה-API באלפיות שנייה מאז ראשית הזמן.

משתנה ה-Flow הזה זמין אם מדיניות MonetizationLimitsCheck מצורפת ל-proxy ל-API. משתני זרימה של MonetizationLimitsChecks

 בקשה משרת proxy
mint.subscription_start_time_ms Numeric לקריאה בלבד

זמן ההפעלה של המינוי למוצר ה-API באלפיות השנייה מאז תחילת התקופה של זמן מערכת.

משתנה ה-Flow הזה זמין אם מדיניות MonetizationLimitsCheck מצורפת ל-proxy ל-API. משתני זרימה של MonetizationLimitsChecks

 בקשה משרת proxy
mint.tx_success_result בוליאני לקריאה בלבד

מציין אם המונטיזציה של העסקה בוצעה בהצלחה.

המשתנה mint.tx_success_result יכול לקבל את הערכים הבאים:

  • ‫tx_success מוגדר כ-true: המשתנה transactionSuccess הוא true, והעסקה מניבה רווח. מכיוון שהעסקה מניבה רווח, המערכת מחשבת את הערכים של המשתנים mint.mintng_rate ו-mint.mintng_dev_share.
  • המשתנה tx_success מוגדר כ-false: המשתנה transactionSuccess הוא false, והעסקה לא מניבה רווח. מכיוון שהעסקה לא מניבה רווחים, המערכת לא מחשבת את הערכים של המשתנים mint.mintng_rate ו-mint.mintng_dev_share.
  • tx_success לא נמצא. קוד הסטטוס של ההודעה לא היה 2xx: המשתנה transactionSuccess לא נלכד וקוד הסטטוס של HTTP ‏ (message.status.code) של העסקה לא היה 2xx. לא מופעלת מונטיזציה בעסקה.
  • tx_success לא נמצא. קוד הסטטוס של ההודעה היה 2xx: המשתנה transactionSuccess לא נלכד וקוד הסטטוס של HTTP ‏ (message.status.code) של העסקה הוא 2xx. מופעלת מונטיזציה בעסקה.
 PostClientFlow

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

organization

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

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

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

שם הארגון.

 בקשה משרת proxy

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

proxy

הגדרת proxy ל-API.

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

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

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

נניח שהגדרתם נקודת קצה של שרת proxy ל-API עם נתיב בסיס של /v2/weatherapi. (פרטים נוספים זמינים במאמר בנושא הגדרת נקודת קצה של שרת proxy). במקרה כזה, אם הבקשה הנכנסת משתמשת בכתובת ה-URL‏ https://myhost.example.net/v2/weatherapi/forecastrss?w=12797282, אז:

  • שם המארח הוא myhost.example.net. אפשר לאחזר את הערך הזה על ידי קריאת המשתנה request.header.host.
  • נתיב הבסיס הוא /v2/weatherapi. אפשר לאחזר את הערך הזה על ידי קריאת המשתנה proxy.basepath.
  • סיומת הנתיב היא /forecastrss. אפשר לאחזר את הערך הזה על ידי קריאת המשתנה proxy.pathsuffix.

אם מגדירים נתיב בסיס דינמי בהגדרת ה-proxy ל-API, כמו /v2/*/weatherapicode>, המשתנה proxy.basepath מוגדר לנתיב הדינמי. כדי לאחזר את כתובת ה-URL בפועל של הבקשה, צריך לקרוא את ולנתח את המשתנה proxy.url.

 בקשה משרת proxy
proxy.client.ip String לקריאה בלבד

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

 בקשה משרת proxy
proxy.name String לקריאה בלבד

מאפיין השם שהוגדר עבור ProxyEndpoint.

 בקשה משרת proxy
proxy.pathsuffix String לקריאה בלבד

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

נתיב הבסיס הוא רכיב הנתיב השמאלי ביותר שמזהה באופן ייחודי proxy ל-API בתוך קבוצת סביבות. נניח שהגדרתם נקודת קצה של proxy ל-API עם נתיב בסיס של /v2/weatherapi. במקרה כזה, בקשה שנשלחת אל https://myhost.example.net/v2/weatherapi/forecastrss?w=12797282, המשתנה proxy.pathsuffix יכיל את המחרוזת /forecastrss.

 בקשה משרת proxy
proxy.url String לקריאה בלבד

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

 בקשה משרת proxy

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

publishmessage

מאוכלס כשמדיניות PublishMessage מופעלת.

מאפיין (property) סוג קריאה/כתיבה תיאור התחלת ההיקף
publishmessage.message.id String קריאה בלבד מחזירה את messageId (המזהה של ההודעה שפורסמה) משרת Pub/Sub.

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

 בקשה משרת proxy

ratelimit

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

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

מאפיין (property) סוג קריאה/כתיבה תיאור התחלת ההיקף
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 String קריאה בלבד מחזירה את ההפניה למזהה (הלקוח) שמצורפת למדיניות PostClientFlow
ratelimit.policy_name.class String קריאה בלבד הפונקציה מחזירה את המחלקה שמשויכת למזהה הלקוח. 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 אם המדיניות נתקלה בכשל בהפעלה פנימית. אין להשתמש במשתנה הזה כדי לבדוק אם חרגתם ממגבלת קצב. יכול להיות שהוא יוגדר כ-true בעומס גבוה בגלל העיצוב של SpikeArrest עם "fail-open".

 PostClientFlow

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

request

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

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

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

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

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

 בקשה משרת proxy
request.content String קריאה/כתיבה

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

 בקשה משרת proxy
request.content.as.base64 String לקריאה בלבד

תוכן המטען הייעודי (payload) של הודעת הבקשה בקידוד Base64.

 בקשה משרת proxy
request.content.as.url.safe.base64 String לקריאה בלבד

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

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

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

 בקשה משרת 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 String קריאה/כתיבה

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

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

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

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

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

 בקשה משרת proxy
request.formparams.names.string String לקריאה בלבד

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

 בקשה משרת proxy
request.formstring String לקריאה בלבד

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

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

 בקשה משרת proxy
request.grpc.rpc.name String לקריאה בלבד

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

בקשה משרת proxy
request.grpc.service.name String לקריאה בלבד

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

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

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

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

אם רוצים שהכותרת כולה תהיה מחרוזת, משתמשים במשתנה כמו request.header.header_name.values.string.

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

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

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

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

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

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

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

 בקשה משרת proxy
request.header.header_name.
 values.string		 String לקריאה בלבד

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

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

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

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

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

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

 בקשה משרת proxy
request.headers.names.string String לקריאה בלבד

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

 בקשה משרת proxy
request.path String לקריאה בלבד

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

לדוגמה, אם מזהה ה-URI של שירות הקצה העורפי הוא https://example.com/rest/api/latest, הערך של request.path הוא /rest/api/latest.

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

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

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

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

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

 בקשה משרת proxy
request.queryparams.names.string String לקריאה בלבד

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

 בקשה משרת proxy
request.querystring String לקריאה בלבד

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

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

 בקשה משרת proxy
request.transportid String לקריאה בלבד

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

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

בקשה מסוג TransportMessage שהיא תלוית-הקשר.

 בקשה משרת proxy
request.uri String לקריאה בלבד

ב-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 String לקריאה בלבד

כתובת ה-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 String לקריאה בלבד

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

 בקשה משרת proxy
request.version String לקריאה בלבד

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

 בקשה משרת proxy

response

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

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

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

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

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

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

 תשובה ליעד
response.content.as.base64 String לקריאה בלבד

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

 תשובה ליעד
response.content.as.url.safe.base64 String לקריאה בלבד

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

 תשובה ליעד
response.event.current.content String קריאה/כתיבה

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

 תגובה של EventFlow
response.event.current.count מספר שלם קריאה

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

. 		תגובה של EventFlow
response.event.current.data String קריאה/כתיבה

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

 תגובה של EventFlow
response.header.header_name String קריאה/כתיבה

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

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

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

אם רוצים שהכותרת כולה תהיה מחרוזת, משתמשים במשתנה כמו response.header.header_name.values.string.

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

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

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

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

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

כל הערכים של כותרת מסוימת בתגובה, בפורמט של מחרוזת אחת.

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

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

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

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

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

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

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

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

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

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

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

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

 תשובה ליעד
response.version String לקריאה בלבד גרסת ה-HTTP של התגובה שהתקבלה משרת היעד, לדוגמה, 'HTTP/1.1'. תשובה ליעד
response.transport.message String לקריאה בלבד

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

 תשובה ליעד

route

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

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

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

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

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

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

 בקשת טירגוט

servicecallout

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

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

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

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

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

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

 בקשה משרת proxy
servicecallout.requesturi String קריאה/כתיבה

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

 בקשה משרת proxy

system

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

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

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

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

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

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

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

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

 בקשה משרת proxy
system.time String לקריאה בלבד

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

הערך הזה הוא ייצוג המחרוזת של הערך המתאים של system.timestamp. לדוגמה, התאריך Wed, 21 Aug 2013 19:16:47 GMT תואם לערך חותמת הזמן 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 String לקריאה בלבד

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

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

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

 בקשה משרת proxy
system.uuid String לקריאה בלבד

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

 בקשה משרת proxy

target

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

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

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

נתיב המשאב (לא כולל הדומיין) לשירות היעד, לא כולל פרמטרים של שאילתות, שמוגדר ב-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 String לקריאה בלבד

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

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

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

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

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

 תשובה ליעד
target.evaluated.url String קריאה/כתיבה

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

אפשר להשתמש במדיניות JavaScript או במדיניות AssignMessage שמשתמשת ברכיב AssignVariable כדי להגדיר את המשתנה הזה. מצרפים את המדיניות לזרימת הבקשות של TargetEndpoint.

 בקשת טירגוט
target.expectedcn String קריאה/כתיבה

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

 בקשה משרת proxy
target.header.host String קריאה/כתיבה

משתנה ה-flow שמשמש את Apigee להגדרת ערך הכותרת Host של הבקשה היוצאת ליעד. הפרמטר הזה משמש להגדרת הערך כשם מארח במצבים שבהם נעשה שימוש בכתובת IP בכתובת היעד או בשרת היעד, כמו במקרה של יעד שמבוסס על נקודת קצה של PSC.

 בקשת טירגוט
target.host String לקריאה בלבד

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

השעה, בפורמט מחרוזת, שבה התחיל 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 String לקריאה בלבד

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

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

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

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

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

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

השעה, בפורמט מחרוזת, שבה שרת ה-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 String לקריאה בלבד

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

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

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

אפשר להשתמש במדיניות JavaScript או במדיניות AssignMessage שמשתמשת ברכיב AssignVariable כדי להגדיר את המשתנה הזה. מצרפים את המדיניות לזרימת הבקשות של TargetEndpoint.

 בקשת טירגוט

variable

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

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

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

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

 בקשה משרת proxy

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