คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ
Apigee X info
ส่วนนี้ให้ข้อมูลอ้างอิงเกี่ยวกับตัวแปรโฟลว์
Apigee Edge กําหนดตัวแปรโฟลว์ต่อไปนี้
apigeeloadbalancingrouteapiproxymessagerouterapplicationmessageidservicecalloutclientorganizationsystemcurrentproxytargetenvironmentratelimitvariableerrorrequestvirtualhostisresponse
เราจะอธิบายตัวแปรแต่ละรายการเหล่านี้ในส่วนต่อไป
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 เสร็จสมบูรณ์ เช่น Wed, 21 Aug 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 เช่น Wed, 21 Aug 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 |
สตริง | อ่านอย่างเดียว |
"จริง" หากกำหนดค่า ProxyEndpoint สำหรับ TLS/SSL ไม่เช่นนั้นจะเป็น "เท็จ" |
คำขอพร็อกซี |
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 |
สตริง | อ่านอย่างเดียว |
ข้อความที่เชื่อมโยงกับข้อผิดพลาด ซึ่งค่าจะใช้ได้ก่อนที่จะมีการดำเนินการ Flow ของข้อผิดพลาดเท่านั้น |
ข้อผิดพลาด |
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 |
อาร์เรย์ของสตริง | อ่านอย่างเดียว |
รายการ TargetServer ที่ล้มเหลวระหว่างการจัดสรรภาระงานที่ TargetEndpoint |
การตอบกลับเป้าหมาย |
loadbalancing.isfallback |
บูลีน | อ่านอย่างเดียว |
"จริง" หากเปิดใช้การสำรองสำหรับ 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 |
สตริง | อ่าน/เขียน |
ค่าของพารามิเตอร์การค้นหา 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 iterate Collection from "request.queryparams.names" in 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 |
สตริง | อ่านอย่างเดียว |
ค่าของเส้นทางฐานในการกำหนดค่าพร็อกซี API เส้นทางฐานคือ URI Fragment ที่อยู่หลังโฮสต์ใน 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 Proxy อย่างไม่ซ้ำกัน URL ที่หันหน้าสู่สาธารณะของพร็อกซี API ประกอบด้วยชื่อองค์กรของคุณ สภาพแวดล้อมที่พร็อกซีได้รับการติดตั้งใช้งาน เส้นทางพื้นฐาน คำต่อท้ายเส้นทางพื้นฐาน และพารามิเตอร์การค้นหา เช่น ในคำขอไปยัง |
คำขอพร็อกซี |
proxy.url |
สตริง | อ่านอย่างเดียว |
รับ URL ที่สมบูรณ์ซึ่งเชื่อมโยงกับคำขอพร็อกซีที่ ProxyEndpoint ได้รับ
รวมถึงพารามิเตอร์การค้นหาที่มีอยู่
โฮสต์ของ URL จะเป็น ดูตัวอย่างที่สร้าง URL ของ |
คำขอพร็อกซี |
ดูข้อมูลเพิ่มเติมเกี่ยวกับการทำงานกับพร็อกซี API ได้ที่ ทำความเข้าใจ API และ พร็อกซี API
ratelimit
จะมีการป้อนข้อมูลเมื่อนโยบายโควต้าหรือ 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 |
สตริง | อ่าน/เขียน |
ค่าของพารามิเตอร์แบบฟอร์มที่เฉพาะเจาะจง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 |
สตริง | อ่าน/เขียน |
ค่าของค่าส่วนหัวที่เฉพาะเจาะจงรายการที่ 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 |
สตริง | อ่าน/เขียน |
ค่าของพารามิเตอร์การค้นหา 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 โปรดดู How do you iterate Collection from "request.queryparams.names" in JS? ใน Apigee Community |
คำขอพร็อกซี |
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 |
สตริง | อ่านอย่างเดียว |
ชื่อของ TargetEndpoint ที่ดำเนินการ เช่น "default" |
คำขอเป้าหมาย |
router
คอนเทนเนอร์สำหรับพร็อพเพอร์ตี้ router.uuid ซึ่งเลิกใช้งานแล้ว
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร router
| พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
|---|---|---|---|---|
router.uuid |
สตริง | อ่านอย่างเดียว |
เลิกใช้งานแล้วและแสดงผลเป็น Null (เดิมคือ UUID ของเราเตอร์ที่จัดการพร็อกซี ) |
คำขอพร็อกซี |
servicecallout
อธิบาย TargetEndpoint สำหรับนโยบาย ServiceCallout
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร servicecallout
| พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
|---|---|---|---|---|
servicecallout.policy_name.expectedcn |
สตริง | อ่าน/เขียน |
ชื่อสามัญที่คาดไว้ของ TargetEndpoint ตามที่ระบุไว้ในนโยบาย ServiceCallout policy ซึ่งจะมีประโยชน์เฉพาะเมื่อ TargetEndpoint อ้างอิง ไปยังปลายทาง TLS/SSL |
คำขอพร็อกซี |
servicecallout.policy_name.target.url |
สตริง | อ่าน/เขียน |
URL ของ TargetEndpoint สำหรับนโยบาย ServiceCallout ที่เฉพาะเจาะจง |
คำขอพร็อกซี |
servicecallout.requesturi |
สตริง | อ่าน/เขียน |
URI ของ TargetEndpoint สำหรับนโยบาย ServiceCallout policy 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 |
สตริง | อ่านอย่างเดียว |
เป้าหมายที่ข้อความไปถึงจาก 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 ที่กำหนดค่าไว้ในไฟล์ XML ของ TargetEndpoint หรือ URL เป้าหมายแบบไดนามิก (หาก
|
คำขอเป้าหมาย |
variable
คอนเทนเนอร์สำหรับพร็อพเพอร์ตี้ variable.expectedcn
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร variable
| พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
|---|---|---|---|---|
variable.expectedcn |
สตริง | อ่าน/เขียน |
ตัวแปรที่แสดงสำหรับชื่อสามัญหากทำงานบน TLS/SSL |
คำขอพร็อกซี |
ดูข้อมูลเพิ่มเติมเกี่ยวกับการทำงานกับ TLS ได้ที่ ข้อมูลเบื้องต้นเกี่ยวกับ TLS/SSL
virtualhost
ระบุรายละเอียดเกี่ยวกับโฮสต์เสมือน
ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร virtualhost
| พร็อพเพอร์ตี้ | ประเภท | อ่าน/เขียน | คำอธิบาย | ขอบเขตเริ่มต้น |
|---|---|---|---|---|
virtualhost.aliases.values |
อาร์เรย์ของสตริง | อ่านอย่างเดียว |
นามแฝงของโฮสต์ของโฮสต์เสมือนที่เข้าชมระหว่างคำขอที่เฉพาะเจาะจง |
คำขอพร็อกซี |
virtualhost.name |
สตริง | อ่านอย่างเดียว |
ชื่อของโฮสต์เสมือนที่ให้บริการคำขอของไคลเอ็นต์ต้นทาง |
คำขอพร็อกซี |
virtualhost.ssl.enabled |
บูลีน | อ่านอย่างเดียว |
แสดงผล "จริง" หากเปิดใช้ TLS/SSL ในการกำหนดค่าโฮสต์เสมือน |
คำขอพร็อกซี |
ดูข้อมูลเพิ่มเติมเกี่ยวกับการทำงานกับโฮสต์เสมือนได้ที่ การกำหนดค่าโฮสต์เสมือน
