คุณกำลังดูเอกสารประกอบของ 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
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
apigee.metrics.policy.policy_name.timeTaken |
จำนวนเต็ม | อ่านอย่างเดียว | เวลาที่นโยบายใช้ในหน่วยนาโนวินาที | นโยบาย |
apiproxy
อธิบายพร็อกซี API
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร apiproxy
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
apiproxy.name |
สตริง | อ่านอย่างเดียว | ชื่อของพร็อกซี API เช่น "พร็อกซีของฉัน" | คำขอพร็อกซี |
apiproxy.revision |
สตริง | อ่านอย่างเดียว | หมายเลขการแก้ไขของพร็อกซี API เช่น "6" | คำขอพร็อกซี |
ดูข้อมูลเพิ่มเติมเกี่ยวกับการทำงานกับพร็อกซี API ได้ที่การทำความเข้าใจ API และพร็อกซี API
application
คอนเทนเนอร์สำหรับพร็อพเพอร์ตี้ application.basepath
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร application
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
application.basepath |
สตริง | อ่านอย่างเดียว | เส้นทางฐานการทำให้ใช้งานได้ (ระบุระหว่างการติดตั้งใช้งาน API) | คำขอพร็อกซี |
client
แอปพลิเคชันหรือระบบที่ส่งคำขอไปยังเราเตอร์ Edge
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร client
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
client.cn |
สตริง | อ่านอย่างเดียว |
ชื่อทั่วไปที่ระบุในใบรับรอง TLS/SSL ที่แอปไคลเอ็นต์แสดง |
คำขอพร็อกซี |
client.country |
สตริง | อ่านอย่างเดียว |
ประเทศในใบรับรอง TLS/SSL ที่แอปไคลเอ็นต์แสดง |
คำขอพร็อกซี |
client.email.address |
สตริง | อ่านอย่างเดียว |
อีเมลในใบรับรอง TLS/SSL ที่แอปไคลเอ็นต์แสดง |
คำขอพร็อกซี |
client.host |
สตริง | อ่านอย่างเดียว |
IP โฮสต์ HTTP ที่เชื่อมโยงกับคำขอที่ ProxyEndpoint ได้รับ |
คำขอพร็อกซี |
client.ip |
สตริง | อ่านอย่างเดียว |
ที่อยู่ IP ของไคลเอ็นต์หรือระบบที่ส่งข้อความไปยังเราเตอร์ Edge เช่น อาจเป็น IP ไคลเอ็นต์เดิมหรือ IP ของตัวจัดสรรภาระงาน |
คำขอพร็อกซี |
client.locality |
สตริง | อ่านอย่างเดียว |
ย่าน (เมือง) ในใบรับรอง TLS/SSL ที่ไคลเอ็นต์แสดง |
คำขอพร็อกซี |
client.organization |
สตริง | อ่านอย่างเดียว | องค์กรในใบรับรอง TLS/SSL ที่ไคลเอ็นต์แสดง (ไม่จำเป็นต้องเทียบเท่ากับองค์กรใน Apigee Edge) | คำขอพร็อกซี |
client.organization.unit |
สตริง | อ่านอย่างเดียว |
หน่วยขององค์กรในใบรับรอง TLS/SSL ที่ไคลเอ็นต์แสดง |
คำขอพร็อกซี |
client.port |
จำนวนเต็ม | อ่านอย่างเดียว |
พอร์ต HTTP ที่เชื่อมโยงกับคำขอของไคลเอ็นต์ต้นทางที่ส่งไปยัง ProxyEndpoint |
คำขอพร็อกซี |
client.received.end.time |
สตริง | อ่านอย่างเดียว |
เวลา ซึ่งแสดงในรูปแบบสตริง ที่พร็อกซีได้รับคำขอจากไคลเอ็นต์ต้นทางที่ ProxyEndpoint เสร็จสิ้นแล้ว เช่น วันพุธที่ 21 ส.ค. 2013 เวลา 19:16:47 น. UTC ค่าเวลานี้คือการแสดงสตริงของจำนวนการประทับเวลา 32 บิตที่เกี่ยวข้อง ตัวอย่างเช่น "Wed, 21 Aug 2013 19:16:47 UTC" จะสอดคล้องกับค่าการประทับเวลา 1377112607413 |
คำขอพร็อกซี |
client.received.end.timestamp |
ยาว | อ่านอย่างเดียว |
ค่าการประทับเวลาที่ระบุเมื่อพร็อกซีได้รับคำขอจากไคลเอ็นต์ต้นทางที่ ProxyEndpoint เสร็จสิ้นแล้ว ค่านี้เป็นจำนวนเต็ม 64 บิต (ยาว) ที่มีจำนวนมิลลิวินาทีที่ผ่านไปตั้งแต่เที่ยงคืนของวันที่ 1 มกราคม 1970 ตามเขตเวลา UTC |
คำขอพร็อกซี |
client.received.start.time |
สตริง | อ่านอย่างเดียว |
เวลาซึ่งแสดงในรูปแบบสตริงที่พร็อกซีเริ่มได้รับคำขอจากไคลเอ็นต์ต้นทางที่ ProxyEndpoint เช่น วันพุธที่ 21 ส.ค. 2013 เวลา 19:16:47 น. UTC ค่าเวลานี้คือการแสดงสตริงของจำนวนการประทับเวลา 32 บิตที่เกี่ยวข้อง ตัวอย่างเช่น "Wed, 21 Aug 2013 19:16:47 UTC" จะสอดคล้องกับค่าการประทับเวลา 1377112607413 |
คำขอพร็อกซี |
client.received.start.timestamp |
ยาว | อ่านอย่างเดียว |
ค่าการประทับเวลาที่ระบุเวลาที่พร็อกซีเริ่มได้รับคำขอจากไคลเอ็นต์ต้นทางที่ ProxyEndpoint ค่านี้เป็นจำนวนเต็ม 64 บิต (ยาว) ที่มีจำนวนมิลลิวินาทีที่ผ่านไปตั้งแต่เที่ยงคืนของวันที่ 1 มกราคม 1970 ตามเขตเวลา UTC |
คำขอพร็อกซี |
client.scheme |
สตริง | อ่านอย่างเดียว |
แสดงผล http หรือ https โดยขึ้นอยู่กับการรับส่งที่แอปไคลเอ็นต์ใช้เพื่อส่ง ข้อความคำขอ |
คำขอพร็อกซี |
client.sent.end.time |
สตริง | อ่านอย่างเดียว |
เวลาซึ่งแสดงในรูปแบบสตริงที่พร็อกซีส่งการตอบสนองจาก ProxyEndpoint ไปยังไคลเอ็นต์จนเสร็จสิ้น ตัวอย่างเช่น "Wed, 21 Aug 2013 19:16:47 UTC" ค่านี้คือแทนสตริงของ |
PostClientFlow |
client.sent.end.timestamp |
ยาว | อ่านอย่างเดียว | ค่าการประทับเวลาที่ระบุเมื่อ ProxyEndpoint ส่งคืนการตอบกลับไปยังแอปไคลเอ็นต์เริ่มต้นเสร็จแล้ว ค่านี้เป็นจำนวนเต็ม 64 บิต (ยาว) ที่มีจำนวนมิลลิวินาทีที่ผ่านไปนับตั้งแต่เที่ยงคืนของวันที่ 1 มกราคม 1970 ตามเขตเวลา UTC | PostClientFlow |
client.sent.start.time |
สตริง | อ่านอย่างเดียว | เวลาที่แสดงในรูปแบบสตริง เมื่อ ProxyEndpoint เริ่มแสดงการตอบกลับไปยังแอปไคลเอ็นต์ต้นทาง เช่น "Wed, 21 Aug 2013 19:16:47 UTC"
ค่านี้คือแทนสตริงของ |
PostClientFlow |
client.sent.start.timestamp |
ยาว | อ่านอย่างเดียว | เมื่อพร็อกซีเริ่มส่งการตอบสนองไปยังไคลเอ็นต์จาก ProxyEndpoint ค่านี้แสดงเป็นจำนวนเต็ม 64 บิต (ยาว) ที่มีจำนวนมิลลิวินาทีที่ผ่านไปนับตั้งแต่เที่ยงคืนของวันที่ 1 มกราคม 1970 ตามเขตเวลา UTC | PostClientFlow |
client.ssl.enabled |
สตริง | อ่านอย่างเดียว |
"true" หากมีการกำหนดค่า ProxyEndpoint สำหรับ TLS/SSL มิเช่นนั้นจะเป็น "false" |
คำขอพร็อกซี |
client.state |
สตริง | อ่านอย่างเดียว |
สถานะในใบรับรอง TLS/SSL ที่ไคลเอ็นต์แสดง |
คำขอพร็อกซี |
current
มีข้อมูลเกี่ยวกับโฟลว์พร็อกซี API ปัจจุบัน
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร current
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
current.flow.name |
สตริง | อ่านอย่างเดียว | ชื่อของโฟลว์ที่กำลังดำเนินการ (เช่น "PreFlow", "PostFlow" หรือชื่อของโฟลว์แบบมีเงื่อนไข) | คำขอพร็อกซี |
current.flow.description |
สตริง | อ่านอย่างเดียว | คำอธิบายของขั้นตอนการดำเนินการในปัจจุบัน ซึ่งเหมือนกับค่าขององค์ประกอบ <Description> ในการกำหนดค่า XML ของโฟลว์ |
คำขอพร็อกซี |
คุณสามารถดูคุณสมบัติเหล่านี้ได้ในมุมมองการติดตามของ Edge UI อย่างไรก็ตาม พร็อพเพอร์ตี้เหล่านี้จะไม่ปรากฏโดยค่าเริ่มต้นในมุมมองการติดตามของ UI แบบคลาสสิก
environment
คอนเทนเนอร์สำหรับพร็อพเพอร์ตี้ environment.name
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร environment
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
environment.name |
สตริง | อ่านอย่างเดียว | ชื่อของสภาพแวดล้อมที่ธุรกรรมทำงาน | คำขอพร็อกซี |
error
ออบเจ็กต์บริบทที่แสดงข้อความแสดงข้อผิดพลาดในขั้นตอนข้อผิดพลาด
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร error
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
error |
message |
อ่าน/เขียน | ข้อผิดพลาดของประเภท message ซึ่งเป็นออบเจ็กต์บริบทในโฟลว์ข้อผิดพลาด |
ข้อผิดพลาด |
error.content |
สตริง | อ่าน/เขียน | เนื้อหาของข้อผิดพลาด | ข้อผิดพลาด |
error.message |
สตริง | อ่านอย่างเดียว |
ข้อความที่เกี่ยวข้องกับข้อผิดพลาด ซึ่งมีค่าพร้อมใช้งานก่อนเรียกใช้โฟลว์ข้อผิดพลาดเท่านั้น |
ข้อผิดพลาด |
error.status.code |
จำนวนเต็ม | อ่านอย่างเดียว |
รหัสสถานะ HTTP ที่เชื่อมโยงกับข้อผิดพลาด เช่น "400" |
ข้อผิดพลาด |
error.reason.phrase |
สตริง | อ่านอย่างเดียว |
วลีเหตุผลที่เชื่อมโยงกับข้อผิดพลาด ตัวอย่างเช่น "คำขอไม่ถูกต้อง" |
ข้อผิดพลาด |
error.transport.message |
TransportMessage | อ่านอย่างเดียว |
ข้อผิดพลาดประเภท TransportMessage |
ข้อผิดพลาด |
error.state |
จำนวนเต็ม | อ่านอย่างเดียว |
สถานะในโฟลว์ที่เกิดข้อผิดพลาด |
ข้อผิดพลาด |
error.header.header_name |
สตริง | อ่าน/เขียน |
รับหรือตั้งค่าส่วนหัวการตอบกลับ |
ข้อผิดพลาด |
fault
ตัวแปรโฟลว์ที่ตั้งค่าเป็นรหัสข้อผิดพลาดของรันไทม์เมื่อนโยบายแสดงข้อผิดพลาด ค่ารหัสข้อผิดพลาดเป็นค่าของนโยบายแต่ละรายการ
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
fault.fault_name |
สตริง | อ่านอย่างเดียว | fault_name คือชื่อของข้อผิดพลาด ตามที่อธิบายไว้ในตารางข้อผิดพลาดเกี่ยวกับรันไทม์ที่รวมอยู่ในหัวข้อข้อมูลอ้างอิงนโยบายแต่ละรายการ | ข้อผิดพลาด |
is
คอนเทนเนอร์สำหรับพร็อพเพอร์ตี้ is.error
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร is
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
is.error |
บูลีน | อ่านอย่างเดียว |
การแจ้งข้อผิดพลาด |
คำขอพร็อกซี |
loadbalancing
ระบุข้อมูลเกี่ยวกับสถานะการจัดสรรภาระงานของ TargetEndpoint
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร loadbalancing
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
loadbalancing.failedservers |
อาร์เรย์ของสตริง | อ่านอย่างเดียว |
รายการ TargetServers ที่ล้มเหลวระหว่างการจัดสรรภาระงานที่ TargetEndpoint |
คำตอบเป้าหมาย |
loadbalancing.isfallback |
บูลีน | อ่านอย่างเดียว |
"true" หากเปิดใช้โฆษณาสำรองสำหรับ TargetServer ซึ่งเกิดขึ้นในระหว่างการจัดสรรภาระงานที่ TargetEndpoint |
คำตอบเป้าหมาย |
loadbalancing.targetserver |
สตริง | อ่านอย่างเดียว |
มีการเรียกใช้ TargetServer ในระหว่างการจัดสรรภาระงานที่ TargetEndpoint ตั้งค่าต่อเมื่อมีการตั้งค่าองค์ประกอบ |
คำตอบเป้าหมาย |
message
ออบเจ็กต์บริบทที่มีค่าเดียวกับ request
ในขั้นตอนการส่งคําขอ หรือกับ response
ในขั้นตอนการตอบกลับหรือเป็น error
ในขั้นตอนข้อผิดพลาด
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร message
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
message |
message |
อ่าน/เขียน |
ออบเจ็กต์บริบทที่มีค่าเดียวกับ |
คำขอพร็อกซี |
message.content |
สตริง | อ่าน/เขียน |
เนื้อหาของคำขอ การตอบกลับ หรือข้อความแสดงข้อผิดพลาด |
คำขอพร็อกซี |
message.formparam.param_name |
สตริง | อ่าน/เขียน |
ค่าของพารามิเตอร์แบบฟอร์มที่ระบุ |
คำขอพร็อกซี |
message.formparam.param_name. |
คอลเล็กชัน | อ่านอย่างเดียว |
ค่าทั้งหมดของพารามิเตอร์แบบฟอร์มที่ระบุในข้อความ |
คำขอพร็อกซี |
message.formparam.param_name. |
จำนวนเต็ม | อ่านอย่างเดียว |
จำนวนค่าของพารามิเตอร์แบบฟอร์มที่ระบุในข้อความ/p> |
คำขอพร็อกซี |
message.formparams.count |
จำนวนเต็ม | อ่านอย่างเดียว |
จำนวนพารามิเตอร์ของฟอร์มทั้งหมดในข้อความ |
คำขอพร็อกซี |
message.formparams.names |
คอลเล็กชัน | อ่านอย่างเดียว |
ค่าของพารามิเตอร์แบบฟอร์มทั้งหมดในข้อความ |
คำขอพร็อกซี |
message.formstring |
สตริง | อ่านอย่างเดียว |
ค่าของสตริงแบบฟอร์มในข้อความ |
คำขอพร็อกซี |
message.header.header_name |
สตริง | อ่าน/เขียน |
รับหรือตั้งค่าส่วนหัว HTTP ที่ระบุในข้อความ หากส่วนหัวมีคอมมา เมื่ออ่านแล้ว คุณจะได้รับเฉพาะส่วนของข้อความจนถึงคอมมาแรก หากต้องการทั้งส่วนหัว ให้ใช้รูปแบบ |
คำขอพร็อกซี |
message.header.header_name.N |
สตริง | อ่าน/เขียน |
ค่าของส่วนหัวเฉพาะใน Nth ในข้อความ ซึ่งอาจเป็นคำขอหรือการตอบกลับก็ได้ ทั้งนี้ขึ้นอยู่กับสถานะของโฟลว์ Apigee Edge จะแยกค่าข้อความส่วนหัวด้วยคอมมา โปรดทราบว่าดัชนีที่ใช้สำหรับ N จะเป็นแบบ 1 ไม่ใช่ฐาน 0 ตัวอย่างเช่น หากส่วนหัว |
คำขอพร็อกซี |
message.header.header_name. |
คอลเล็กชัน | อ่านอย่างเดียว |
ค่าทั้งหมดของชื่อส่วนหัว HTTP ที่ระบุในข้อความ |
คำขอพร็อกซี |
message.header.header_name. |
จำนวนเต็ม | อ่านอย่างเดียว |
จำนวนค่าของชื่อส่วนหัว HTTP ที่ระบุในข้อความ |
คำขอพร็อกซี |
message.headers.count |
จำนวนเต็ม | อ่านอย่างเดียว |
จำนวนส่วนหัว HTTP ทั้งหมดในข้อความ |
คำขอพร็อกซี |
message.headers.names |
คอลเล็กชัน | อ่านอย่างเดียว |
ค่าของส่วนหัว HTTP ทั้งหมดในข้อความ |
คำขอพร็อกซี |
message.path |
สตริง | อ่าน/เขียน |
เส้นทางข้อความคำขอที่สมบูรณ์ใน URL โดยยกเว้นพารามิเตอร์การค้นหา |
คำขอพร็อกซี |
message.queryparam.param_name |
สตริง | อ่านอย่างเดียว |
แสดงผลพารามิเตอร์การค้นหาของข้อความที่ระบุ |
คำขอพร็อกซี |
message.queryparam.param_name.N |
สตริง | อ่าน/เขียน |
ค่าของพารามิเตอร์การค้นหา Nth ในข้อความ เช่น หาก ตัวอย่างการเขียนค่าหลายค่าสำหรับชื่อพารามิเตอร์การค้นหาเดียว เช่น "type=siteid:1&type=language:us-en&type=currency:USD" ให้ตั้งค่าต่อไปนี้
|
คำขอพร็อกซี |
message.queryparam.param_name. |
คอลเล็กชัน | อ่านอย่างเดียว |
ค่าทั้งหมดของพารามิเตอร์การค้นหาหนึ่งๆ ในข้อความ โดยอยู่ในรูปแบบรายการที่คั่นด้วยคอมมา เช่น หากสตริงการค้นหาคือ |
คำขอพร็อกซี |
message.queryparam.param_name. |
จำนวนเต็ม | อ่านอย่างเดียว |
จำนวนพารามิเตอร์การค้นหาที่ระบุทั้งหมดซึ่งเชื่อมโยงกับคำขอที่ส่งไปยัง ProxyEndpoint จากแอปไคลเอ็นต์ |
คำขอพร็อกซี |
message.queryparams.count |
จำนวนเต็ม | อ่านอย่างเดียว |
จำนวนพารามิเตอร์การค้นหาทั้งหมดที่เชื่อมโยงกับคำขอที่ส่งไปยัง ProxyEndpoint จากแอปไคลเอ็นต์ |
คำขอพร็อกซี |
message.queryparams.names |
คอลเล็กชัน | อ่านอย่างเดียว |
รายการชื่อพารามิเตอร์การค้นหาทั้งหมดที่เชื่อมโยงกับคำขอที่ส่งไปยัง ProxyEndpoint จากแอปไคลเอ็นต์ หากต้องการทำซ้ำชื่อพารามิเตอร์การค้นหาโดยใช้ JavaScript ให้ดูโพสต์ชุมชน Apigee ต่อไปนี้ คุณจะทำซ้ำคอลเล็กชันจาก "request.queryparams.names" ใน JS ได้อย่างไร ในชุมชน Apigee |
คำขอพร็อกซี |
message.querystring |
สตริง | อ่านอย่างเดียว |
สตริงที่มีชื่อและค่าของพารามิเตอร์การค้นหาทั้งหมดซึ่งเชื่อมโยงกับคำขอที่ส่งไปยัง ProxyEndpoint จากแอปไคลเอ็นต์ เช่น สำหรับคำขอ "http://api.apifactory.com/teacherors?name=nick&surname=danger" ค่าของ |
คำขอพร็อกซี |
message.reason.phrase |
สตริง | อ่านอย่างเดียว |
REASON Phrase ของข้อความตอบกลับจากเป้าหมาย |
คำตอบเป้าหมาย |
message.status.code |
จำนวนเต็ม | อ่านอย่างเดียว |
รหัสสถานะ HTTP ของข้อความตอบกลับจากปลายทาง |
คำตอบเป้าหมาย |
message.transport.message |
TransportMessage | อ่านอย่างเดียว |
ข้อความประเภท TransportMessage ซึ่งเป็นออบเจ็กต์ตามบริบท |
คำขอพร็อกซี |
message.uri |
สตริง | อ่านอย่างเดียว |
เส้นทาง URI ที่สมบูรณ์ (ตามหลัง URL ของโดเมน) รวมถึงพารามิเตอร์การค้นหา ตัวอย่างเช่น สำหรับคำขอ "http://api.apifactory.com/recommendors?name=nikola&surname=tesla" ตัวแปรนี้จะแสดงผลเป็น "recommendors?name=nikola&surname=tesla" |
คำขอพร็อกซี |
message.verb |
สตริง | อ่านอย่างเดียว |
คำกริยา HTTP ( |
คำขอพร็อกซี |
message.version |
สตริง | อ่าน/เขียน |
เวอร์ชัน HTTP ที่เชื่อมโยงกับคำขอที่ส่งไปยัง ProxyEndpoint จากแอปพลิเคชันไคลเอ็นต์ |
คำขอพร็อกซี |
ดูข้อมูลเพิ่มเติมเกี่ยวกับข้อความได้ที่ข้อมูลอ้างอิงฟังก์ชันของเทมเพลตข้อความ
messageid
คอนเทนเนอร์ของรหัสที่ไม่ซ้ำกันทั่วโลกสำหรับคำขอ
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร messageid
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
messageid |
สตริง | อ่านอย่างเดียว |
เก็บรหัสที่ไม่ซ้ำกันส่วนกลางสำหรับคำขอ ซึ่งรวมถึงชื่อโฮสต์ของเราเตอร์ รหัสนี้อนุญาตให้มีการติดตามคำขอที่ได้รับจากเราเตอร์หลังจากที่ส่งไปยังผู้ประมวลผลข้อความแล้ว ระบบจะบันทึกรหัสนี้ในบันทึกข้อผิดพลาดของ Edge เพื่อเชื่อมโยง |
คำขอพร็อกซี |
organization
คอนเทนเนอร์สำหรับพร็อพเพอร์ตี้ organization.name
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร organization
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
organization.name |
สตริง | อ่านอย่างเดียว |
ชื่อองค์กร |
คำขอพร็อกซี |
ดูข้อมูลเพิ่มเติมเกี่ยวกับองค์กรได้ที่การทำความเข้าใจองค์กร
proxy
การกำหนดค่าพร็อกซี API
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร proxy
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
proxy.basepath |
สตริง | อ่านอย่างเดียว |
ค่าของเส้นทางฐานในการกำหนดค่าพร็อกซี API เส้นทางฐานคือส่วนย่อย URI ที่ติดตามโฮสต์ใน URL URI ของโฟลว์ตามเงื่อนไขเป็นไปตามเส้นทางฐาน ใน URL "http://myorg-test.apigee.net/v2/weatherapi/forecastrss?w=12797282"
วิธีเดียวที่คุณจะทราบเรื่องนี้คือการดูคำจำกัดความของพร็อกซี API หรือตรวจสอบค่าของตัวแปรพร็อกซี.basepath คำต่อท้ายของเส้นทางพร็อกซีจะอยู่หลังเส้นทางฐาน ("/forecastrss") ควบคู่ไปกับพารามิเตอร์การค้นหา หากคุณกำหนดเส้นทางฐานแบบไดนามิกในการกำหนดค่าพร็อกซี API เช่น "/v2/*/weatherapi" ระบบจะตั้งค่าตัวแปรนี้เป็นเส้นทางแบบไดนามิก ("/v2/*/weatherapi") แม้ว่าเส้นทางฐานจะแปลงเป็นค่าคงที่ เช่น "/v2/foo/weatherapi" |
คำขอพร็อกซี |
proxy.client.ip |
สตริง | อ่านอย่างเดียว |
ที่อยู่ |
คำขอพร็อกซี |
proxy.name |
สตริง | อ่านอย่างเดียว |
แอตทริบิวต์ชื่อที่กำหนดค่าไว้สำหรับ ProxyEndpoint |
คำขอพร็อกซี |
proxy.pathsuffix |
สตริง | อ่านอย่างเดียว |
ค่าของคำต่อท้ายฐานของพร็อกซี API ที่ส่งจากไคลเอ็นต์และได้รับที่ ProxyEndpoint เส้นทางพื้นฐานคือคอมโพเนนต์เส้นทางที่ระบุพร็อกซี API ที่ไม่ซ้ำกัน URL ที่เปิดเผยต่อสาธารณะของพร็อกซี API ประกอบด้วยชื่อองค์กร, สภาพแวดล้อมที่ทำให้พร็อกซีใช้งานได้, เส้นทางพื้นฐาน, คำต่อท้าย Basepath และพารามิเตอร์การค้นหา เช่น ในคำขอที่ส่งไปยัง |
คำขอพร็อกซี |
proxy.url |
สตริง | อ่านอย่างเดียว |
รับ URL ที่สมบูรณ์ที่เชื่อมโยงกับคำขอพร็อกซีที่ ProxyEndpoint รวมถึงพารามิเตอร์การค้นหาที่แสดง
โฮสต์ของ URL จะเป็น สำหรับตัวอย่างที่สร้าง URL |
คำขอพร็อกซี |
ดูข้อมูลเพิ่มเติมเกี่ยวกับการทำงานกับพร็อกซี API ได้ที่การทำความเข้าใจ API และพร็อกซี API
request
คำขอที่สมบูรณ์ รวมถึงเปย์โหลดที่มีอยู่
ดูรายละเอียดเพิ่มเติมเกี่ยวกับข้อมูลคำขอได้ที่ข้อมูลคำขอมีการส่งไปยังเซิร์ฟเวอร์แบ็กเอนด์อย่างไร
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร request
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
request |
message |
อ่านอย่างเดียว |
คำขอที่สมบูรณ์ รวมถึงเปย์โหลดที่มีอยู่ |
คำขอพร็อกซี |
request.content |
สตริง | อ่าน/เขียน |
รับหรือตั้งค่าเพย์โหลดของข้อความคำขอ |
คำขอพร็อกซี |
request.formparam.param_name |
สตริง | อ่าน/เขียน |
รับหรือตั้งค่าพารามิเตอร์แบบฟอร์มที่ระบุในคำขอที่ส่งจากแอปพลิเคชันไคลเอ็นต์ |
คำขอพร็อกซี |
request.formparam.param_name. |
คอลเล็กชัน | อ่านอย่างเดียว |
ค่าทั้งหมดของพารามิเตอร์แบบฟอร์มหนึ่งๆ ในคำขอ โดยอยู่ในรูปแบบรายการที่คั่นด้วยคอมมา เช่น หากเพย์โหลดคือ "a=hello&x=greeting&a=world" ค่าของ |
คำขอพร็อกซี |
request.formparam.param_name. |
จำนวนเต็ม | อ่านอย่างเดียว |
จำนวนค่าทั้งหมดสำหรับพารามิเตอร์แบบฟอร์มที่ระบุซึ่งเชื่อมโยงกับคำขอ |
คำขอพร็อกซี |
request.formparam.param_name.N |
สตริง | อ่าน/เขียน |
ค่าของพารามิเตอร์รูปแบบเฉพาะ Nth ในข้อความ เช่น หากสตริงของแบบฟอร์มคือ "a=hello&a=world" ค่าที่ส่งคืนของ |
คำขอพร็อกซี |
request.formparams.count |
จำนวนเต็ม | อ่านอย่างเดียว |
จำนวนพารามิเตอร์ของแบบฟอร์มทั้งหมดที่เชื่อมโยงกับคำขอที่ส่งจากแอปพลิเคชันไคลเอ็นต์ |
คำขอพร็อกซี |
request.formparams.names |
คอลเล็กชัน | อ่านอย่างเดียว |
รายการชื่อพารามิเตอร์ของแบบฟอร์มทั้งหมดที่เชื่อมโยงกับคำขอ |
คำขอพร็อกซี |
request.formstring |
สตริง | อ่านอย่างเดียว |
เช่น "name=test&type=first&group=A" |
คำขอพร็อกซี |
request.header.header_name |
สตริง | อ่าน/เขียน |
รับหรือตั้งค่าของส่วนหัวหนึ่งๆ ที่พบในคำขอ หากส่วนหัวมีคอมมา เมื่ออ่านแล้ว คุณจะได้รับเฉพาะส่วนของข้อความจนถึงคอมมาแรก หากต้องการทั้งส่วนหัว ให้ใช้รูปแบบ |
คำขอพร็อกซี |
request.header.header_name.N |
สตริง | อ่าน/เขียน |
ค่าของค่าส่วนหัวเฉพาะ Nth ในคำขอ Apigee Edge จะแยกค่าข้อความส่วนหัวด้วยคอมมา โปรดทราบว่าดัชนีที่มีค่าซึ่งใช้สำหรับ N จะเป็นแบบ 1 ไม่ใช่ฐาน 0 ตัวอย่างเช่น หากส่วนหัว |
คำขอพร็อกซี |
request.header.header_name. |
คอลเล็กชัน | อ่านอย่างเดียว |
ค่าทั้งหมดของส่วนหัวหนึ่งๆ ในคำขอ |
คำขอพร็อกซี |
request.header.header_name. |
จำนวนเต็ม | อ่านอย่างเดียว |
จำนวนค่าทั้งหมดของส่วนหัวหนึ่งๆ ในคำขอ |
คำขอพร็อกซี |
request.headers.count |
จำนวนเต็ม | อ่านอย่างเดียว |
จำนวนส่วนหัวทั้งหมดในคำขอ |
คำขอพร็อกซี |
request.headers.names |
คอลเล็กชัน | อ่านอย่างเดียว |
ชื่อของส่วนหัวทั้งหมดในคำขอ |
คำขอพร็อกซี |
request.path |
สตริง | อ่านอย่างเดียว |
เส้นทางทรัพยากรที่ไม่ผ่านพร็อกซี (ไม่รวมโฮสต์) ไปยังบริการแบ็กเอนด์ โดยไม่รวมพารามิเตอร์การค้นหา เช่น URI ไปยังบริการแบ็กเอนด์คือ "https://example.com/rest/api/latest" ค่าของ |
คำขอพร็อกซี |
request.queryparam.param_name |
สตริง | อ่าน/เขียน |
ค่าของพารามิเตอร์การค้นหาหนึ่งๆ ที่พบในคําขอ |
คำขอพร็อกซี |
request.queryparam.param_name.N |
สตริง | อ่าน/เขียน |
ค่าของพารามิเตอร์การค้นหา Nth ในคำขอ เช่น หาก ตัวอย่างการเขียนค่าหลายค่าสำหรับชื่อพารามิเตอร์การค้นหาเดียว เช่น "type=siteid:1&type=language:us-en&type=currency:USD" ให้ตั้งค่าต่อไปนี้
|
คำขอพร็อกซี |
request.queryparam.param_name. |
คอลเล็กชัน | อ่านอย่างเดียว |
ค่าทั้งหมดของพารามิเตอร์การค้นหาหนึ่งๆ ในคำขอ โดยอยู่ในรูปแบบรายการที่คั่นด้วยคอมมา เช่น หาก |
คำขอพร็อกซี |
request.queryparam.param_name. |
จำนวนเต็ม | อ่านอย่างเดียว |
จำนวนค่าทั้งหมดของพารามิเตอร์การค้นหาหนึ่งๆ ในคำขอ |
คำขอพร็อกซี |
request.queryparams.count |
จำนวนเต็ม | อ่านอย่างเดียว |
จำนวนพารามิเตอร์การค้นหาทั้งหมดในคำขอ |
คำขอพร็อกซี |
request.queryparams.names |
คอลเล็กชัน | อ่านอย่างเดียว |
ชื่อของพารามิเตอร์การค้นหาทั้งหมดในคำขอ หากต้องการทำซ้ำชื่อพารามิเตอร์การค้นหาโดยใช้ JavaScript โปรดดู วิธีทำซ้ำคอลเล็กชันจาก "request.queryparams.names" ใน JS ในชุมชน Apigee |
คำขอพร็อกซี |
request.querystring |
สตริง | อ่านอย่างเดียว |
รายการพารามิเตอร์การค้นหาทั้งหมดในคำขอที่ส่งจากแอปไคลเอ็นต์ เช่น หากคำขอคือ "http://host.com/123?name=first&surname=second&place=address" ตัวแปรนี้จะแสดงผล "name=first&surname=second&place=address" |
คำขอพร็อกซี |
request.transportid |
สตริง | อ่านอย่างเดียว |
รหัสของคำขอเป็นประเภท TransportMessage ซึ่งเป็นออบเจ็กต์ตามบริบท |
คำขอพร็อกซี |
request.transport.message |
ส่งข้อความ | อ่านอย่างเดียว |
คำขอประเภท TransportMessage ซึ่งเป็นออบเจ็กต์ Contexual |
คำขอพร็อกซี |
request.uri |
สตริง | อ่านอย่างเดียว |
ในพร็อกซี API พร็อกซี
ชี้ไปที่
ในคำขอ ในการตอบสนอง สิ่งที่เปลี่ยนไปคือเพราะคำขอเดิมเข้ามาในพร็อกซี แต่จากนั้นพร็อกซีส่งคำขออีกครั้งไปยังบริการเป้าหมาย สมมติว่ามีการเรียกดังต่อไปนี้ไปยังพร็อกซีตัวอย่างของเรา ซึ่งมีเส้นทางฐานเป็น "/my-mock-proxy":
และพร็อกซีจะเรียก:
ข้อใดผนวก "/user?user=Dude" ต่อท้าย URL นั้น
|
คำขอพร็อกซี (การตอบกลับจะแตกต่างกัน) |
request.url |
สตริง | อ่านอย่างเดียว |
URL ที่สมบูรณ์ของคำขอที่ส่งไปยังปลายทางเป้าหมาย ซึ่งรวมถึงพารามิเตอร์สตริงการค้นหา แต่ไม่รวมหมายเลขพอร์ต (หากระบุ) ตัวอย่างเช่น หากคุณเรียกพร็อกซีตัวอย่าง "http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude" และปลายทางเป้าหมายคือ "http://example.com:8080" ค่าจะเป็นดังนี้
|
คำตอบเป้าหมาย |
request.verb |
สตริง | อ่านอย่างเดียว |
กริยา HTTP ที่ใช้สำหรับคำขอ เช่น "GET", "PUT" และ "DELETE" |
คำขอพร็อกซี |
request.version |
สตริง | อ่านอย่างเดียว |
เวอร์ชัน HTTP ของคำขอ เช่น "1.1" |
คำขอพร็อกซี |
response
การตอบสนองที่สมบูรณ์ รวมถึงเปย์โหลดที่มีอยู่
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร response
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
response |
message |
อ่าน/เขียน |
ข้อความตอบกลับที่สมบูรณ์ส่งคืนโดยเป้าหมาย |
คำตอบเป้าหมาย |
response.content |
สตริง | อ่าน/เขียน |
เนื้อหาเพย์โหลดของข้อความตอบกลับที่แสดงผลโดยเป้าหมาย |
คำตอบเป้าหมาย |
response.formparam.param_name |
สตริง | อ่าน/เขียน |
ค่าของพารามิเตอร์แบบฟอร์มในการตอบกลับ |
คำตอบเป้าหมาย |
response.formparam.param_name. |
จำนวนเต็ม | อ่านอย่างเดียว |
จำนวนค่าทั้งหมดของพารามิเตอร์แบบฟอร์มที่ระบุในการตอบสนอง |
คำตอบเป้าหมาย |
response.formparams.count |
จำนวนเต็ม | อ่านอย่างเดียว |
จำนวน PraMeter ทุกรูปแบบในคำตอบ |
คำตอบเป้าหมาย |
response.formparams.names |
คอลเล็กชัน | อ่านอย่างเดียว |
ชื่อของพารามิเตอร์ของแบบฟอร์มทั้งหมดในคำตอบ |
คำตอบเป้าหมาย |
response.header.header_name |
สตริง | อ่าน/เขียน |
รับหรือตั้งค่าส่วนหัว HTTP ที่ระบุในการตอบกลับ หากข้อความส่วนหัวมีเครื่องหมายจุลภาค Apigee Edge จะอนุมานค่าหลายค่า ในกรณีนี้ หากต้องการอ่านทั้งส่วนหัว ให้ใช้แบบฟอร์ม |
คำตอบเป้าหมาย |
response.header.header_name. |
คอลเล็กชัน | อ่านอย่างเดียว |
ค่าทั้งหมดของส่วนหัว HTTP ที่ระบุในการตอบสนอง |
คำตอบเป้าหมาย |
response.header.header_name. |
จำนวนเต็ม | อ่านอย่างเดียว |
จำนวนค่าทั้งหมดของส่วนหัว HTTP ที่ระบุในการตอบสนอง |
คำตอบเป้าหมาย |
response.header.header_name.N |
สตริง | อ่าน/เขียน |
ค่าของค่าส่วนหัวเฉพาะ Nth ในการตอบกลับ Apigee Edge จะแยกค่าข้อความส่วนหัวด้วยคอมมา โปรดทราบว่าดัชนีที่มีค่าซึ่งใช้สำหรับ N จะเป็นแบบ 1 ไม่ใช่ฐาน 0 เช่น หากส่วนหัว |
คำตอบเป้าหมาย |
response.headers.count |
จำนวนเต็ม | อ่านอย่างเดียว |
จำนวนส่วนหัวทั้งหมดในคำตอบ |
คำตอบเป้าหมาย |
response.headers.names |
คอลเล็กชัน | อ่านอย่างเดียว |
ชื่อของส่วนหัวทั้งหมดในคำตอบ |
คำตอบเป้าหมาย |
response.reason.phrase |
สตริง | อ่าน/เขียน |
ข้อความเหตุผลของการตอบกลับสำหรับคำขอหนึ่งๆ |
คำตอบเป้าหมาย |
response.status.code |
จำนวนเต็ม | อ่าน/เขียน |
โค้ดตอบกลับที่แสดงผลสำหรับคำขอ คุณใช้ตัวแปรนี้เพื่อลบล้างรหัสสถานะการตอบกลับซึ่งจัดเก็บไว้ใน |
คำตอบเป้าหมาย |
response.transport.message |
สตริง | อ่านอย่างเดียว |
การตอบสนองของประเภท TransportMessage ซึ่งเป็นอ็อบเจ็กต์ Contexual |
คำตอบเป้าหมาย |
route
ระบุชื่อของ <RouteRule>
และ TargetEndpoint
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร route
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
route.name |
สตริง | อ่านอย่างเดียว |
ชื่อของ |
คำขอเป้าหมาย |
route.target |
สตริง | อ่านอย่างเดียว |
ชื่อของ TargetEndpoint ที่ดำเนินการ เช่น "ค่าเริ่มต้น" |
คำขอเป้าหมาย |
router
คอนเทนเนอร์สำหรับพร็อพเพอร์ตี้ router.uuid
ซึ่งเลิกใช้งานแล้ว
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร router
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
router.uuid |
สตริง | อ่านอย่างเดียว |
เลิกใช้งานแล้วและแสดงผลเป็นค่าว่าง (เดิมคือ UUID ของเราเตอร์ที่จัดการพร็อกซี) |
คำขอพร็อกซี |
servicecallout
อธิบาย TargetEndpoint สำหรับนโยบาย ServiceAPI
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร servicecallout
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
servicecallout.policy_name.expectedcn |
สตริง | อ่าน/เขียน |
ชื่อทั่วไปที่คาดไว้ของ TargetEndpoint ตามที่ระบุไว้ในนโยบายนโยบาย ServiceAPI ซึ่งจะมีความหมายก็ต่อเมื่อ TargetEndpoint อ้างถึงปลายทาง TLS/SSL เท่านั้น |
คำขอพร็อกซี |
servicecallout.policy_name.target.url |
สตริง | อ่าน/เขียน |
URL TargetEndpoint สำหรับนโยบาย ServiceAPI ที่เฉพาะเจาะจง |
คำขอพร็อกซี |
servicecallout.requesturi |
สตริง | อ่าน/เขียน |
URI TargetEndpoint สำหรับนโยบายนโยบาย Serviceต้องระบุ URI คือ URL ของ TargetEndpoint ที่ไม่มีโปรโตคอลและโดเมน |
คำขอพร็อกซี |
system
ระบุที่อยู่ IP ของระบบและรายละเอียดเกี่ยวกับพร็อกซี
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร system
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
system.interface.interface_name |
สตริง | อ่านอย่างเดียว |
ที่อยู่ IP ของระบบ |
คำขอพร็อกซี |
system.pod.name |
สตริง | อ่านอย่างเดียว |
ชื่อของพ็อดที่พร็อกซีทำงานอยู่ |
คำขอพร็อกซี |
system.region.name |
สตริง | อ่านอย่างเดียว |
ชื่อของศูนย์ข้อมูล ภูมิภาคที่พร็อกซีทำงานอยู่ |
คำขอพร็อกซี |
system.time |
สตริง | อ่านอย่างเดียว |
เวลาที่อ่านตัวแปรนี้ เช่น "Wed, 21 Aug 2013 19:16:47 UTC" ค่านี้คือการแสดงสตริงของค่าที่เกี่ยวข้องของ |
คำขอพร็อกซี |
system.time.year |
จำนวนเต็ม | อ่านอย่างเดียว |
ส่วนปีของ |
คำขอพร็อกซี |
system.time.month |
จำนวนเต็ม | อ่านอย่างเดียว |
ส่วนของเดือน |
คำขอพร็อกซี |
system.time.day |
จำนวนเต็ม | อ่านอย่างเดียว |
ส่วนของวันของเดือน |
คำขอพร็อกซี |
system.time.dayofweek |
จำนวนเต็ม | อ่านอย่างเดียว |
วันของสัปดาห์ ส่วน |
คำขอพร็อกซี |
system.time.hour |
จำนวนเต็ม | อ่านอย่างเดียว |
ส่วนชั่วโมงของ |
คำขอพร็อกซี |
system.time.minute |
จำนวนเต็ม | อ่านอย่างเดียว |
ส่วนนาทีของ |
คำขอพร็อกซี |
system.time.second |
จำนวนเต็ม | อ่านอย่างเดียว |
ส่วนที่ 2 ของ |
คำขอพร็อกซี |
system.time.millisecond |
จำนวนเต็ม | อ่านอย่างเดียว |
ส่วนมิลลิวินาทีของ |
คำขอพร็อกซี |
system.time.zone |
สตริง | อ่านอย่างเดียว |
เขตเวลาของระบบ |
คำขอพร็อกซี |
system.timestamp |
ยาว | อ่านอย่างเดียว |
จำนวนเต็ม 64 บิต (ยาว) ซึ่งแสดงเวลาที่อ่านตัวแปรนี้ ค่านี้คือจำนวนมิลลิวินาทีที่ผ่านไปตั้งแต่เที่ยงคืนของวันที่ 1 มกราคม 1970 ตามเขตเวลา UTC เช่น "1534783015000" |
คำขอพร็อกซี |
system.uuid |
สตริง | อ่านอย่างเดียว |
UUID ของผู้ประมวลผลข้อความที่จัดการพร็อกซี |
คำขอพร็อกซี |
target
อธิบายเป้าหมายของคำขอ
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร target
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
target.basepath |
สตริง | อ่านอย่างเดียว |
เส้นทางทรัพยากร (ไม่รวมโดเมน) ไปยังบริการเป้าหมาย ซึ่งยกเว้นพารามิเตอร์การค้นหาที่กำหนดไว้ใน TargetEndpoint ของพร็อกซี ตัวอย่างเช่น สมมติว่าพร็อกซี API เรียกเป้าหมายต่อไปนี้
ในตัวอย่างนี้ หากเป้าหมายคือ:
|
คำขอเป้าหมาย |
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 เท่านั้น |
คำขอพร็อกซี |
target.host |
สตริง | อ่านอย่างเดียว |
ชื่อโดเมนของบริการเป้าหมายที่ส่งคืนการตอบกลับไปยังพร็อกซี API |
คำตอบเป้าหมาย |
target.ip |
สตริง | อ่านอย่างเดียว |
ที่อยู่ IP ของบริการเป้าหมายที่ส่งคืนการตอบกลับไปยังพร็อกซี API |
คำตอบเป้าหมาย |
target.locality |
สตริง | อ่านอย่างเดียว |
สถานที่ตั้ง (เมือง) ของใบรับรอง TLS/SSL ที่เซิร์ฟเวอร์เป้าหมายแสดง |
คำตอบเป้าหมาย |
target.name |
สตริง | อ่านอย่างเดียว |
กำหนดเป้าหมายไปยังข้อความที่เข้าถึงจาก targetendpoint |
คำขอเป้าหมาย |
target.organization |
สตริง | อ่านอย่างเดียว |
องค์กรของใบรับรอง TLS/SSL ที่เซิร์ฟเวอร์เป้าหมายแสดง |
คำตอบเป้าหมาย |
target.organization.unit |
สตริง | อ่านอย่างเดียว |
หน่วยขององค์กรของใบรับรอง TLS/SSL ที่เซิร์ฟเวอร์เป้าหมายแสดง |
คำตอบเป้าหมาย |
target.port |
จำนวนเต็ม | อ่านอย่างเดียว |
หมายเลขพอร์ตของบริการเป้าหมายที่ส่งคืนการตอบกลับไปยังพร็อกซี 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. |
ยาว | อ่านอย่างเดียว |
ค่าการประทับเวลาที่ระบุเมื่อ 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. |
ยาว | อ่านอย่างเดียว |
ค่าการประทับเวลาที่ระบุเมื่อ TargetEndpoint เริ่มได้รับการตอบสนองจากเป้าหมาย เช่น "1534783015000" ค่านี้เป็นจำนวนเต็ม 64 บิต (ยาว) ที่ระบุจำนวนมิลลิวินาทีที่ผ่านไปตั้งแต่เที่ยงคืนของวันที่ 1 มกราคม 1970 ตามเขตเวลา UTC |
คำตอบเป้าหมาย |
target.scheme |
สตริง | อ่านอย่างเดียว |
ขอบเขตเริ่มต้น: การตอบสนองเป้าหมาย แสดงผล http หรือ https ตามข้อความคำขอ |
คำขอเป้าหมาย |
target.sent.end.time |
สตริง | อ่านอย่างเดียว |
เวลา ซึ่งแสดงในรูปแบบสตริงที่พร็อกซีหยุดส่งคำขอไปยัง 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" ค่านี้เป็นจำนวนเต็ม 64 บิต (ยาว) ที่มีจำนวนมิลลิวินาทีที่ผ่านไปตั้งแต่เที่ยงคืนของวันที่ 1 มกราคม 1970 ตามเขตเวลา UTC |
คำขอเป้าหมาย |
target.sent.start.time |
สตริง | อ่านอย่างเดียว |
เวลาที่แสดงในรูปแบบสตริงที่พร็อกซีเริ่มส่งคำขอไปยัง URL ที่ระบุใน TargetEndpoint เช่น "Wed, 21 Aug 2013 19:16:47 UTC" ค่าเวลานี้คือการแสดงสตริงของจำนวนการประทับเวลา 32 บิตที่เกี่ยวข้อง เช่น "Wed, 21 Aug 2013 19:16:47 UTC" จะสอดคล้องกับค่าการประทับเวลาที่ "1377112607413" |
คำขอเป้าหมาย |
target.sent.start.timestamp |
ยาว | อ่านอย่างเดียว |
ค่าการประทับเวลาที่ระบุเมื่อพร็อกซีเริ่มส่งคำขอไปยัง URL ที่ระบุใน TargetEndpoint เช่น "1534783015000" ค่านี้เป็นจำนวนเต็ม 64 บิต (ยาว) ที่ระบุจำนวนมิลลิวินาทีที่ผ่านไปตั้งแต่เที่ยงคืนของวันที่ 1 มกราคม 1970 ตามเขตเวลา UTC |
คำขอเป้าหมาย |
target.ssl.enabled |
บูลีน | อ่านอย่างเดียว |
กำหนดว่า TargetEndpoint จะทำงานบน TLS/SSL หรือไม่ |
คำขอพร็อกซี |
target.state |
สตริง | อ่านอย่างเดียว |
สถานะของใบรับรอง TLS/SSL ที่เซิร์ฟเวอร์เป้าหมายแสดง |
คำตอบเป้าหมาย |
target.url |
สตริง | อ่าน/เขียน |
URL ที่กำหนดค่าในไฟล์ TargetEndpoint XML หรือ URL เป้าหมายแบบไดนามิก (หากตั้งค่า |
คำขอเป้าหมาย |
variable
คอนเทนเนอร์สำหรับพร็อพเพอร์ตี้ variable.expectedcn
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร variable
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
variable.expectedcn |
สตริง | อ่าน/เขียน |
ระบบแสดงตัวแปรสำหรับชื่อทั่วไปหากทำงานบน TLS/SSL |
คำขอพร็อกซี |
ดูข้อมูลเพิ่มเติมเกี่ยวกับการทำงานกับ TLS ได้ที่ข้อมูลเบื้องต้นเกี่ยวกับ TLS/SSL
virtualhost
ระบุรายละเอียดเกี่ยวกับโฮสต์เสมือน
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร virtualhost
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
virtualhost.aliases.values |
อาร์เรย์ของสตริง | อ่านอย่างเดียว |
ชื่อแทนโฮสต์ของโฮสต์เสมือนที่มี Hit ระหว่างคำขอเฉพาะ |
คำขอพร็อกซี |
virtualhost.name |
สตริง | อ่านอย่างเดียว |
ชื่อของโฮสต์เสมือนที่ให้บริการคำขอของไคลเอ็นต์ต้นทาง |
คำขอพร็อกซี |
virtualhost.ssl.enabled |
บูลีน | อ่านอย่างเดียว |
แสดงผล "true" หากเปิดใช้ TLS/SSL ในการกำหนดค่าโฮสต์เสมือน |
คำขอพร็อกซี |
ดูข้อมูลเพิ่มเติมเกี่ยวกับการทำงานกับโฮสต์เสมือนได้ที่การกำหนดค่าโฮสต์เสมือน