คุณกําลังดูเอกสาร 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 ตัวอย่างเช่น "My Proxy" | คําขอพร็อกซี |
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 เสร็จแล้ว เช่น Wed, 21 Aug 2013 19:16:47 UTC ค่าเวลานี้แสดงสตริงของการประทับเวลา 32 บิตที่เกี่ยวข้อง เช่น "พุธ 21 ส.ค. 2013 เวลา 19:16:47 UTC" ตรงกับค่าการประทับเวลาของ 1377112607413 |
คําขอพร็อกซี |
client.received.end.timestamp |
ยาว | อ่านอย่างเดียว |
ค่าการประทับเวลาที่ระบุเมื่อพร็อกซีรับคําขอจากไคลเอ็นต์ต้นทางที่ ProxyEndpoint เสร็จแล้ว ค่านี้เป็นจํานวนเต็ม 64 บิต (แบบยาว) ที่มีจํานวนมิลลิวินาทีที่ผ่านไปตั้งแต่เที่ยงคืนของวันที่ 1 มกราคม 1970 ตามเวลา UTC |
คําขอพร็อกซี |
client.received.start.time |
สตริง | อ่านอย่างเดียว |
เวลาแสดงในรูปแบบสตริงที่พร็อกซีเริ่มรับคําขอจากไคลเอ็นต์ต้นทางที่ ProxyEndpoint เช่น: Wed, 21 Aug 2013 19:16:47 UTC ค่าเวลานี้แสดงสตริงของการประทับเวลา 32 บิตที่เกี่ยวข้อง เช่น "พุธ 21 ส.ค. 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" เป็นต้น ค่านี้คือสตริงสตริง |
ขั้นตอนหลังไคลเอ็นต์ |
client.sent.end.timestamp |
ยาว | อ่านอย่างเดียว | ค่าการประทับเวลาที่ระบุว่า ProxyEndpoint ส่งคืนการตอบกลับไปยังแอปไคลเอ็นต์ต้นทางเสร็จสิ้นแล้ว ค่านี้เป็นจํานวนเต็ม 64 บิต (ยาว) ที่มีจํานวนมิลลิวินาทีที่ผ่านไปตั้งแต่เที่ยงคืนของวันที่ 1 มกราคม 1970 UTC | ขั้นตอนหลังไคลเอ็นต์ |
client.sent.start.time |
สตริง | อ่านอย่างเดียว | เวลาที่แสดงในรูปแบบสตริง เมื่อ ProxyEndpoint เริ่มตอบกลับแอปไคลเอ็นต์ต้นทาง เช่น "วันพุธที่ 21 ส. ค. 2013 เวลา 19:16:47 UTC"
ค่านี้คือสตริงสตริง |
ขั้นตอนหลังไคลเอ็นต์ |
client.sent.start.timestamp |
ยาว | อ่านอย่างเดียว | เมื่อพร็อกซีเริ่มส่งการตอบสนองไปยังไคลเอ็นต์จาก ProxyEndpoint ค่านี้จะแสดงเป็นจํานวนเต็ม 64 บิต (แบบยาว) ที่มีจํานวนมิลลิวินาทีที่ผ่านไปตั้งแต่เที่ยงคืนของวันที่ 1 มกราคม 1970 ตามเวลา UTC | ขั้นตอนหลังไคลเอ็นต์ |
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 |
ข้อผิดพลาด |
error.state |
จำนวนเต็ม | อ่านอย่างเดียว |
สถานะในโฟลวที่เกิดข้อผิดพลาด |
ข้อผิดพลาด |
error.header.header_name |
สตริง | อ่าน/เขียน |
รับหรือตั้งค่าส่วนหัวการตอบกลับ |
ข้อผิดพลาด |
fault
ตัวแปรโฟลว์ที่ตั้งค่าเป็นรหัสข้อผิดพลาดรันไทม์เมื่อนโยบายแสดงข้อผิดพลาด ค่าของรหัสข้อผิดพลาดเป็นค่าเฉพาะสําหรับแต่ละนโยบาย
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
fault.fault_name |
สตริง | อ่านอย่างเดียว | fault_name คือชื่อของข้อผิดพลาดตามที่อธิบายไว้ในตารางข้อผิดพลาดรันไทม์ซึ่งรวมอยู่ในหัวข้อข้อมูลอ้างอิงเกี่ยวกับนโยบายแต่ละรายการ | ข้อผิดพลาด |
is
คอนเทนเนอร์สําหรับพร็อพเพอร์ตี้ is.error
ตารางต่อไปนี้จะอธิบายพร็อพเพอร์ตี้ของตัวแปร is
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
is.error |
บูลีน | อ่านอย่างเดียว |
การแจ้งข้อผิดพลาด |
คําขอพร็อกซี |
loadbalancing
ให้ข้อมูลเกี่ยวกับสถานะการจัดสรรภาระงานของ TargetEndpoint
ตารางต่อไปนี้จะอธิบายพร็อพเพอร์ตี้ของตัวแปร loadbalancing
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
loadbalancing.failedservers |
อาร์เรย์ของสตริง | อ่านอย่างเดียว |
รายการ TargetServer ที่ล้มเหลวระหว่างการจัดสรรภาระงานที่ 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 ต่อไปนี้ How do you iteite Collection from "request.queryparams.names" ใน JS ในชุมชน Apigee |
คําขอพร็อกซี |
message.querystring |
สตริง | อ่านอย่างเดียว |
สตริงที่มีชื่อและค่าของพารามิเตอร์การค้นหาทั้งหมดที่เชื่อมโยงกับคําขอที่ส่งไปยัง ProxyEndpoint จากแอปไคลเอ็นต์ เช่น สําหรับคําขอ "http://api.apifactory.com/conceptors?name=nick&surname=danger" ค่าของ |
คําขอพร็อกซี |
message.reason.phrase |
สตริง | อ่านอย่างเดียว |
รวบรวมวลีของข้อความตอบกลับจากเป้าหมาย |
คําตอบเป้าหมาย |
message.status.code |
จำนวนเต็ม | อ่านอย่างเดียว |
รหัสสถานะ HTTP ของข้อความตอบกลับจากเป้าหมาย |
คําตอบเป้าหมาย |
message.transport.message |
ข้อความการขนส่ง | อ่านอย่างเดียว |
ข้อความประเภท TransportMessage ที่เป็นวัตถุตามบริบท |
คําขอพร็อกซี |
message.uri |
สตริง | อ่านอย่างเดียว |
เส้นทาง URI ที่สมบูรณ์ (ตาม URL ของโดเมน) ที่มีพารามิเตอร์การค้นหา เช่น สําหรับคําขอ "http://api.apifactory.com/originors?name=nikola&surname=tesla" ตัวแปรนี้จะแสดงผล "originors?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 หรือตรวจสอบค่าของตัวแปร proxy.basepath ส่วนต่อท้ายเส้นทางพร็อกซีจะตามเส้นทางฐาน ("/forecastrss") พร้อมกับพารามิเตอร์การค้นหา หากคุณกําหนดเส้นทางพื้นฐานแบบไดนามิกในการกําหนดค่าพร็อกซี API เช่น "/v2/*/weatherapi" ตัวแปรนี้จะตั้งค่าเป็นเส้นทางแบบไดนามิก ("/v2/*/weatherapi") แม้ว่าเส้นทางพื้นฐานจะแปลงเป็นค่าคงที่ เช่น "/v2/foo/weatherapi" ก็ตาม |
คําขอพร็อกซี |
proxy.client.ip |
สตริง | อ่านอย่างเดียว |
ที่อยู่ |
คําขอพร็อกซี |
proxy.name |
สตริง | อ่านอย่างเดียว |
แอตทริบิวต์ name ที่กําหนดค่าไว้สําหรับ ProxyEndpoint |
คําขอพร็อกซี |
proxy.pathsuffix |
สตริง | อ่านอย่างเดียว |
ค่าของคําต่อท้ายเส้นทางพร็อกซี API ที่ส่งจากไคลเอ็นต์และได้รับที่ ProxyEndpoint Basepath กําหนดเป็นคอมโพเนนต์เส้นทางที่ระบุพร็อกซี 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 ที่เป็นวัตถุแบบต่อเนื่อง |
คําขอพร็อกซี |
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 |
จำนวนเต็ม | อ่านอย่างเดียว |
จํานวนสูตรในฟอร์มทั้งหมดในการตอบกลับ |
คําตอบเป้าหมาย |
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 ที่เป็นวัตถุแบบต่อเนื่อง |
คําตอบเป้าหมาย |
route
ระบุชื่อของ <RouteRule>
และ TargetEndpoint
ตารางต่อไปนี้จะอธิบายพร็อพเพอร์ตี้ของตัวแปร route
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
route.name |
สตริง | อ่านอย่างเดียว |
ชื่อของ |
คําขอเป้าหมาย |
route.target |
สตริง | อ่านอย่างเดียว |
ชื่อของ TargetEndpoint ที่ดําเนินการ เช่น "ค่าเริ่มต้น" |
คําขอเป้าหมาย |
router
คอนเทนเนอร์สําหรับพร็อพเพอร์ตี้ router.uuid
ซึ่งเลิกใช้งานแล้ว
ตารางต่อไปนี้จะอธิบายพร็อพเพอร์ตี้ของตัวแปร router
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
router.uuid |
สตริง | อ่านอย่างเดียว |
เลิกใช้งานแล้วและแสดงผลเป็นค่าว่าง (เดิมคือ UUID ของเราเตอร์ที่จัดการพร็อกซี) |
คําขอพร็อกซี |
servicecallout
อธิบาย TargetEndpoint สําหรับ นโยบายคําขอราคาเสนอ
ตารางต่อไปนี้จะอธิบายพร็อพเพอร์ตี้ของตัวแปร servicecallout
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
servicecallout.policy_name.expectedcn |
สตริง | อ่าน/เขียน |
ชื่อทั่วไปที่คาดหวังของ TargetEndpoint ตามที่ระบุไว้ในนโยบายนโยบาย ServiceService ซึ่งจะมีความหมายก็ต่อเมื่อ TargetEndpoint อ้างถึงปลายทาง TLS/SSL |
คําขอพร็อกซี |
servicecallout.policy_name.target.url |
สตริง | อ่าน/เขียน |
URL เป้าหมาย สําหรับนโยบาย ServiceService ที่เฉพาะเจาะจง |
คําขอพร็อกซี |
servicecallout.requesturi |
สตริง | อ่าน/เขียน |
URI ของ TargetEndpoint สําหรับนโยบายนโยบาย ServiceService 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 |
บูลีน | อ่าน/เขียน |
เมื่อค่าเป็น "จริง" คําขอที่ส่งต่อจาก ProxyEndpoint ไปยัง TargetEndpoint จะยังเก็บคําต่อท้ายเส้นทางไว้ (ส่วนย่อยของเส้นทาง URI หลัง URI ที่กําหนดในเส้นทางฐาน ProxyEndpoint) |
คําขอเป้าหมาย |
target.copy.queryparams |
บูลีน | อ่าน/เขียน |
เมื่อเป็น "จริง" คําขอที่ส่งต่อจาก 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 |
สตริง | อ่านอย่างเดียว |
กําหนดกลุ่มเป้าหมายที่จะได้รับข้อความจากปลายทาง |
คําขอเป้าหมาย |
target.organization |
สตริง | อ่านอย่างเดียว |
องค์กรของใบรับรอง TLS/SSL ที่นําเสนอโดยเซิร์ฟเวอร์เป้าหมาย |
คําตอบเป้าหมาย |
target.organization.unit |
สตริง | อ่านอย่างเดียว |
หน่วยขององค์กรของใบรับรอง TLS/SSL ที่นําเสนอโดยเซิร์ฟเวอร์เป้าหมาย |
คําตอบเป้าหมาย |
target.port |
จำนวนเต็ม | อ่านอย่างเดียว |
หมายเลขพอร์ตของบริการเป้าหมายที่แสดงการตอบกลับไปยังพร็อกซี API |
คําตอบเป้าหมาย |
target.received.end.time |
สตริง | อ่านอย่างเดียว |
เวลาแสดงในรูปแบบสตริง ซึ่งปลายทางสิ้นสุดการตอบสนองจากเป้าหมายแล้ว ตัวอย่างเช่น "Wed, 21 Aug 2013 19:16:47 UTC" เป็นต้น ค่าเวลานี้แสดงสตริงของการประทับเวลา 32 บิตที่เกี่ยวข้อง เช่น "วันพุธ 21 สิงหาคม 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 บิตที่เกี่ยวข้อง เช่น "พุธ 21 ส.ค. 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 บิตที่เกี่ยวข้อง เช่น "พุธ 21 ส.ค. 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 บิตที่เกี่ยวข้อง เช่น "พุธ 21 ส.ค. 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 ที่กําหนดค่าในไฟล์ XML Endtargetpoint หรือ URL เป้าหมายแบบไดนามิก (หากมีการตั้งค่า |
คําขอเป้าหมาย |
variable
คอนเทนเนอร์สําหรับพร็อพเพอร์ตี้ variable.expectedcn
ตารางต่อไปนี้จะอธิบายพร็อพเพอร์ตี้ของตัวแปร variable
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
variable.expectedcn |
สตริง | อ่าน/เขียน |
ตัวแปรเปิดเผยชื่อทั่วไปหากกําลังทํางานอยู่บน TLS/SSL |
คําขอพร็อกซี |
หากต้องการข้อมูลเพิ่มเติมเกี่ยวกับการใช้งาน TLS โปรดดูการแนะนํา TLS/SSL
virtualhost
ระบุรายละเอียดเกี่ยวกับโฮสต์เสมือน
ตารางต่อไปนี้จะอธิบายพร็อพเพอร์ตี้ของตัวแปร virtualhost
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
virtualhost.aliases.values |
อาร์เรย์ของสตริง | อ่านอย่างเดียว |
ชื่อแทนโฮสต์ของโฮสต์เสมือนที่มีการใช้งานในระหว่างคําขอหนึ่งๆ |
คําขอพร็อกซี |
virtualhost.name |
สตริง | อ่านอย่างเดียว |
ชื่อของโฮสต์เสมือนที่ให้บริการคําขอของไคลเอ็นต์ต้นทาง |
คําขอพร็อกซี |
virtualhost.ssl.enabled |
บูลีน | อ่านอย่างเดียว |
แสดงค่า "true" หากเปิดใช้ TLS/SSL ในการกําหนดค่าโฮสต์เสมือน |
คําขอพร็อกซี |
โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการทํางานกับโฮสต์เสมือนที่หัวข้อการกําหนดค่าโฮสต์เสมือน