การอ้างอิงตัวแปรโฟลว์

คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่ เอกสารประกอบเกี่ยวกับ Apigee X. ข้อมูล

ส่วนนี้จะแสดงข้อมูลอ้างอิงเกี่ยวกับตัวแปรโฟลว์

Apigee Edge กำหนดตัวแปรโฟลว์ต่อไปนี้

apigee              loadbalancing        router
apiproxy            message              servicecallout
application         messageid            system
client              organization         target
current             proxy                variable
environment         request              virtualhost
error               response
is                  route

ตัวแปรแต่ละตัวเหล่านี้จะอธิบายในส่วนถัดไป

apigee

ตัวแปรตัวช่วยที่ให้ข้อมูลเกี่ยวกับเวลาดำเนินการของนโยบาย

ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร apigee

พร็อพเพอร์ตี้ ประเภท อ่าน/เขียน คำอธิบาย เริ่มต้นขอบเขต
apigee.metrics.policy.policy_name.timeTaken จำนวนเต็ม อ่านอย่างเดียว เวลาที่นโยบายใช้ในการดำเนินการ โดยมีหน่วยเป็นนาโนวินาที นโยบาย

apiproxy

อธิบายพร็อกซี API

ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร apiproxy

พร็อพเพอร์ตี้ ประเภท อ่าน/เขียน คำอธิบาย เริ่มต้นขอบเขต
apiproxy.name สตริง อ่านอย่างเดียว ชื่อพร็อกซี API เช่น "พร็อกซีของฉัน" คำขอพร็อกซี
apiproxy.revision สตริง อ่านอย่างเดียว หมายเลขการแก้ไขของพร็อกซี API เช่น "6" คำขอพร็อกซี

ดูข้อมูลเพิ่มเติมเกี่ยวกับการใช้งานพร็อกซี API ได้ที่ การทำความเข้าใจ API และ พร็อกซี API

application

คอนเทนเนอร์ของพร็อพเพอร์ตี้ application.basepath

ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร application

พร็อพเพอร์ตี้ ประเภท อ่าน/เขียน คำอธิบาย เริ่มต้นขอบเขต
application.basepath สตริง อ่านอย่างเดียว เส้นทางฐานของการทำให้ใช้งานได้ (ระบุระหว่างการทำให้ API ใช้งานได้) คำขอพร็อกซี

client

แอปพลิเคชันหรือระบบที่ส่งคำขอไปยัง Edge Router

ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร 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"

ค่านี้คือค่าแทนสตริงของ 32 บิตที่เกี่ยวข้อง client.sent.end.timestamp เช่น "Wed, 21 Aug 2013 19:16:47 UTC" สอดคล้องกับค่าการประทับเวลา 1377112607413

 PostClientFlow
client.sent.end.timestamp ยาว อ่านอย่างเดียว ค่าการประทับเวลาที่ระบุเมื่อ ProxyEndpoint ส่งคืนการตอบกลับเสร็จสิ้น ไปยังแอปไคลเอ็นต์ต้นทาง ค่านี้เป็นจำนวนเต็ม 64 บิต (ยาว) ที่มีส่วน จำนวนมิลลิวินาทีที่ผ่านไปนับตั้งแต่เที่ยงคืนของวันที่ 1 มกราคม 1970 ตามเขตเวลา UTC PostClientFlow
client.sent.start.time สตริง อ่านอย่างเดียว เวลาซึ่งแสดงในรูปแบบสตริง เมื่อ ProxyEndpoint เริ่มแสดงผล การตอบสนองต่อแอปไคลเอ็นต์ต้นทาง เช่น "Wed, 21 Aug 2013 19:16:47 UTC"

ค่านี้คือค่าแทนสตริงของ 32 บิตที่เกี่ยวข้อง client.sent.start.timestamp เช่น "Wed, 21 Aug 2013 19:16:47 UTC" สอดคล้องกับค่าการประทับเวลา 1377112607413

 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 ของโฟลว์ คำขอพร็อกซี

โดยคุณจะดูคุณสมบัติเหล่านี้ได้ในมุมมองการติดตามของ Edge UI อย่างไรก็ตาม คุณสมบัติเหล่านี้จะไม่ โดยค่าเริ่มต้นในมุมมองการติดตามของ UI คลาสสิก

environment

คอนเทนเนอร์ของพร็อพเพอร์ตี้ environment.name

ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร environment

พร็อพเพอร์ตี้ ประเภท อ่าน/เขียน คำอธิบาย เริ่มต้นขอบเขต
environment.name สตริง อ่านอย่างเดียว ชื่อของสภาพแวดล้อมที่ธุรกรรมทำงาน คำขอพร็อกซี

error

ออบเจ็กต์บริบทที่แสดงข้อความแสดงข้อผิดพลาดใน โฟลว์ข้อผิดพลาด

ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร error

พร็อพเพอร์ตี้ ประเภท อ่าน/เขียน คำอธิบาย เริ่มต้นขอบเขต
error message อ่าน/เขียน ข้อผิดพลาดของประเภท message ซึ่งเป็นออบเจ็กต์บริบทในโฟลว์ข้อผิดพลาด ข้อผิดพลาด
error.content สตริง อ่าน/เขียน เนื้อหาของข้อผิดพลาด ข้อผิดพลาด
error.message สตริง อ่านอย่างเดียว

ข้อความที่เชื่อมโยงกับข้อผิดพลาด ซึ่งมีค่าอยู่ก่อนโฟลว์ข้อผิดพลาดเท่านั้น จะถูกดำเนินการ

 ข้อผิดพลาด
error.status.code จำนวนเต็ม อ่านอย่างเดียว

รหัสสถานะ HTTP ที่เชื่อมโยงกับข้อผิดพลาด เช่น "400"

 ข้อผิดพลาด
error.reason.phrase สตริง อ่านอย่างเดียว

วลีเหตุผลที่เกี่ยวข้องกับข้อผิดพลาด เช่น "คำขอไม่ถูกต้อง"

 ข้อผิดพลาด
error.transport.message TransportMessage อ่านอย่างเดียว

ข้อผิดพลาดประเภท TransportMessage

 ข้อผิดพลาด
error.state จำนวนเต็ม อ่านอย่างเดียว

สถานะในโฟลว์ที่เกิดข้อผิดพลาด

 ข้อผิดพลาด
error.header.header_name สตริง อ่าน/เขียน

รับหรือตั้งค่าส่วนหัวการตอบกลับ

 ข้อผิดพลาด

fault

ตัวแปรโฟลว์ที่ตั้งค่าเป็นรหัสข้อผิดพลาดรันไทม์เมื่อนโยบายแสดงข้อผิดพลาด ค่ารหัสข้อผิดพลาดจะเป็นค่าเฉพาะสำหรับแต่ละนโยบาย

พร็อพเพอร์ตี้ ประเภท อ่าน/เขียน คำอธิบาย เริ่มต้นขอบเขต
fault.fault_name สตริง อ่านอย่างเดียว fault_name คือชื่อของข้อผิดพลาดตามที่อธิบายไว้ในตารางข้อผิดพลาดรันไทม์ ที่รวมอยู่ในหัวข้อการอ้างอิงนโยบายแต่ละหัวข้อ ข้อผิดพลาด

is

คอนเทนเนอร์ของพร็อพเพอร์ตี้ is.error

ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร is

พร็อพเพอร์ตี้ ประเภท อ่าน/เขียน คำอธิบาย เริ่มต้นขอบเขต
is.error บูลีน อ่านอย่างเดียว

การแจ้งข้อผิดพลาด

 คำขอพร็อกซี

loadbalancing

ให้ข้อมูลเกี่ยวกับสถานะการจัดสรรภาระงานของ TargetEndpoint

ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร loadbalancing

พร็อพเพอร์ตี้ ประเภท อ่าน/เขียน คำอธิบาย เริ่มต้นขอบเขต
loadbalancing.failedservers อาร์เรย์ของสตริง อ่านอย่างเดียว

รายการ TargetServers ที่ล้มเหลวระหว่างการจัดสรรภาระงานที่ TargetEndpoint

 การตอบสนองเป้าหมาย
loadbalancing.isfallback บูลีน อ่านอย่างเดียว

"จริง" หากเปิดใช้โฆษณาสำรองสำหรับ TargetServer ที่มีการเรียกใช้ระหว่างการจัดสรรภาระงาน ที่ TargetEndpoint

 การตอบสนองเป้าหมาย
loadbalancing.targetserver สตริง อ่านอย่างเดียว

มีการเรียกใช้ TargetServer ระหว่างการจัดสรรภาระงานที่ TargetEndpoint ตั้งค่าเฉพาะในกรณีที่ มีการตั้งค่าองค์ประกอบ <Path> ขณะกำหนดองค์ประกอบตัวจัดสรรภาระงาน

 การตอบสนองเป้าหมาย

message

ออบเจ็กต์บริบท ซึ่งมีค่าเดียวกับ request ในขั้นตอนคำขอ หรือเป็น response ในขั้นตอนการตอบกลับ หรือเป็น error ในข้อผิดพลาด

ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร message

พร็อพเพอร์ตี้ ประเภท อ่าน/เขียน คำอธิบาย เริ่มต้นขอบเขต
message message อ่าน/เขียน

ออบเจ็กต์บริบท ที่มีค่าเดียวกับ request ในขั้นตอนคำขอ หรือเป็น response ในโฟลว์การตอบกลับ หรือเป็น error ในข้อผิดพลาด

คำขอพร็อกซี
message.content สตริง อ่าน/เขียน

เนื้อหาของคำขอ การตอบกลับ หรือข้อความแสดงข้อผิดพลาด

 คำขอพร็อกซี
message.formparam.param_name สตริง อ่าน/เขียน

ค่าของพารามิเตอร์แบบฟอร์มที่ระบุ

 คำขอพร็อกซี
message.formparam.param_name.
 values		 คอลเล็กชัน อ่านอย่างเดียว

ค่าทั้งหมดของพารามิเตอร์แบบฟอร์มที่ระบุในข้อความ

 คำขอพร็อกซี
message.formparam.param_name.
 values.count		 จำนวนเต็ม อ่านอย่างเดียว

จำนวนค่าพารามิเตอร์ฟอร์มที่ระบุในข้อความ/p>

คำขอพร็อกซี
message.formparams.count จำนวนเต็ม อ่านอย่างเดียว

จำนวนพารามิเตอร์ฟอร์มทั้งหมดในข้อความ

 คำขอพร็อกซี
message.formparams.names คอลเล็กชัน อ่านอย่างเดียว

ค่าของพารามิเตอร์ฟอร์มทั้งหมดในข้อความ

 คำขอพร็อกซี
message.formstring สตริง อ่านอย่างเดียว

ค่าของสตริงแบบฟอร์มในข้อความ

 คำขอพร็อกซี
message.header.header_name สตริง อ่าน/เขียน

รับหรือกำหนดค่าของส่วนหัว HTTP ที่ระบุในข้อความ หากส่วนหัว มีเครื่องหมายจุลภาค เมื่อคุณอ่าน คุณจะได้รับเฉพาะส่วนของข้อความที่ระบุได้สูงสุด คอมมา ถ้าคุณต้องการส่วนหัวทั้งหมด ให้ใช้ฟอร์ม request.header.header_name.
 values

 คำขอพร็อกซี
message.header.header_name.N สตริง อ่าน/เขียน

ค่าของส่วนหัวเฉพาะ Nth ในข้อความ อาจเป็นคำขอ หรือ การตอบสนอง ทั้งนี้ขึ้นอยู่กับสถานะของโฟลว์ Apigee Edge แยกค่าข้อความส่วนหัวตาม คอมมา โปรดทราบว่าดัชนีที่ใช้ค่าสำหรับ N จะเป็นแบบ 1 ไม่ใช่อิงตาม 0

ตัวอย่างเช่น หากส่วนหัว Cache-control เป็น "public,maxage=16544" ให้ทำดังนี้ ผลลัพธ์ message.header.cache-control.1 เป็น "maxage=16544"

 คำขอพร็อกซี
message.header.header_name.
 values		 คอลเล็กชัน อ่านอย่างเดียว

ค่าทั้งหมดของชื่อส่วนหัว HTTP ที่ระบุในข้อความ

 คำขอพร็อกซี
message.header.header_name.
 values.count		 จำนวนเต็ม อ่านอย่างเดียว

จำนวนค่าชื่อส่วนหัว HTTP ที่ระบุในข้อความ

 คำขอพร็อกซี
message.headers.count จำนวนเต็ม อ่านอย่างเดียว

จำนวนส่วนหัว HTTP ทั้งหมดในข้อความ

 คำขอพร็อกซี
message.headers.names คอลเล็กชัน อ่านอย่างเดียว

ค่าของส่วนหัว HTTP ทั้งหมดในข้อความ

 คำขอพร็อกซี
message.path สตริง อ่าน/เขียน

เส้นทางข้อความคำขอที่สมบูรณ์ใน URL ยกเว้นพารามิเตอร์การค้นหา

คำขอพร็อกซี
message.queryparam.param_name สตริง อ่านอย่างเดียว

แสดงผลพารามิเตอร์การค้นหาข้อความที่ระบุ

 คำขอพร็อกซี
message.queryparam.param_name.N สตริง อ่าน/เขียน

ค่าพารามิเตอร์การค้นหา Nth ในข้อความ ตัวอย่างเช่น หาก request.querystring คือ "a=hello&a=world" ผลลัพธ์ที่แสดงของ message.queryparam.a.1 คือ "สวัสดี"

ตัวอย่างของการเขียนค่าหลายค่าสำหรับชื่อพารามิเตอร์การค้นหาเดียว เช่น "type=siteid:1&type=language:us-en&type=currency:USD" ให้ตั้งค่าต่อไปนี้

  • message.queryparam.type.1 ถึง "siteid:1"
  • message.queryparam.type.2 เป็น "language:en-us"
  • message.queryparam.type.3 เป็น "currency:USD"
 คำขอพร็อกซี
message.queryparam.param_name.
 values		 คอลเล็กชัน อ่านอย่างเดียว

ค่าทั้งหมดของพารามิเตอร์การค้นหาหนึ่งๆ ในข้อความ ซึ่งอยู่ในรูปแบบ รายการที่คั่นด้วยคอมมา

ตัวอย่างเช่น หากสตริงการค้นหาคือ a=hello&a=world ค่าของ message.queryparam.a.values คือ "['สวัสดี', 'โลก']"

 คำขอพร็อกซี
message.queryparam.param_name.
 values.count		 จำนวนเต็ม อ่านอย่างเดียว

จำนวนรวมของพารามิเตอร์การค้นหาที่ระบุซึ่งเชื่อมโยงกับคำขอที่ส่งไปยัง 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.querystring คือ "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 (GET, PUT, POST, DELETE ฯลฯ) ที่เกี่ยวข้องกับคำขอดังกล่าว

 คำขอพร็อกซี
message.version สตริง อ่าน/เขียน

เวอร์ชัน HTTP ที่เชื่อมโยงกับคำขอที่ไคลเอ็นต์ส่งไปยัง ProxyEndpoint แอปพลิเคชัน

 คำขอพร็อกซี

ดูข้อมูลเพิ่มเติมเกี่ยวกับข้อความได้ที่ การอ้างอิงฟังก์ชันเทมเพลตข้อความ

messageid

คอนเทนเนอร์สำหรับรหัสที่ไม่ซ้ำกันทั่วโลกของคำขอ

ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร messageid

พร็อพเพอร์ตี้ ประเภท อ่าน/เขียน คำอธิบาย เริ่มต้นขอบเขต
messageid สตริง อ่านอย่างเดียว

เก็บรหัสที่ไม่ซ้ำกันทั่วโลกของคำขอ ซึ่งรวมถึงชื่อโฮสต์ของเราเตอร์ รหัสนี้ช่วยให้ติดตามคำขอที่ได้รับที่เราเตอร์ได้หลังจากที่ส่งไปยัง เครื่องมือประมวลผลข้อความ

ระบบจะบันทึกรหัสนี้ไว้ในบันทึกข้อผิดพลาดของ Edge เพื่อเชื่อมโยง messageid กับพารามิเตอร์

คำขอพร็อกซี

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":

  • โฮสต์คือ "myorg-test.apigee.net" (ซึ่งรวมถึง ชื่อและสภาพแวดล้อมขององค์กร)
  • เส้นทางฐานคือ "/v2/weatherapi"

วิธีเดียวที่คุณจะรู้เรื่องนี้ คือการดูคำจำกัดความของพร็อกซี API หรือการตรวจสอบค่าของพร็อกซี.basepath ตัวแปร ส่วนต่อท้ายของเส้นทางพร็อกซีเป็นไปตามเส้นทางพื้นฐาน ("/ผู้คาดการณ์") พร้อมด้วยรายการ พารามิเตอร์การค้นหา

หากคุณกำหนดเส้นทางฐานแบบไดนามิกในพร็อกซี API ของคุณ เช่น "/v2/*/weatherapi" ตัวแปรนี้จะได้รับการตั้งค่าเป็นเส้นทางแบบไดนามิก ("/v2/*/weatherapi") แม้ว่าเส้นทางพื้นฐานจะเปลี่ยนเป็นค่าคงที่ เช่น &quot;/v2/foo/weatherapi&quot;.

 คำขอพร็อกซี
proxy.client.ip สตริง อ่านอย่างเดียว

ที่อยู่ X-Forwarded-For ของสายโทรเข้า ซึ่งเป็น Edge ได้รับที่อยู่ IP จากแฮนด์เชค TCP ภายนอกล่าสุด นี่อาจเป็นการโทร ไคลเอ็นต์หรือตัวจัดสรรภาระงาน

 คำขอพร็อกซี
proxy.name สตริง อ่านอย่างเดียว

แอตทริบิวต์ชื่อที่กำหนดค่าไว้สำหรับ ProxyEndpoint

 คำขอพร็อกซี
proxy.pathsuffix สตริง อ่านอย่างเดียว

ค่าของคำต่อท้ายเส้นทางฐานของพร็อกซี API ที่ส่งจากไคลเอ็นต์และได้รับที่ ProxyEndpoint

เส้นทางฐานหมายถึงคอมโพเนนต์เส้นทางที่ระบุพร็อกซี API โดยไม่ซ้ำกัน URL ที่เปิดเผยต่อสาธารณะของพร็อกซี API ประกอบด้วยชื่อองค์กรของคุณ และ สภาพแวดล้อมที่มีการทำให้พร็อกซีใช้งานได้, Basepath, คำต่อท้าย Basepath และคำค้นหา พารามิเตอร์

ตัวอย่างเช่น ในคำขอไปยัง http://myorg-test.apigee.net/v2/weatherapi/forecastrss?w=12797282 ส่วนต่อท้ายเส้นทางพื้นฐานคือ "/forecastrss"

 คำขอพร็อกซี
proxy.url สตริง อ่านอย่างเดียว

รับ URL แบบเต็มที่เชื่อมโยงกับคำขอพร็อกซีที่ ProxyEndpoint ได้รับ รวมถึงพารามิเตอร์การค้นหาที่มีอยู่ โฮสต์ของ URL จะเป็น localhost เสมอ หากมีการเรียกพร็อกซีด้วย <LocalTargetConnection> เพื่อ ดำเนินการการผูกพร็อกซี

ตัวอย่างที่สร้าง URL request โดยใช้ URL เดิม โฮสต์ โปรดดูที่ข้อความคำขอเข้าถึง

 คำขอพร็อกซี

ดูข้อมูลเพิ่มเติมเกี่ยวกับการใช้งานพร็อกซี API ได้ที่ การทำความเข้าใจ API และ พร็อกซี API

request

คำขอที่สมบูรณ์ รวมถึงเพย์โหลดที่มีอยู่

ดูรายละเอียดเพิ่มเติมเกี่ยวกับข้อมูลคำขอได้ที่ ระบบส่งข้อมูลคำขอไปยังเซิร์ฟเวอร์แบ็กเอนด์อย่างไร

ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร request

พร็อพเพอร์ตี้ ประเภท อ่าน/เขียน คำอธิบาย เริ่มต้นขอบเขต
request message อ่านอย่างเดียว

คำขอที่สมบูรณ์ รวมถึงเพย์โหลดที่มีอยู่

 คำขอพร็อกซี
request.content สตริง อ่าน/เขียน

รับหรือตั้งค่าเพย์โหลดของข้อความคำขอ

 คำขอพร็อกซี
request.formparam.param_name สตริง อ่าน/เขียน

รับหรือกำหนดค่าของพารามิเตอร์แบบฟอร์มที่ระบุในคำขอที่ส่งจาก แอปพลิเคชันไคลเอ็นต์

 คำขอพร็อกซี
request.formparam.param_name.
 values		 คอลเล็กชัน อ่านอย่างเดียว

ค่าทั้งหมดของพารามิเตอร์ฟอร์มหนึ่งๆ ในคำขอ ซึ่งอยู่ในรูปแบบ รายการที่คั่นด้วยคอมมา

เช่น หากเพย์โหลดคือ "a=hello&x=greeting&a=world" และค่า request.formparam.a.values คือ "['สวัสดี', 'โลก']"

 คำขอพร็อกซี
request.formparam.param_name.
 values.count		 จำนวนเต็ม อ่านอย่างเดียว

จำนวนค่าทั้งหมดสำหรับพารามิเตอร์แบบฟอร์มที่ระบุซึ่งเชื่อมโยงกับคำขอ

 คำขอพร็อกซี
request.formparam.param_name.N สตริง อ่าน/เขียน

ค่าของพารามิเตอร์แบบฟอร์มเฉพาะ Nth ในข้อความ ตัวอย่างเช่น หาก สตริงฟอร์มคือ "a=hello&a=world" แล้วค่าที่ส่งกลับของ request.formparam.a.1 คือ "สวัสดี"

 คำขอพร็อกซี
request.formparams.count จำนวนเต็ม อ่านอย่างเดียว

จำนวนพารามิเตอร์ของแบบฟอร์มทั้งหมดที่เชื่อมโยงกับคำขอที่ส่งจากไคลเอ็นต์ แอปพลิเคชัน

 คำขอพร็อกซี
request.formparams.names คอลเล็กชัน อ่านอย่างเดียว

รายการชื่อพารามิเตอร์แบบฟอร์มทั้งหมดที่เชื่อมโยงกับคําขอ

 คำขอพร็อกซี
request.formstring สตริง อ่านอย่างเดียว

formparam ที่สมบูรณ์ในคำขอที่ส่งจากแอปไคลเอ็นต์

เช่น "name=test&type=first&group=A"

 คำขอพร็อกซี
request.header.header_name สตริง อ่าน/เขียน

รับหรือกำหนดค่าของส่วนหัวเฉพาะที่พบในคำขอ หากส่วนหัว มีเครื่องหมายจุลภาค เมื่อคุณอ่าน คุณจะได้รับเฉพาะส่วนของข้อความที่ระบุได้สูงสุด คอมมา

ถ้าคุณต้องการส่วนหัวทั้งหมด ให้ใช้ฟอร์ม request.header.header_name.values

 คำขอพร็อกซี
request.header.header_name.N สตริง อ่าน/เขียน

ค่าของส่วนหัวเฉพาะ Nth ในคำขอ Apigee Edge แยกค่าข้อความส่วนหัวด้วยเครื่องหมายจุลภาค โปรดทราบว่าดัชนีที่มีค่าที่ใช้สำหรับ N คือ แบบ 1 ไม่ใช่ 0

ตัวอย่างเช่น หากส่วนหัว Cache-control เป็น "สาธารณะ, maxage=16544" ผลลัพธ์ request.header.cache-control.1 จะเป็น "maxage=16544"

 คำขอพร็อกซี
request.header.header_name.
 values		 คอลเล็กชัน อ่านอย่างเดียว

ค่าทั้งหมดของส่วนหัวหนึ่งๆ ในคำขอ

 คำขอพร็อกซี
request.header.header_name.
 values.count		 จำนวนเต็ม อ่านอย่างเดียว

จำนวนค่าทั้งหมดของส่วนหัวหนึ่งๆ ในคำขอ

 คำขอพร็อกซี
request.headers.count จำนวนเต็ม อ่านอย่างเดียว

จำนวนส่วนหัวทั้งหมดในคำขอ

 คำขอพร็อกซี
request.headers.names คอลเล็กชัน อ่านอย่างเดียว

ชื่อของส่วนหัวทั้งหมดในคำขอ

 คำขอพร็อกซี
request.path สตริง อ่านอย่างเดียว

เส้นทางทรัพยากรที่ไม่มีพร็อกซี (ไม่รวมโฮสต์) ไปยังบริการแบ็กเอนด์ การยกเว้นพารามิเตอร์การค้นหา

ตัวอย่างเช่น URI ไปยังบริการแบ็กเอนด์คือ "https://example.com/rest/api/วันล่าสุด" แล้วใส่ค่าของ request.path คือ "/rest/api/latest"

 คำขอพร็อกซี
request.queryparam.param_name สตริง อ่าน/เขียน

ค่าของพารามิเตอร์การค้นหาหนึ่งๆ ที่พบในคําขอ

 คำขอพร็อกซี
request.queryparam.param_name.N สตริง อ่าน/เขียน

ค่าพารามิเตอร์การค้นหา Nth ในคำขอ

ตัวอย่างเช่น หาก request.querystring คือ "a=hello&a=world" ค่าที่ส่งกลับคือ request.queryparam.a.1 คือ "สวัสดี"

ตัวอย่างของการเขียนค่าหลายค่าสำหรับชื่อพารามิเตอร์การค้นหาเดียว เช่น "type=siteid:1&type=language:us-en&type=currency:USD" ให้ตั้งค่าต่อไปนี้

  • request.queryparam.type.1 ถึง "siteid:1"
  • request.queryparam.type.2 เป็น "language:en-us"
  • request.queryparam.type.3 เป็น "currency:USD"
 คำขอพร็อกซี
request.queryparam.param_name.
 values		 คอลเล็กชัน อ่านอย่างเดียว

ค่าทั้งหมดของพารามิเตอร์การค้นหาหนึ่งๆ ในคำขอ โดยมีรูปแบบเป็น รายการที่คั่นด้วยคอมมา

ตัวอย่างเช่น หาก request.querystring คือ "a=hello&b=lovely&a=world" และค่า request.queryparam.a.values คือ "['สวัสดี', 'โลก']"

 คำขอพร็อกซี
request.queryparam.param_name.
 values.count		 จำนวนเต็ม อ่านอย่างเดียว

จำนวนค่าทั้งหมดของพารามิเตอร์การค้นหาหนึ่งๆ ในคำขอ

 คำขอพร็อกซี
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 พร็อกซี <BasePath> ใน ProxyEndpoint (ใน เพิ่มเติมจาก URL พื้นฐานของพร็อกซี) แมปกับ URL บริการเป้าหมายใน TargetEndpoint เช่น

<ProxyEndpoint>
...
  <BasePath>/my-mock-proxy</BasePath>

ชี้ไปที่

<TargetEndpoint>
...
  <HTTPTargetConnection>
    http://mocktarget.apigee.net
  </HTTPTargetConnection>

ในคำขอ request.uri คือเส้นทางฐานของพร็อกซี + ส่วนที่เหลือของที่อยู่ รวมถึงพารามิเตอร์การค้นหา

ในการตอบกลับ request.uri คือส่วนที่เหลือของ ซึ่งรวมถึงพารามิเตอร์การค้นหาหลัง HTTPTargetConnection

สิ่งที่แตกต่างคือเพราะคำขอแรกเข้ามาในพร็อกซี แต่จากนั้นเพิ่มพร็อกซี ส่งคำขอไปยังบริการเป้าหมายอีกครั้ง

สมมติว่ามีการเรียกต่อไปนี้ไปยังตัวอย่างพร็อกซีของเรา ซึ่งมีเส้นทางพื้นฐาน ของ "/my-mock-proxy":

http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude

และพร็อกซีจะเรียกข้อมูลต่อไปนี้

http://mocktarget.apigee.net

ซึ่งต่อท้าย "/user?user=Dude" ต่อท้าย URL นั้น

  • คำขอ: request.uri = "/my-mock-proxy/user?user=Dude"
  • คำตอบ: request.uri = "/user?user=Dude"
 คำขอพร็อกซี (คำตอบจะแตกต่างออกไป)
request.url สตริง อ่านอย่างเดียว

URL แบบเต็มของคำขอที่ส่งไปยังปลายทางเป้าหมาย รวมถึง พารามิเตอร์สตริงการค้นหา แต่ไม่รวมหมายเลขพอร์ต (หากระบุ)

เช่น หากเรียกใช้พร็อกซีตัวอย่าง "http://my_org-test.apigee.net/my-mock-proxy/user?user=Dude" และปลายทางเป้าหมาย คือ "http://example.com:8080" ค่าจะเป็นดังนี้

  • คำขอ: ไม่มี
  • คำตอบ: "http://example.com/user?user=Dude"
 การตอบสนองเป้าหมาย
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.
 values.count		 จำนวนเต็ม อ่านอย่างเดียว

จำนวนค่าทั้งหมดของพารามิเตอร์แบบฟอร์มที่ระบุในการตอบกลับ

 การตอบสนองเป้าหมาย
response.formparams.count จำนวนเต็ม อ่านอย่างเดียว

จำนวนของพารามิเตอร์ทุกรูปแบบในคำตอบ

 การตอบสนองเป้าหมาย
response.formparams.names คอลเล็กชัน อ่านอย่างเดียว

ชื่อของพารามิเตอร์ฟอร์มทั้งหมดในคำตอบ

 การตอบสนองเป้าหมาย
response.header.header_name สตริง อ่าน/เขียน

รับหรือกำหนดค่าของส่วนหัว HTTP ที่ระบุในการตอบกลับ

หากข้อความส่วนหัวมีคอมมา Apigee Edge จะแสดงค่าหลายค่า ในกรณีนี้ response.header.header_name จะแสดงผลค่าแรกเท่านั้น

หากต้องการอ่านส่วนหัวทั้งหมด ให้ใช้แบบฟอร์ม response.header.header_name.values

 การตอบสนองเป้าหมาย
response.header.header_name.
 values		 คอลเล็กชัน อ่านอย่างเดียว

ค่าทั้งหมดของส่วนหัว HTTP ที่ระบุในการตอบสนอง

 การตอบสนองเป้าหมาย
response.header.header_name.
 values.count		 จำนวนเต็ม อ่านอย่างเดียว

จำนวนค่าทั้งหมดของส่วนหัว HTTP ที่ระบุในการตอบสนอง

 การตอบสนองเป้าหมาย
response.header.header_name.N สตริง อ่าน/เขียน

ค่าของส่วนหัวเฉพาะ Nth ในคำตอบ Apigee Edge แยกค่าข้อความส่วนหัวด้วยเครื่องหมายจุลภาค โปรดทราบว่าดัชนีที่มีค่าที่ใช้สำหรับ N คือ แบบ 1 ไม่ใช่ 0

ตัวอย่างเช่น ถ้าส่วนหัว Cache-control คือ "public, maxage=16544" แล้ว response.header.cache-control.1 แสดงผล "maxage=16544"

 การตอบสนองเป้าหมาย
response.headers.count จำนวนเต็ม อ่านอย่างเดียว

จำนวนส่วนหัวทั้งหมดในคำตอบ

 การตอบสนองเป้าหมาย
response.headers.names คอลเล็กชัน อ่านอย่างเดียว

ชื่อของส่วนหัวทั้งหมดในคำตอบ

 การตอบสนองเป้าหมาย
response.reason.phrase สตริง อ่าน/เขียน

วลีเหตุผลที่ตอบกลับสำหรับคำขอหนึ่งๆ

 การตอบสนองเป้าหมาย
response.status.code จำนวนเต็ม อ่าน/เขียน

โค้ดตอบกลับของคำขอแสดงขึ้น คุณสามารถใช้ตัวแปรนี้เพื่อลบล้าง รหัสสถานะการตอบกลับ ซึ่งจัดเก็บไว้ใน message.status.code สำหรับข้อมูลเพิ่มเติม ดู message

 การตอบสนองเป้าหมาย
response.transport.message สตริง อ่านอย่างเดียว

การตอบกลับประเภท TransportMessage ซึ่งเป็นออบเจ็กต์ที่ต่อเนื่อง

 การตอบสนองเป้าหมาย

route

ระบุชื่อ <RouteRule> และ TargetEndpoint

ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร route

พร็อพเพอร์ตี้ ประเภท อ่าน/เขียน คำอธิบาย เริ่มต้นขอบเขต
route.name สตริง อ่านอย่างเดียว

ชื่อของ <RouteRule> ที่ดำเนินการใน ProxyEndpoint ตัวอย่างเช่น "default" RouteRule อ้างอิงพร็อกซี TargetEndpoint ของ API เพื่อดำเนินการ

 คำขอเป้าหมาย
route.target สตริง อ่านอย่างเดียว

ชื่อของ TargetEndpoint ที่เรียกใช้ เช่น "default"

 คำขอเป้าหมาย

router

คอนเทนเนอร์สำหรับพร็อพเพอร์ตี้ router.uuid ซึ่งเลิกใช้งานแล้ว

ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร router

พร็อพเพอร์ตี้ ประเภท อ่าน/เขียน คำอธิบาย เริ่มต้นขอบเขต
router.uuid สตริง อ่านอย่างเดียว

เลิกใช้งานและแสดงผล Null (ก่อนหน้านี้คือ UUID ของเราเตอร์ที่จัดการ proxy.)

 คำขอพร็อกซี

servicecallout

อธิบาย TargetEndpoint สำหรับนโยบาย Serviceข้อความไฮไลต์

ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร servicecallout

พร็อพเพอร์ตี้ ประเภท อ่าน/เขียน คำอธิบาย เริ่มต้นขอบเขต
servicecallout.policy_name.expectedcn สตริง อ่าน/เขียน

ชื่อทั่วไปที่คาดไว้ของ TargetEndpoint ตามที่มีการอ้างถึงใน นโยบายนโยบายคำขอราคาเสนอบริการ จะมีความหมายก็ต่อเมื่อ TargetEndpoint อ้างอิง ไปยังปลายทาง TLS/SSL

 คำขอพร็อกซี
servicecallout.policy_name.target.url สตริง อ่าน/เขียน

URL ของ TargetEndpoint สำหรับนโยบาย Serviceข้อความเสริม นั้นๆ

 คำขอพร็อกซี
servicecallout.requesturi สตริง อ่าน/เขียน

URI ของ TargetEndpoint สำหรับนโยบายนโยบาย Servicecallout 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.timestamp เช่น "Wed, 21 Aug 2013 19:16:47 UTC" สอดคล้องกับ ค่าการประทับเวลา "1377112607413"

 คำขอพร็อกซี
system.time.year จำนวนเต็ม อ่านอย่างเดียว

ส่วนปีของ system.time

 คำขอพร็อกซี
system.time.month จำนวนเต็ม อ่านอย่างเดียว

ส่วนเดือนของ system.time

 คำขอพร็อกซี
system.time.day จำนวนเต็ม อ่านอย่างเดียว

ส่วนวันของเดือนของ system.time

 คำขอพร็อกซี
system.time.dayofweek จำนวนเต็ม อ่านอย่างเดียว

ส่วนวันของสัปดาห์ของ system.time

 คำขอพร็อกซี
system.time.hour จำนวนเต็ม อ่านอย่างเดียว

ส่วนชั่วโมงของ system.time

 คำขอพร็อกซี
system.time.minute จำนวนเต็ม อ่านอย่างเดียว

ส่วนนาทีของ system.time

 คำขอพร็อกซี
system.time.second จำนวนเต็ม อ่านอย่างเดียว

ส่วนที่ 2 ของ system.time

 คำขอพร็อกซี
system.time.millisecond จำนวนเต็ม อ่านอย่างเดียว

ส่วนมิลลิวินาทีของ system.time

 คำขอพร็อกซี
system.time.zone สตริง อ่านอย่างเดียว

เขตเวลาของระบบ

 คำขอพร็อกซี
system.timestamp ยาว อ่านอย่างเดียว

จำนวนเต็ม 64 บิต (ยาว) แสดงเวลาที่มีการอ่านตัวแปรนี้ ค่า คือจำนวนมิลลิวินาทีที่ผ่านไปนับตั้งแต่เที่ยงคืนของวันที่ 1 มกราคม 1970 UTC ตัวอย่างเช่น "1534783015000"

 คำขอพร็อกซี
system.uuid สตริง อ่านอย่างเดียว

UUID ของโปรแกรมประมวลผลข้อความที่จัดการพร็อกซี

 คำขอพร็อกซี

target

อธิบายเป้าหมายของคำขอ

ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร target

พร็อพเพอร์ตี้ ประเภท อ่าน/เขียน คำอธิบาย เริ่มต้นขอบเขต
target.basepath สตริง อ่านอย่างเดียว

เส้นทางทรัพยากร (ไม่รวมโดเมน) ไปยังบริการเป้าหมาย โดยไม่รวมการค้นหา ที่กำหนดใน TargetEndpoint ของพร็อกซี

ตัวอย่างเช่น สมมติว่าพร็อกซี API เรียกใช้เป้าหมายต่อไปนี้

<TargetEndpoint name="default">
...
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
  </HTTPTargetConnection>

ในตัวอย่างนี้ target.basepath คือ "/user"

หากเป้าหมายคือ

<TargetEndpoint name="default">
...
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>

target.basepath จะเป็นค่าว่าง

 คำขอเป้าหมาย
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.
  timestamp		 ยาว อ่านอย่างเดียว

ค่าการประทับเวลาที่ระบุเมื่อ 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.
  timestamp		 ยาว อ่านอย่างเดียว

ค่าการประทับเวลาที่ระบุเวลาที่ 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 บิต จำนวนเต็ม (long) ซึ่งมีจำนวนมิลลิวินาทีที่ผ่านไปนับตั้งแต่เที่ยงคืนของวันที่ 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 เป้าหมายแบบไดนามิก (หาก target.url ได้รับการตั้งค่าระหว่างโฟลว์ข้อความ) ตัวแปรนี้ไม่มีข้อมูลใดๆ เอลิเมนต์เส้นทางเพิ่มเติมหรือพารามิเตอร์การค้นหา แสดงผล Null หากเรียกใช้นอกขอบเขตหรือ หรือไม่ตั้งค่า

 คำขอเป้าหมาย

variable

คอนเทนเนอร์ของพร็อพเพอร์ตี้ variable.expectedcn

ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร variable

พร็อพเพอร์ตี้ ประเภท อ่าน/เขียน คำอธิบาย เริ่มต้นขอบเขต
variable.expectedcn สตริง อ่าน/เขียน

มีการเปิดเผยตัวแปรสำหรับชื่อทั่วไปหากทำงานบน TLS/SSL

 คำขอพร็อกซี

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการใช้งาน TLS โปรดดู การเปิดตัว TLS/SSL

virtualhost

ระบุรายละเอียดเกี่ยวกับโฮสต์เสมือน

ตารางต่อไปนี้อธิบายพร็อพเพอร์ตี้ของตัวแปร virtualhost

พร็อพเพอร์ตี้ ประเภท อ่าน/เขียน คำอธิบาย เริ่มต้นขอบเขต
virtualhost.aliases.values อาร์เรย์ของสตริง อ่านอย่างเดียว

ชื่อแทนโฮสต์ของโฮสต์เสมือนที่มีการใช้ระหว่างคำขอหนึ่งๆ

 คำขอพร็อกซี
virtualhost.name สตริง อ่านอย่างเดียว

ชื่อของโฮสต์เสมือนที่ให้บริการคำขอของไคลเอ็นต์ต้นทาง

 คำขอพร็อกซี
virtualhost.ssl.enabled บูลีน อ่านอย่างเดียว

แสดงค่า "true" หากเปิดใช้ TLS/SSL ในการกำหนดค่าโฮสต์เสมือน

 คำขอพร็อกซี

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการทำงานกับโฮสต์เสมือน โปรดดู การกำหนดค่าโฮสต์เสมือน