คุณกําลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info
ส่วนนี้ให้ข้อมูลอ้างอิงเกี่ยวกับตัวแปรการไหล
Apigee Edge กําหนดตัวแปรการไหลต่อไปนี้
apigee
loadbalancing
route
apiproxy
message
router
application
messageid
servicecallout
client
organization
system
current
proxy
target
environment
ratelimit
variable
error
request
virtualhost
is
response
เราได้อธิบายตัวแปรเหล่านี้แต่ละรายการไว้ในส่วนถัดไป
apigee
ตัวแปรตัวช่วยที่ให้ข้อมูลเกี่ยวกับเวลาดำเนินการของนโยบาย
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร apigee
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
apigee.metrics.policy.policy_name.timeTaken |
จำนวนเต็ม | อ่านอย่างเดียว | เวลา (เป็นนาโนวินาที) ที่นโยบายใช้ในการดำเนินการ | นโยบาย |
apiproxy
อธิบายพร็อกซี 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 บิตที่สอดคล้องกัน เช่น "Wed, 21 Aug 2013 19:16:47 UTC" สอดคล้องกับค่าการประทับเวลา 1377112607413 |
คำขอพร็อกซี |
client.received.end.timestamp |
ยาว | อ่านอย่างเดียว |
ค่าการประทับเวลาที่ระบุเวลาที่พร็อกซีได้รับคําขอจากไคลเอ็นต์ต้นทางที่ ProxyEndpoint ค่านี้เป็นจำนวนเต็ม 64 บิต (Long) ซึ่งมีจำนวนมิลลิวินาทีที่ผ่านไปนับตั้งแต่เที่ยงคืนของวันที่ 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 บิต (Long) ซึ่งมีจำนวนมิลลิวินาทีที่ผ่านไปนับตั้งแต่เที่ยงคืนของวันที่ 1 มกราคม 1970 ตามเขตเวลา UTC |
คำขอพร็อกซี |
client.scheme |
สตริง | อ่านอย่างเดียว |
แสดงผลเป็น http หรือ https โดยขึ้นอยู่กับการขนส่งที่แอปไคลเอ็นต์ใช้ส่งข้อความคำขอ |
คำขอพร็อกซี |
client.sent.end.time |
สตริง | อ่านอย่างเดียว |
เวลาซึ่งแสดงในรูปแบบสตริงเมื่อพร็อกซีส่งการตอบกลับจาก ProxyEndpoint ไปยังไคลเอ็นต์เสร็จแล้ว เช่น "พุธที่ 21 ส.ค. 2013 19:16:47 น. UTC" ค่านี้เป็นการแสดงสตริงของ |
PostClientFlow |
client.sent.end.timestamp |
ยาว | อ่านอย่างเดียว | ค่าการประทับเวลาซึ่งระบุเวลาที่ ProxyEndpoint แสดงผลตอบกลับไปยังแอปไคลเอ็นต์ต้นทางเสร็จสิ้น ค่านี้เป็นจำนวนเต็ม 64 บิต (แบบยาว) ซึ่งมีจํานวนมิลลิวินาทีที่ผ่านไปนับตั้งแต่เที่ยงคืนของวันที่ 1 มกราคม 1970 (UTC) | PostClientFlow |
client.sent.start.time |
สตริง | อ่านอย่างเดียว | เวลา (แสดงในรูปแบบสตริง) เมื่อ ProxyEndpoint เริ่มแสดงผลคำตอบไปยังแอปไคลเอ็นต์ต้นทาง เช่น "พุธที่ 21 ส.ค. 2013 19:16:47 น. UTC"
ค่านี้เป็นการแสดงสตริงของ |
PostClientFlow |
client.sent.start.timestamp |
ยาว | อ่านอย่างเดียว | เมื่อพร็อกซีเริ่มส่งการตอบกลับไปยังไคลเอ็นต์จาก ProxyEndpoint ค่านี้จะแสดงเป็นจํานวนเต็ม 64 บิต (Long) ซึ่งมีจํานวนมิลลิวินาทีที่ผ่านไปนับตั้งแต่เที่ยงคืนของวันที่ 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 ของโฟลว์ |
คำขอพร็อกซี |
คุณดูพร็อพเพอร์ตี้เหล่านี้ได้ในมุมมองการติดตามของ UI ของ Edge อย่างไรก็ตาม พร็อพเพอร์ตี้เหล่านี้จะไม่แสดงในมุมมองการติดตามของ UI แบบคลาสสิกโดยค่าเริ่มต้น
environment
คอนเทนเนอร์สำหรับพร็อพเพอร์ตี้ environment.name
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร environment
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
environment.name |
สตริง | อ่านอย่างเดียว | ชื่อของสภาพแวดล้อมที่เรียกใช้ธุรกรรม | คำขอพร็อกซี |
error
ออบเจ็กต์ตามบริบทที่แสดงข้อความแสดงข้อผิดพลาดในขั้นตอนข้อผิดพลาด
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร error
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
error |
message |
อ่าน/เขียน | ข้อผิดพลาดประเภท message ซึ่งเป็นออบเจ็กต์ตามบริบทในขั้นตอนข้อผิดพลาด |
ข้อผิดพลาด |
error.content |
สตริง | อ่าน/เขียน | เนื้อหาของข้อผิดพลาด | ข้อผิดพลาด |
error.message |
สตริง | อ่านอย่างเดียว |
ข้อความที่เชื่อมโยงกับข้อผิดพลาด ซึ่งค่าจะใช้งานได้ก่อนการเรียกใช้โฟลว์ข้อผิดพลาดเท่านั้น |
ข้อผิดพลาด |
error.status.code |
จำนวนเต็ม | อ่านอย่างเดียว |
รหัสสถานะ HTTP ที่เชื่อมโยงกับข้อผิดพลาด เช่น "400" |
ข้อผิดพลาด |
error.reason.phrase |
สตริง | อ่านอย่างเดียว |
วลีเหตุผลที่เชื่อมโยงกับข้อผิดพลาด เช่น "Bad Request" |
ข้อผิดพลาด |
error.transport.message |
TransportMessage | อ่านอย่างเดียว |
ข้อผิดพลาดประเภท TransportMessage |
ข้อผิดพลาด |
error.state |
จำนวนเต็ม | อ่านอย่างเดียว |
สถานะในขั้นตอนที่เกิดข้อผิดพลาด |
ข้อผิดพลาด |
error.header.header_name |
สตริง | อ่าน/เขียน |
รับหรือตั้งค่าส่วนหัวการตอบกลับ |
ข้อผิดพลาด |
fault
ตัวแปรโฟลว์ที่ตั้งค่าเป็นรหัสข้อผิดพลาดรันไทม์เมื่อนโยบายแสดงข้อผิดพลาด ค่ารหัสข้อผิดพลาดจะแตกต่างกันไปตามนโยบายแต่ละรายการ
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
fault.fault_name |
สตริง | อ่านอย่างเดียว | fault_name คือชื่อข้อบกพร่องตามที่อธิบายไว้ในตารางข้อผิดพลาดรันไทม์ซึ่งรวมอยู่ในหัวข้อข้อมูลอ้างอิงนโยบายแต่ละหัวข้อ | ข้อผิดพลาด |
is
คอนเทนเนอร์สำหรับพร็อพเพอร์ตี้ is.error
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร is
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
is.error |
บูลีน | อ่านอย่างเดียว |
แฟล็กข้อผิดพลาด |
คำขอพร็อกซี |
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 |
สตริง | อ่าน/เขียน |
ค่าของส่วนหัวที่เฉพาะเจาะจง N ในข้อความ ไม่ว่าจะเป็นคำขอหรือการตอบกลับ ทั้งนี้ขึ้นอยู่กับสถานะของโฟลว์ 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 |
สตริง | อ่าน/เขียน |
ค่าของพารามิเตอร์การค้นหาที่ n ในข้อความ เช่น หาก ตัวอย่างการเขียนค่าหลายค่าสำหรับชื่อพารามิเตอร์การค้นหารายการเดียว เช่น "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/inventors?name=nick&surname=danger" ค่าของ |
คำขอพร็อกซี |
message.reason.phrase |
สตริง | อ่านอย่างเดียว |
ReasonPhrase ของข้อความตอบกลับจากเป้าหมาย |
การตอบกลับเป้าหมาย |
message.status.code |
จำนวนเต็ม | อ่านอย่างเดียว |
รหัสสถานะ HTTP ของข้อความตอบกลับจากเป้าหมาย |
การตอบกลับเป้าหมาย |
message.transport.message |
TransportMessage | อ่านอย่างเดียว |
ข้อความประเภท TransportMessage ซึ่งเป็นออบเจ็กต์ตามบริบท |
คำขอพร็อกซี |
message.uri |
สตริง | อ่านอย่างเดียว |
เส้นทาง URI ที่สมบูรณ์ (ตามหลัง URL ของโดเมน) ซึ่งรวมถึงพารามิเตอร์การค้นหา เช่น สําหรับคําขอ "http://api.apifactory.com/inventors?name=nikola&surname=tesla" ตัวแปรนี้จะแสดงผลเป็น "inventors?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 |
สตริง | อ่านอย่างเดียว |
ค่าของ Base Path ในการกำหนดค่าพร็อกซี 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 |
สตริง | อ่านอย่างเดียว |
แอตทริบิวต์ชื่อที่กําหนดค่าสําหรับ ProxyEndpoint |
คำขอพร็อกซี |
proxy.pathsuffix |
สตริง | อ่านอย่างเดียว |
ค่าของส่วนต่อท้ายเส้นทางฐานของพร็อกซี API ที่ส่งจากไคลเอ็นต์และได้รับที่ ProxyEndpoint โดย Basepath หมายถึงคอมโพเนนต์เส้นทางที่ระบุพร็อกซี API โดยไม่ซ้ำกัน URL ที่แสดงต่อสาธารณะของพร็อกซี API ประกอบด้วยชื่อองค์กร สภาพแวดล้อมที่ติดตั้งใช้งานพร็อกซี เส้นทางฐาน ส่วนต่อท้ายเส้นทางฐาน และแอปหาเส้นทาง เช่น ในคําขอไปยัง |
คำขอพร็อกซี |
proxy.url |
สตริง | อ่านอย่างเดียว |
รับ URL แบบสมบูรณ์ที่เชื่อมโยงกับคําขอพร็อกซีที่ได้รับจาก ProxyEndpoint รวมถึงพารามิเตอร์การค้นหาที่มีอยู่
โฮสต์ของ URL จะเป็น ดูตัวอย่างการสร้าง URL |
คำขอพร็อกซี |
ดูข้อมูลเพิ่มเติมเกี่ยวกับการใช้พร็อกซี API ได้ที่การทำความเข้าใจ API และพร็อกซี API
ratelimit
สร้างขึ้นเมื่อนโยบาย Quota หรือ SpikeArrest ทำงาน
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร ratelimit
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
ratelimit.policy_name.allowed.count | ยาว | อ่านอย่างเดียว | แสดงผลจํานวนโควต้าที่อนุญาต | PostClientFlow |
ratelimit.policy_name.used.count | ยาว | อ่านอย่างเดียว | แสดงผลโควต้าปัจจุบันที่ใช้ภายในช่วงเวลาของโควต้า | PostClientFlow |
ratelimit.policy_name.available.count | ยาว | อ่านอย่างเดียว | แสดงผลจํานวนโควต้าที่ใช้ได้ในช่วงโควต้า | PostClientFlow |
ratelimit.policy_name.exceed.count | ยาว | อ่านอย่างเดียว | แสดงผลเป็น 1 หลังจากเกินโควต้า | PostClientFlow |
ratelimit.policy_name.total.exceed.count | ยาว | อ่านอย่างเดียว | แสดงผลเป็น 1 หลังจากเกินโควต้า | PostClientFlow |
ratelimit.policy_name.expiry.time | ยาว | อ่านอย่างเดียว |
แสดงเวลา UTC (เป็นมิลลิวินาที) ซึ่งจะเป็นตัวกำหนดว่าโควต้าจะหมดอายุเมื่อใดและช่วงเวลาของโควต้าใหม่จะเริ่มเมื่อใด เมื่อประเภทของนโยบายโควต้าคือ |
PostClientFlow |
ratelimit.policy_name.identifier | สตริง | อ่านอย่างเดียว | แสดงข้อมูลอ้างอิงตัวระบุ (ไคลเอ็นต์) ที่แนบอยู่กับนโยบาย | PostClientFlow |
ratelimit.policy_name.class.allowed.count | ยาว | อ่านอย่างเดียว | แสดงผลจํานวนโควต้าที่อนุญาตซึ่งกําหนดไว้ในคลาส | PostClientFlow |
ratelimit.policy_name.class.used.count | ยาว | อ่านอย่างเดียว | แสดงผลโควต้าที่ใช้ภายในชั้นเรียน | PostClientFlow |
ratelimit.policy_name.class.available.count | ยาว | อ่านอย่างเดียว | แสดงผลจํานวนโควต้าที่ใช้ได้ในชั้นเรียน | PostClientFlow |
ratelimit.policy_name.class.exceed.count | ยาว | อ่านอย่างเดียว | แสดงผลจํานวนคําขอที่เกินขีดจํากัดในชั้นเรียนในช่วงโควต้าปัจจุบัน | PostClientFlow |
ratelimit.policy_name.class.total.exceed.count | ยาว | อ่านอย่างเดียว | แสดงจํานวนคําขอทั้งหมดที่เกินขีดจํากัดในชั้นเรียนตลอดช่วงเวลาโควต้าทั้งหมด ซึ่งก็คือผลรวมของ class.exceed.count สําหรับช่วงเวลาโควต้าทั้งหมด |
PostClientFlow |
ratelimit.policy_name.failed | บูลีน | อ่านอย่างเดียว |
ระบุว่านโยบายดำเนินการไม่สำเร็จหรือไม่ (จริงหรือเท็จ) |
PostClientFlow |
ดูข้อมูลเพิ่มเติมได้ที่
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 |
สตริง | อ่าน/เขียน |
ค่าของพารามิเตอร์แบบฟอร์มที่เฉพาะเจาะจงที่ n ในข้อความ เช่น หากสตริงแบบฟอร์มคือ "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 |
สตริง | อ่าน/เขียน |
ค่าของส่วนหัวที่เฉพาะเจาะจงที่ n ในคําขอ 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 |
สตริง | อ่าน/เขียน |
ค่าของพารามิเตอร์การค้นหาที่ n ในคําขอ เช่น หาก ตัวอย่างการเขียนค่าหลายค่าสําหรับชื่อพารามิเตอร์การค้นหารายการเดียว เช่น "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 โปรดดูหัวข้อ How do you iterate Collection from "request.queryparams.names" in 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 |
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 |
สตริง | อ่าน/เขียน |
ค่าของส่วนหัวที่เฉพาะเจาะจงที่ n ในการตอบกลับ 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 |
สตริง | อ่านอย่างเดียว |
ชื่อของปลายทางเป้าหมายที่ดำเนินการ เช่น "default" |
คำขอเป้าหมาย |
router
คอนเทนเนอร์สำหรับพร็อพเพอร์ตี้ router.uuid
ซึ่งเลิกใช้งานแล้ว
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร router
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
router.uuid |
สตริง | อ่านอย่างเดียว |
เลิกใช้งานแล้วและแสดงผลเป็นค่าว่าง (เดิมคือ UUID ของเราเตอร์ที่จัดการพร็อกซี) |
คำขอพร็อกซี |
servicecallout
อธิบาย TargetEndpoint สำหรับนโยบาย ServiceCallout
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร servicecallout
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
servicecallout.policy_name.expectedcn |
สตริง | อ่าน/เขียน |
ชื่อสามัญที่คาดไว้ของ TargetEndpoint ตามที่ระบุไว้ในนโยบายนโยบายข้อความไฮไลต์บริการ การดำเนินการนี้จะมีประโยชน์ก็ต่อเมื่อ TargetEndpoint อ้างอิงถึงปลายทาง TLS/SSL |
คำขอพร็อกซี |
servicecallout.policy_name.target.url |
สตริง | อ่าน/เขียน |
URL ของปลายทางเป้าหมายสำหรับนโยบาย ServiceCallout หนึ่งๆ |
คำขอพร็อกซี |
servicecallout.requesturi |
สตริง | อ่าน/เขียน |
URI ของปลายทางเป้าหมายสําหรับนโยบาย ServiceCallout URI คือ URL ของ TargetEndpoint ที่ไม่มีโปรโตคอลและข้อกําหนดของโดเมน |
คำขอพร็อกซี |
system
ระบุที่อยู่ IP ของระบบ รวมถึงรายละเอียดเกี่ยวกับพร็อกซี
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร system
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
system.interface.interface_name |
สตริง | อ่านอย่างเดียว |
ที่อยู่ IP ของระบบ |
คำขอพร็อกซี |
system.pod.name |
สตริง | อ่านอย่างเดียว |
ชื่อของพ็อดที่มีพร็อกซีทำงานอยู่ |
คำขอพร็อกซี |
system.region.name |
สตริง | อ่านอย่างเดียว |
ชื่อของศูนย์ข้อมูล ภูมิภาคที่พร็อกซีทำงานอยู่ |
คำขอพร็อกซี |
system.time |
สตริง | อ่านอย่างเดียว |
เวลาที่มีการอ่านตัวแปรนี้ เช่น "พุธที่ 21 ส.ค. 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 |
จำนวนเต็ม | อ่านอย่างเดียว |
ส่วนที่สองของ |
คำขอพร็อกซี |
system.time.millisecond |
จำนวนเต็ม | อ่านอย่างเดียว |
ส่วนมิลลิวินาทีของ |
คำขอพร็อกซี |
system.time.zone |
สตริง | อ่านอย่างเดียว |
เขตเวลาของระบบ |
คำขอพร็อกซี |
system.timestamp |
ยาว | อ่านอย่างเดียว |
จำนวนเต็ม 64 บิต (long) ที่แสดงเวลาที่อ่านตัวแปรนี้ ค่านี้คือจํานวนมิลลิวินาทีที่ผ่านไปนับตั้งแต่เที่ยงคืนของวันที่ 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 อ้างอิงถึงปลายทาง 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 |
สตริง | อ่านอย่างเดียว |
เวลา (แสดงในรูปแบบสตริง) ที่ TargetEndpoint เสร็จสิ้นการรับการตอบกลับจากเป้าหมาย เช่น "พุธที่ 21 ส.ค. 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 เริ่มได้รับการตอบกลับจากเป้าหมาย เช่น "พุธที่ 21 ส.ค. 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 เช่น "พุธที่ 21 ส.ค. 2013 19:16:47 น. UTC" ค่าเวลานี้เป็นการแสดงสตริงของจํานวนการประทับเวลา 32 บิตที่เกี่ยวข้อง เช่น "Wed, 21 Aug 2013 19:16:47 UTC" สอดคล้องกับค่าการประทับเวลาของ "1377112607413" |
คำขอเป้าหมาย |
target.sent.end.timestamp |
ยาว | อ่านอย่างเดียว |
ค่าการประทับเวลาที่ระบุเวลาที่พร็อกซีส่งคําขอไปยัง URL ที่ระบุใน TargetEndpoint เสร็จสิ้น เช่น "1377112607413" ค่านี้เป็นจำนวนเต็ม 64 บิต (Long) ที่มีจำนวนมิลลิวินาทีที่ผ่านไปนับตั้งแต่เที่ยงคืนของวันที่ 1 มกราคม 1970 ตามเขตเวลา UTC |
คำขอเป้าหมาย |
target.sent.start.time |
สตริง | อ่านอย่างเดียว |
เวลา (แสดงในรูปแบบสตริง) ที่พร็อกซีเริ่มส่งคําขอไปยัง URL ที่ระบุใน TargetEndpoint เช่น "พุธที่ 21 ส.ค. 2013 19:16:47 น. UTC" ค่าเวลานี้เป็นการแสดงสตริงของจํานวนการประทับเวลา 32 บิตที่เกี่ยวข้อง เช่น "Wed, 21 Aug 2013 19:16:47 UTC" สอดคล้องกับค่าการประทับเวลาของ "1377112607413" |
คำขอเป้าหมาย |
target.sent.start.timestamp |
ยาว | อ่านอย่างเดียว |
ค่าการประทับเวลาซึ่งระบุเวลาที่พร็อกซีเริ่มส่งคําขอไปยัง URL ที่ระบุใน TargetEndpoint เช่น "1534783015000" ค่านี้เป็นจำนวนเต็ม 64 บิต (Long) ที่ระบุจำนวนมิลลิวินาทีที่ผ่านไปนับตั้งแต่เที่ยงคืนของวันที่ 1 มกราคม 1970 (UTC) |
คำขอเป้าหมาย |
target.ssl.enabled |
บูลีน | อ่านอย่างเดียว |
ปลายทางกำลังทำงานบน TLS/SSL หรือไม่ |
คำขอพร็อกซี |
target.state |
สตริง | อ่านอย่างเดียว |
สถานะของใบรับรอง TLS/SSL ที่แสดงโดยเซิร์ฟเวอร์เป้าหมาย |
การตอบกลับเป้าหมาย |
target.url |
สตริง | อ่าน/เขียน |
URL ที่กําหนดค่าไว้ในไฟล์ XML ของปลายทาง หรือ URL เป้าหมายแบบไดนามิก (หากมีการตั้งค่า |
คำขอเป้าหมาย |
variable
คอนเทนเนอร์สำหรับพร็อพเพอร์ตี้ variable.expectedcn
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร variable
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
variable.expectedcn |
สตริง | อ่าน/เขียน |
ตัวแปรที่แสดงสําหรับชื่อทั่วไปหากทํางานบน TLS/SSL |
คำขอพร็อกซี |
ดูข้อมูลเพิ่มเติมเกี่ยวกับการใช้งาน TLS ได้ที่ข้อมูลเบื้องต้นเกี่ยวกับ TLS/SSL
virtualhost
ระบุรายละเอียดเกี่ยวกับโฮสต์เสมือน
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร virtualhost
พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
---|---|---|---|---|
virtualhost.aliases.values |
อาร์เรย์สตริง | อ่านอย่างเดียว |
อีเมลแทนของโฮสต์เสมือนที่เข้าถึงระหว่างคำขอหนึ่งๆ |
คำขอพร็อกซี |
virtualhost.name |
สตริง | อ่านอย่างเดียว |
ชื่อของโฮสต์เสมือนที่ให้บริการตามคําขอของลูกค้าต้นทาง |
คำขอพร็อกซี |
virtualhost.ssl.enabled |
บูลีน | อ่านอย่างเดียว |
แสดงผลเป็น "จริง" หากเปิดใช้ TLS/SSL ในการกำหนดค่าโฮสต์เสมือน |
คำขอพร็อกซี |
ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีใช้โฮสต์เสมือนได้ที่หัวข้อการกําหนดค่าโฮสต์เสมือน