คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
Edge Microgateway เวอร์ชัน 2.4.x
ภาพรวม
หัวข้อนี้จะกล่าวถึงวิธีจัดการและกำหนดค่า Edge Microgateway รวมถึงการตรวจสอบ การบันทึก และการแก้ไขข้อบกพร่อง
เปลี่ยนการกำหนดค่า
ไฟล์การกำหนดค่าที่คุณต้องทราบมีดังนี้
- ไฟล์การกำหนดค่าระบบเริ่มต้น
- ไฟล์การกำหนดค่าเริ่มต้นสำหรับอินสแตนซ์ Edge Microgateway ที่เริ่มต้นใหม่
- ไฟล์การกำหนดค่าแบบไดนามิกสำหรับอินสแตนซ์ที่ทำงานอยู่
ส่วนนี้จะอธิบายเกี่ยวกับไฟล์เหล่านี้และสิ่งที่คุณจำเป็นต้องทราบเกี่ยวกับการเปลี่ยนแปลงไฟล์ดังกล่าว โปรดดูรายละเอียดเกี่ยวกับการตั้งค่าไฟล์การกำหนดค่าที่ข้อมูลอ้างอิงการกำหนดค่า Edge Microgateway
ไฟล์การกำหนดค่าระบบเริ่มต้น
เมื่อติดตั้ง Edge Microgateway ไฟล์การกำหนดค่าระบบเริ่มต้นจะวางไว้ที่นี่
[prefix]/lib/node_modules/edgemicro/config/default.yaml
โดยที่ [prefix]
คือไดเรกทอรีคำนำหน้า npm
ดูว่าEdge Microgateway ติดตั้งอยู่ที่ใด
หากเปลี่ยนไฟล์การกำหนดค่าของระบบ คุณจะต้องเริ่มต้น กำหนดค่า และรีสตาร์ท Edge Microgateway ดังนี้
- โทร
edgemicro init
- โทร
edgemicro configure [params]
- โทร
edgemicro start [params]
ไฟล์การกำหนดค่าเริ่มต้นสำหรับอินสแตนซ์ Edge Microgateway ที่เริ่มต้นใหม่
เมื่อเรียกใช้ edgemicro init
ไฟล์การกำหนดค่าระบบ (ตามที่อธิบายไว้ด้านบน) default.yaml
จะอยู่ในไดเรกทอรีนี้: ~/.edgemicro
หากคุณเปลี่ยนไฟล์การกำหนดค่าใน ~/.edgemicro
คุณต้องกำหนดค่าอีกครั้งและรีสตาร์ท Edge Microgateway ดังนี้
edgemicro stop
edgemicro configure
[params]
edgemicro start
[params]
ไฟล์การกำหนดค่าแบบไดนามิกสำหรับอินสแตนซ์ที่ทำงานอยู่
เมื่อคุณเรียกใช้ edgemicro configure [params]
ระบบจะสร้างไฟล์การกำหนดค่าแบบไดนามิกใน ~/.edgemicro
ไฟล์จะมีชื่อตามรูปแบบนี้ [org]-[env]-config.yaml
โดยที่ org
และ env
คือชื่อองค์กรและสภาพแวดล้อม Apigee Edge ของคุณ คุณสามารถใช้ไฟล์นี้เพื่อทำการเปลี่ยนแปลงการกำหนดค่า แล้วโหลดอีกครั้งโดยไม่มีช่วงพัก ตัวอย่างเช่น หากคุณเพิ่มและกำหนดค่าปลั๊กอิน คุณจะโหลดการกำหนดค่าซ้ำได้โดยไม่เกิดช่วงพักการใช้งานตามที่อธิบายไว้ด้านล่าง
หาก Edge Microgateway ทำงานอยู่ (ตัวเลือกช่วงพักเป็นศูนย์)
- โหลดการกำหนดค่า Edge Microgateway ซ้ำ:
edgemicro reload -o [org] -e [env] -k [key] -s [secret]
โดยที่
org
คือชื่อองค์กร Edge ของคุณ (คุณต้องเป็นผู้ดูแลระบบองค์กร)env
คือสภาพแวดล้อมในองค์กรของคุณ (เช่น การทดสอบหรือเวอร์ชันที่ใช้งานจริง)key
เป็นคีย์ที่แสดงผลก่อนหน้านี้โดยคำสั่งการกำหนดค่าsecret
คือคีย์ที่แสดงผลก่อนหน้านี้โดยคำสั่ง "กำหนดค่า"
ตัวอย่าง
edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d000723 -s 05c14356e42ed136b8dd35cf8a18531ff52d7299134677e30ef4e34ab0cc824
หาก Edge Microgateway หยุดทำงาน:
- รีสตาร์ท Edge Microgateway:
edgemicro start -o [org] -e [env] -k [key] -s [secret]
โดยที่
org
คือชื่อองค์กร Edge ของคุณ (คุณต้องเป็นผู้ดูแลระบบองค์กร)env
คือสภาพแวดล้อมในองค์กรของคุณ (เช่น การทดสอบหรือเวอร์ชันที่ใช้งานจริง)key
เป็นคีย์ที่แสดงผลก่อนหน้านี้โดยคำสั่งการกำหนดค่าsecret
คือคีย์ที่แสดงผลก่อนหน้านี้โดยคำสั่ง "กำหนดค่า"
ตัวอย่าง
edgemicro start -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d000723 -s 05c14356e42ed136b8dd35cf8a18531ff52d7299134677e30ef4e34ab0cc824
ตัวอย่างไฟล์การกำหนดค่า โปรดดูรายละเอียดเกี่ยวกับการตั้งค่าไฟล์การกำหนดค่าที่ข้อมูลอ้างอิงการกำหนดค่า Edge Microgateway
edge_config: bootstrap: >- https://edgemicroservices-us-east-1.apigee.net/edgemicro/bootstrap/organization/docs/environment/test jwt_public_key: 'https://docs-test.apigee.net/edgemicro-auth/publicKey' managementUri: 'https://api.enterprise.apigee.com' vaultName: microgateway authUri: 'https://%s-%s.apigee.net/edgemicro-auth' baseUri: >- https://edgemicroservices.apigee.net/edgemicro/%s/organization/%s/environment/%s bootstrapMessage: Please copy the following property to the edge micro agent config keySecretMessage: The following credentials are required to start edge micro products: 'https://docs-test.apigee.net/edgemicro-auth/products' edgemicro: port: 8000 max_connections: 1000 max_connections_hard: 5000 config_change_poll_interval: 600 logging: level: error dir: /var/tmp stats_log_interval: 60 rotate_interval: 24 plugins: sequence: - oauth headers: x-forwarded-for: true x-forwarded-host: true x-request-id: true x-response-time: true via: true oauth: allowNoAuthorization: false allowInvalidAuthorization: false verify_api_key_url: 'https://docs-test.apigee.net/edgemicro-auth/verifyApiKey' analytics: uri: >- https://edgemicroservices-us-east-1.apigee.net/edgemicro/axpublisher/organization/docs/environment/test
การตั้งค่าตัวแปรสภาพแวดล้อม
คำสั่งของอินเทอร์เฟซบรรทัดคำสั่งที่ต้องมีค่าสำหรับองค์กรและสภาพแวดล้อม Edge รวมถึงเก็บคีย์และข้อมูลลับที่จำเป็นสำหรับการเริ่มต้น Edge Microgateway ไว้ในตัวแปรสภาพแวดล้อมเหล่านี้ได้
EDGEMICRO_ORG
EDGEMICRO_ENV
EDGEMICRO_KEY
EDGEMICRO_SECRET
การตั้งค่าตัวแปรเหล่านี้เป็นตัวเลือกที่ไม่บังคับ หากคุณตั้งค่าไว้ คุณไม่ต้องระบุค่าเมื่อใช้ Command-Line Interface (CLI) เพื่อกำหนดค่าและเริ่ม Edge Microgateway
การกำหนดค่า SSL ในเซิร์ฟเวอร์ Edge Microgateway
คุณสามารถกำหนดค่าเซิร์ฟเวอร์ Microgateway ให้ใช้ SSL เช่น เมื่อกำหนดค่า SSL แล้ว คุณจะเรียกใช้ API ผ่าน Edge Microgateway ด้วยโปรโตคอล "https" ได้ ดังตัวอย่างต่อไปนี้
https://localhost:8000/myapi
หากต้องการกำหนดค่า SSL ในเซิร์ฟเวอร์ Microgateway ให้ทำตามขั้นตอนต่อไปนี้:
- สร้างหรือรับใบรับรอง SSL และคีย์โดยใช้ยูทิลิตี openssl หรือวิธีที่คุณต้องการ
- เพิ่มแอตทริบิวต์
edgemicro:ssl
ลงในไฟล์การกำหนดค่า Edge Microgateway สำหรับรายการตัวเลือกทั้งหมด โปรดดูตารางด้านล่าง โปรดดูรายละเอียดเกี่ยวกับการแก้ไขการกำหนดค่า Edge Microgateway ที่หัวข้อการเปลี่ยนแปลงการกำหนดค่า ตัวอย่างเช่น
edgemicro: ssl: key: <absolute path to the SSL key file> cert: <absolute path to the SSL cert file> passphrase: admin123 #option added in v2.2.2 rejectUnauthorized: true #option added in v2.2.2 requestCert: true
- รีสตาร์ท Edge Microgateway ทำตามขั้นตอนที่ระบุไว้ในส่วนเปลี่ยนแปลงการกำหนดค่า โดยขึ้นอยู่กับไฟล์การกำหนดค่าที่คุณแก้ไข ซึ่งอาจเป็นไฟล์เริ่มต้นหรือไฟล์การกำหนดค่ารันไทม์
ตัวอย่างส่วน edgemicro ของไฟล์การกำหนดค่าที่มีการกำหนดค่า SSL อยู่
edgemicro: port: 8000 max_connections: 1000 max_connections_hard: 5000 logging: level: error dir: /var/tmp stats_log_interval: 60 rotate_interval: 24 plugins: sequence: - oauth ssl: key: /MyHome/SSL/em-ssl-keys/server.key cert: /MyHome/SSL/em-ssl-keys/server.crt passphrase: admin123 #option added in v2.2.2 rejectUnauthorized: true #option added in v2.2.2
รายการตัวเลือกเซิร์ฟเวอร์ทั้งหมดที่รองรับมีดังนี้
ตัวเลือก | คำอธิบาย |
---|---|
key |
เส้นทางไปยังไฟล์ ca.key (ในรูปแบบ PEM) |
cert |
เส้นทางไปยังไฟล์ ca.cert (ในรูปแบบ PEM) |
pfx |
เส้นทางไปยังไฟล์ pfx ที่มีคีย์ส่วนตัว ใบรับรอง และใบรับรอง CA ของไคลเอ็นต์ในรูปแบบ PFX |
passphrase |
สตริงที่มีข้อความรหัสผ่านสำหรับคีย์ส่วนตัวหรือ PFX |
ca |
เส้นทางไปยังไฟล์ที่มีรายการใบรับรองที่เชื่อถือได้ในรูปแบบ PEM |
ciphers |
สตริงที่อธิบายการเข้ารหัสที่จะใช้โดยคั่นด้วย ":" |
rejectUnauthorized |
หากเป็น "จริง" ใบรับรองเซิร์ฟเวอร์จะได้รับการยืนยันกับรายการ CA ที่ระบุ หากยืนยันไม่สำเร็จ ระบบจะแสดงข้อผิดพลาด |
secureProtocol |
วิธี SSL ที่จะใช้ เช่น SSLv3_method เพื่อบังคับใช้ SSL เวอร์ชัน 3 |
servername |
ชื่อเซิร์ฟเวอร์สำหรับส่วนขยาย TLS แบบ SNI (การระบุชื่อเซิร์ฟเวอร์) |
requestCert |
จริงสำหรับ SSL แบบ 2 ทาง เท็จสำหรับ SSL แบบทางเดียว |
การใช้ตัวเลือก SSL/TLS ของไคลเอ็นต์
คุณกำหนดค่า Edge Microgateway เป็นไคลเอ็นต์ TLS หรือ SSL ได้เมื่อเชื่อมต่อกับปลายทางเป้าหมาย ในไฟล์การกำหนดค่า Microgateway ให้ใช้องค์ประกอบเป้าหมายเพื่อตั้งค่าตัวเลือก SSL/TLS
ตัวอย่างนี้มีการตั้งค่าที่จะนำไปใช้กับโฮสต์ทั้งหมด
targets: ssl: client: key: /Users/jdoe/nodecellar/twowayssl/ssl/client.key cert: /Users/jdoe/nodecellar/twowayssl/ssl/ca.crt passphrase: admin123 rejectUnauthorized: true
ในตัวอย่างนี้ การตั้งค่าจะมีผลกับโฮสต์ที่ระบุเท่านั้น
targets: host: 'myserver.example.com' ssl: client: key: /Users/myname/twowayssl/ssl/client.key cert: /Users/myname/twowayssl/ssl/ca.crt passphrase: admin123 rejectUnauthorized: true
ต่อไปนี้คือตัวอย่างของ TLS
targets: host: 'myserver.example.com' tls: client: pfx: /Users/myname/twowayssl/ssl/client.pfx passphrase: admin123 rejectUnauthorized: true
รายการตัวเลือกไคลเอ็นต์ทั้งหมดที่รองรับมีดังนี้
ตัวเลือก | คำอธิบาย |
---|---|
pfx |
เส้นทางไปยังไฟล์ pfx ที่มีคีย์ส่วนตัว ใบรับรอง และใบรับรอง CA ของไคลเอ็นต์ในรูปแบบ PFX |
key |
เส้นทางไปยังไฟล์ ca.key (ในรูปแบบ PEM) |
passphrase |
สตริงที่มีข้อความรหัสผ่านสำหรับคีย์ส่วนตัวหรือ PFX |
cert |
เส้นทางไปยังไฟล์ ca.cert (ในรูปแบบ PEM) |
ca |
เส้นทางไปยังไฟล์ที่มีรายการใบรับรองที่เชื่อถือได้ในรูปแบบ PEM |
ciphers |
สตริงที่อธิบายการเข้ารหัสที่จะใช้โดยคั่นด้วย ":" |
rejectUnauthorized |
หากเป็น "จริง" ใบรับรองเซิร์ฟเวอร์จะได้รับการยืนยันกับรายการ CA ที่ระบุ หากยืนยันไม่สำเร็จ ระบบจะแสดงข้อผิดพลาด |
secureProtocol |
วิธี SSL ที่จะใช้ เช่น SSLv3_method เพื่อบังคับใช้ SSL เวอร์ชัน 3 |
servername |
ชื่อเซิร์ฟเวอร์สำหรับส่วนขยาย TLS แบบ SNI (การระบุชื่อเซิร์ฟเวอร์) |
การปรับแต่งพร็อกซีการตรวจสอบสิทธิ์ edgemicro-auth
โดยค่าเริ่มต้น Edge Microgateway จะใช้พร็อกซีที่ทำให้ใช้งานได้ใน Apigee Edge สำหรับการตรวจสอบสิทธิ์ OAuth2
ทำให้พร็อกซีนี้ใช้งานได้เมื่อคุณเรียกใช้ edgemicro configure
ครั้งแรก คุณสามารถเปลี่ยนการกำหนดค่าเริ่มต้นของพร็อกซีนี้เพื่อเพิ่มการสนับสนุนสำหรับการอ้างสิทธิ์ที่กำหนดเองไปยังโทเค็นเว็บ JSON (JWT) กำหนดค่าการหมดอายุของโทเค็น และสร้างโทเค็นการรีเฟรช โปรดดูรายละเอียดที่หน้า edgemicro-auth ใน GitHub
การใช้บริการตรวจสอบสิทธิ์ที่กำหนดเอง
โดยค่าเริ่มต้น Edge Microgateway จะใช้พร็อกซีที่ทำให้ใช้งานได้ใน Apigee Edge สำหรับการตรวจสอบสิทธิ์ OAuth2
ทำให้พร็อกซีนี้ใช้งานได้เมื่อคุณเรียกใช้ edgemicro configure
ครั้งแรก โดยค่าเริ่มต้น URL ของพร็อกซีนี้จะระบุในไฟล์การกำหนดค่า Edge Microgateway ดังนี้
authUri: https://myorg-myenv.apigee.net/edgemicro-auth
หากต้องการใช้บริการที่กำหนดเองเพื่อจัดการการตรวจสอบสิทธิ์ ให้เปลี่ยนค่า authUri
ในไฟล์การกำหนดค่าเพื่อชี้ไปยังบริการ เช่น คุณอาจมีบริการที่ใช้ LDAP เพื่อยืนยันตัวตน
การจัดการไฟล์บันทึก
Edge Microgateway จะบันทึกข้อมูลเกี่ยวกับคำขอและการตอบกลับแต่ละรายการ ไฟล์บันทึกจะให้ข้อมูลที่เป็นประโยชน์ในการแก้ไขข้อบกพร่องและการแก้ปัญหา
ตำแหน่งที่ใช้เก็บไฟล์บันทึก
โดยค่าเริ่มต้น ไฟล์บันทึกจะจัดเก็บไว้ใน /var/tmp
วิธีเปลี่ยนไดเรกทอรีของไฟล์บันทึกเริ่มต้น
ไดเรกทอรีที่เก็บไฟล์บันทึกมีการระบุไว้ในไฟล์การกำหนดค่า Edge Microgateway โปรดดูรายละเอียดเกี่ยวกับการเปลี่ยนแปลงการกําหนดค่าที่หัวข้อการเปลี่ยนแปลงการกําหนดค่า
edgemicro: home: ../gateway port: 8000 max_connections: -1 max_connections_hard: -1 logging: level: info dir: /var/tmp stats_log_interval: 60 rotate_interval: 24
เปลี่ยนค่า dir เพื่อระบุไดเรกทอรีของไฟล์บันทึกอื่น
ส่งบันทึกไปยังคอนโซล
คุณอาจกำหนดค่าการบันทึกเพื่อให้ส่งข้อมูลบันทึกไปยังเอาต์พุตมาตรฐานแทนที่จะส่งไปยังไฟล์บันทึกได้ ตั้งค่าแฟล็ก to_console
เป็น "จริง" ดังนี้
edgemicro: logging: to_console: true
เมื่อใช้การตั้งค่านี้ ระบบจะส่งบันทึกไปยังแบบมาตรฐาน ขณะนี้คุณจะส่งบันทึกไปยังทั้ง Stdout และไฟล์บันทึกไม่ได้
วิธีตั้งค่าระดับการบันทึก
คุณตั้งค่าระดับการบันทึกเหล่านี้ได้: ข้อมูล คำเตือน และข้อผิดพลาด ขอแนะนำให้ใช้ระดับข้อมูล โดยจะบันทึกคำขอและการตอบกลับ API ทั้งหมด ซึ่งเป็นค่าเริ่มต้น
วิธีเปลี่ยนช่วงเวลาบันทึก
คุณจะกำหนดค่าช่วงเวลาเหล่านี้ได้ในไฟล์การกำหนดค่า Edge Microgateway โปรดดูรายละเอียดเกี่ยวกับการเปลี่ยนแปลงการกำหนดค่าที่การเปลี่ยนการกำหนดค่า
แอตทริบิวต์ที่กำหนดค่าได้มีดังนี้
- stats_log_interval: (ค่าเริ่มต้น: 60) ช่วงเวลาในหน่วยวินาทีที่มีการเขียนระเบียนสถิติลงในไฟล์บันทึก API
- rotate_interval: (ค่าเริ่มต้น: 24) ช่วงเวลาเป็นชั่วโมงเมื่อหมุนไฟล์บันทึก เช่น
edgemicro: home: ../gateway port: 8000 max_connections: -1 max_connections_hard: -1 logging: level: info dir: /var/tmp stats_log_interval: 60 rotate_interval: 24
หมายเหตุ: ระบบจะไม่บีบอัดไฟล์บันทึกที่เก็บถาวร เมื่อช่วงเวลาเริ่มต้น ระบบจะสร้างไฟล์บันทึกใหม่พร้อมการประทับเวลาใหม่
แนวทางปฏิบัติที่ดีในการบำรุงรักษาไฟล์บันทึก
เมื่อข้อมูลไฟล์บันทึกสะสมไปเรื่อยๆ Apigee จึงขอแนะนำให้ทำตามแนวทางปฏิบัติต่อไปนี้
- เนื่องจากไฟล์บันทึกอาจมีขนาดค่อนข้างใหญ่ โปรดตรวจสอบว่าไดเรกทอรีของไฟล์บันทึกนั้นมีพื้นที่ว่างเพียงพอ โปรดดูหัวข้อตำแหน่งจัดเก็บไฟล์บันทึกและวิธีเปลี่ยนไดเรกทอรีไฟล์บันทึกเริ่มต้น
- ลบหรือย้ายไฟล์บันทึกไปยังไดเรกทอรีที่เก็บถาวรแยกต่างหากอย่างน้อยสัปดาห์ละครั้ง
- หากนโยบายคือการลบบันทึก คุณจะใช้คำสั่ง CLI
edgemicro log -c
เพื่อนำบันทึกเก่าออก (ล้าง) ได้
แบบแผนการตั้งชื่อไฟล์บันทึก
อินสแตนซ์ Edge Microgateway แต่ละรายการจะสร้างไฟล์บันทึก 3 ประเภทดังนี้
- api - บันทึกคำขอและการตอบกลับทั้งหมดที่เข้าสู่ Edge Microgateway ระบบจะบันทึกตัวนับ API (สถิติ) และข้อผิดพลาดลงในไฟล์นี้ด้วย
- err - บันทึกทุกอย่างที่ส่งไปยัง stderr
- out - บันทึกทุกอย่างที่ส่งไปยัง stdout
รูปแบบการตั้งชื่อมีดังนี้
edgemicro-<Host Name>-<Instance ID>-<Log Type>.log
เช่น
edgemicro-mymachine-local-MTQzNTgNDMxODAyMQ-api.log edgemicro-mymachine-local-MTQzNTg1NDMODAyMQ-err.log edgemicro-mymachine-local-mtqzntgndmxodaymq-out.log
เกี่ยวกับเนื้อหาในไฟล์บันทึก
เพิ่มแล้วใน v2.3.3
โดยค่าเริ่มต้น บริการบันทึกจะยกเว้น JSON ของพร็อกซี ผลิตภัณฑ์ และ JSON Web Token (JWT) ที่ดาวน์โหลดมา หากคุณต้องการส่งออกออบเจ็กต์เหล่านี้ไปยังไฟล์บันทึก ให้ตั้งค่า DEBUG=*
เมื่อเริ่ม Edge Microgateway เช่น
DEBUG=* edgemicro start -o docs -e test -k abc123 -s xyz456
หมายเหตุ: ใน Windows ให้ใช้ SET DEBUG=*
เนื้อหาของไฟล์บันทึก "api"
ไฟล์บันทึก "api" มีข้อมูลโดยละเอียดเกี่ยวกับโฟลว์คำขอและการตอบกลับผ่าน Edge Microgateway โดยไฟล์บันทึก "api" จะมีชื่อดังนี้
edgemicro-mymachine-local-MTQzNjIxOTk0NzY0Nw-api.log
สำหรับแต่ละคำขอที่ส่งไปยัง Edge Microgateway เหตุการณ์ 4 รายการจะได้รับการบันทึกไว้ในไฟล์บันทึก "api" ดังนี้
- คำขอขาเข้าจากไคลเอ็นต์
- ส่งคำขอขาออกไปยังเป้าหมายแล้ว
- การตอบสนองขาเข้าจากเป้าหมาย
- การตอบกลับไคลเอ็นต์ขาออก
แต่ละรายการที่แยกกันเหล่านี้จะแสดงเป็นสัญลักษณ์แบบย่อเพื่อช่วยให้ไฟล์บันทึกมีขนาดกะทัดรัดมากขึ้น ต่อไปนี้เป็นตัวอย่าง 4 รายการที่แสดงถึงแต่ละเหตุการณ์จาก 4 เหตุการณ์ ในไฟล์บันทึก ข้อมูลจะมีลักษณะดังนี้ (หมายเลขบรรทัดจะใช้สำหรับอ้างอิงในเอกสารเท่านั้น และไม่ปรากฏในไฟล์บันทึก)
(1) 1436403888651 info req m=GET, u=/, h=localhost:8000, r=::1:59715, i=0 (2) 1436403888665 info treq m=GET, u=/, h=127.0.0.18080, i=0 (3) 1436403888672 info tres s=200, d=7, i=0 (4) 1436403888676 info res s=200, d=11, i=0
ลองมาดูทีละรายการกัน
1. ตัวอย่างคำขอขาเข้าจากลูกค้า:
1436403888651 info req m=GET, u=/, h=localhost:8000, r=::1:59715, i=0
- 1436403888651 - การประทับวันที่ Unix
- info - ขึ้นอยู่กับบริบท ซึ่งอาจเป็นข้อมูล คำเตือน หรือข้อผิดพลาด โดยขึ้นอยู่กับระดับของบันทึก ซึ่งอาจเป็นสถิติของระเบียนสถิติ คำเตือนเมื่อได้รับคำเตือน หรือข้อผิดพลาด
- req - ระบุเหตุการณ์ ในกรณีนี้ ให้ส่งคำขอจากไคลเอ็นต์
- m - กริยา HTTP ที่ใช้ในคำขอ
- u - ส่วนของ URL ที่ตามหลัง Basepath
- h - หมายเลขโฮสต์และพอร์ตที่ Edge Microgateway กำลังฟังอยู่
- r - โฮสต์และพอร์ตระยะไกลที่เกิดคำขอของไคลเอ็นต์
- i - รหัสคำขอ ทั้ง 4 รายการจะใช้รหัสนี้ร่วมกัน ระบบจะกำหนดรหัสคำขอที่ไม่ซ้ำกันให้กับคำขอแต่ละรายการ บันทึกความสัมพันธ์กันตามรหัสคำขอสามารถให้ข้อมูลเชิงลึกที่เป็นประโยชน์เกี่ยวกับเวลาในการตอบสนองของเป้าหมาย
- d - ระยะเวลาเป็นมิลลิวินาทีนับจากที่ Edge Microgateway ได้รับคำขอ ในตัวอย่างข้างต้น เป้าหมายการตอบสนองสำหรับคำขอ 0 ได้รับหลังผ่านไป 7 มิลลิวินาที (บรรทัดที่ 3) และระบบส่งการตอบกลับไปยังไคลเอ็นต์หลังผ่านไปอีก 4 มิลลิวินาที (บรรทัดที่ 4) กล่าวคือ เวลาในการตอบสนองคำขอรวมคือ 11 มิลลิวินาที โดยเป้าหมายใช้ไปแล้ว 7 มิลลิวินาที และ Edge Microgateway เองก็อยู่ที่ 4 มิลลิวินาที
2. ตัวอย่างคําขอขาออกที่ส่งไปยังเป้าหมาย
1436403888665 info treq m=GET, u=/, h=127.0.0.1:8080, i=0
- 1436403888651 - การประทับวันที่ Unix
- info - ขึ้นอยู่กับบริบท ซึ่งอาจเป็นข้อมูล คำเตือน หรือข้อผิดพลาด โดยขึ้นอยู่กับระดับของบันทึก ซึ่งอาจเป็นสถิติของระเบียนสถิติ คำเตือนเมื่อได้รับคำเตือน หรือข้อผิดพลาด
- treq - ระบุเหตุการณ์ ซึ่งในกรณีนี้คือคำขอเป้าหมาย
- m - กริยา HTTP ที่ใช้ในคำขอเป้าหมาย
- u - ส่วนของ URL ที่ตามหลัง Basepath
- h - โฮสต์และหมายเลขพอร์ตของเป้าหมายแบ็กเอนด์
- i - รหัสของรายการบันทึก ทั้ง 4 รายการกิจกรรมจะแชร์รหัสนี้
3. ตัวอย่างการตอบกลับขาเข้าจากเป้าหมาย
1436403888672 info tres s=200, d=7, i=0
1436403888651 - การประทับวันที่ Unix
- info - ขึ้นอยู่กับบริบท ซึ่งอาจเป็นข้อมูล คำเตือน หรือข้อผิดพลาด โดยขึ้นอยู่กับระดับของบันทึก ซึ่งอาจเป็นสถิติของระเบียนสถิติ คำเตือนเมื่อได้รับคำเตือน หรือข้อผิดพลาด
- tres - ระบุเหตุการณ์ ในกรณีนี้คือการตอบสนองเป้าหมาย
- s - สถานะการตอบสนอง HTTP
- d - ระยะเวลาเป็นมิลลิวินาที เวลาที่เป้าหมายใช้สำหรับการเรียก API
- i - รหัสของรายการบันทึก ทั้ง 4 รายการกิจกรรมจะแชร์รหัสนี้
4. ตัวอย่างข้อความตอบกลับไคลเอ็นต์
1436403888676 info res s=200, d=11, i=0
1436403888651 - การประทับวันที่ Unix
- info - ขึ้นอยู่กับบริบท ซึ่งอาจเป็นข้อมูล คำเตือน หรือข้อผิดพลาด โดยขึ้นอยู่กับระดับของบันทึก ซึ่งอาจเป็นสถิติของระเบียนสถิติ คำเตือนเมื่อได้รับคำเตือน หรือข้อผิดพลาด
- res - ระบุเหตุการณ์ ในกรณีนี้ ให้ตอบกลับไคลเอ็นต์
- s - สถานะการตอบสนอง HTTP
- d - ระยะเวลาเป็นมิลลิวินาที เวลานี้คือเวลารวมที่ใช้ในการเรียก API รวมถึงเวลาที่ API เป้าหมายใช้และเวลาที่ Edge Microgateway เองใช้
- i - รหัสของรายการบันทึก ทั้ง 4 รายการกิจกรรมจะแชร์รหัสนี้
กำหนดการของไฟล์บันทึก
ระบบจะหมุนเวียนไฟล์บันทึกในช่วงเวลาที่ระบุโดยแอตทริบิวต์การกำหนดค่า rotate_interval ระบบจะยังเพิ่มรายการลงในไฟล์บันทึกเดียวกันต่อไปจนกว่าช่วงการหมุนเวียน จะหมดอายุ อย่างไรก็ตาม ทุกครั้งที่รีสตาร์ท Edge Microgateway อุปกรณ์จะได้รับ UID ใหม่และสร้างไฟล์บันทึกชุดใหม่ที่มี UID นี้ และโปรดดูแนวทางปฏิบัติในการบำรุงรักษาไฟล์บันทึกที่ดี
ข้อมูลอ้างอิงการกำหนดค่า Edge Microgateway
ตำแหน่งของไฟล์การกำหนดค่า
แอตทริบิวต์การกำหนดค่าที่อธิบายในส่วนนี้จะอยู่ในไฟล์การกำหนดค่า Edge Microgateway โปรดดูรายละเอียดเกี่ยวกับการเปลี่ยนแปลงการกําหนดค่าที่หัวข้อการเปลี่ยนแปลงการกําหนดค่า
แอตทริบิวต์ edge_config
การตั้งค่าเหล่านี้ใช้เพื่อกำหนดค่าการโต้ตอบระหว่างอินสแตนซ์ Edge Microgateway และ Apigee Edge
- Bootstrap: (ค่าเริ่มต้น: ไม่มี) URL ที่ชี้ไปยังบริการ Edge Microgateway โดยเฉพาะที่ทำงานบน Apigee Edge Edge Microgateway ใช้บริการนี้เพื่อสื่อสารกับ Apigee Edge โดยจะแสดง URL นี้เมื่อคุณเรียกใช้คำสั่งเพื่อสร้างคู่คีย์สาธารณะ/ส่วนตัว:
edgemicro genkeys
โปรดดูรายละเอียดที่การตั้งค่าและการกำหนดค่า Edge Microgateway - jwt_public_key: (ค่าเริ่มต้น: ไม่มี) URL ที่ชี้ไปยังพร็อกซี Edge Microgateway ที่ทำให้ใช้งานได้ใน Apigee Edge พร็อกซีนี้ทำหน้าที่เป็นปลายทางการตรวจสอบสิทธิ์สำหรับการออกโทเค็นเพื่อการเข้าถึงที่ลงนามไปยังไคลเอ็นต์ โดย URL นี้จะส่งคืนเมื่อคุณเรียกใช้คำสั่งเพื่อทำให้พร็อกซีใช้งานได้: edgemicroconfigure โปรดดูรายละเอียดที่การตั้งค่าและการกำหนดค่า Edge Microgateway
แอตทริบิวต์ edgemicro
การตั้งค่าเหล่านี้จะกําหนดกระบวนการ Edge Microgateway
- port: (ค่าเริ่มต้น: 8000) หมายเลขพอร์ตที่กระบวนการ Edge Microgateway รอฟัง
- max_connections: (ค่าเริ่มต้น: -1) ระบุจำนวนการเชื่อมต่อขาเข้าพร้อมกันสูงสุดที่ Edge Microgateway รับได้ หากเกินจำนวนนี้ ระบบจะแสดงผลสถานะต่อไปนี้
res.statusCode = 429; // Too many requests
- max_connections_hard: (ค่าเริ่มต้น: -1) จำนวนคำขอหลายรายการพร้อมกันที่ Edge Microgateway รับได้ก่อนปิดการเชื่อมต่อ การตั้งค่านี้มีไว้สำหรับขัดขวางการโจมตีแบบปฏิเสธการให้บริการ โดยปกติแล้ว ให้ตั้งค่าเป็นจำนวนที่มากกว่า max_connects
-
การบันทึก:
-
level: (ค่าเริ่มต้น: ข้อผิดพลาด)
- info - บันทึกคำขอและการตอบกลับทั้งหมดที่ไหลผ่านอินสแตนซ์ Edge Microgateway
- warn - บันทึกข้อความเตือนเท่านั้น
- error - บันทึกข้อความแสดงข้อผิดพลาดเท่านั้น
- dir: (ค่าเริ่มต้น: /var/tmp) ไดเรกทอรีที่เก็บไฟล์บันทึก
- stats_log_interval: (ค่าเริ่มต้น: 60) ช่วงเวลาในหน่วยวินาทีที่มีการเขียนระเบียนสถิติลงในไฟล์บันทึก API
- rotate_interval: (ค่าเริ่มต้น: 24) ช่วงเวลาเป็นชั่วโมงเมื่อหมุนไฟล์บันทึก
-
level: (ค่าเริ่มต้น: ข้อผิดพลาด)
- ปลั๊กอิน: ปลั๊กอินจะเพิ่มฟังก์ชันการทำงานให้กับ Edge Microgateway สำหรับรายละเอียดเกี่ยวกับการพัฒนาปลั๊กอิน โปรดดูการพัฒนาปลั๊กอินที่กำหนดเอง
- dir: เส้นทางแบบสัมพัทธ์จากไดเรกทอรี ./gateway ไปยังไดเรกทอรี ./plugins หรือเส้นทางแบบสัมบูรณ์
- sequence: รายการโมดูลปลั๊กอินที่จะเพิ่มในอินสแตนซ์ Edge Microgateway โมดูลจะทำงานตามลำดับที่ระบุไว้ที่นี่
-
debug: เพิ่มการแก้ไขข้อบกพร่องจากระยะไกลในกระบวนการ Edge Microgateway
- port: หมายเลขพอร์ตที่จะฟัง ตัวอย่างเช่น ตั้งค่าโปรแกรมแก้ไขข้อบกพร่อง IDE ให้รับคำสั่งบนพอร์ตนี้
- args: อาร์กิวเมนต์ของกระบวนการแก้ไขข้อบกพร่อง เช่น
args --nolazy
- config_change_poll_interval: (ค่าเริ่มต้น: 600 วินาที) Edge Microgateway
จะโหลดการกำหนดค่าใหม่เป็นระยะๆ และดำเนินการโหลดซ้ำหากมีการเปลี่ยนแปลง แบบสำรวจจะดึงข้อมูลการเปลี่ยนแปลงที่ทำบน Edge (การเปลี่ยนแปลงผลิตภัณฑ์, พร็อกซี microgateway-aware เป็นต้น) รวมถึงการเปลี่ยนแปลงไฟล์การกำหนดค่าในเครื่อง
- disable_config_poll_interval: (ค่าเริ่มต้น: เท็จ) ตั้งค่าเป็น true เป็นปิดแบบสำรวจการเปลี่ยนแปลงอัตโนมัติ
- request_timeout: ตั้งค่าระยะหมดเวลาสำหรับคำขอเป้าหมาย ระบบจะตั้งค่าระยะหมดเวลาเป็นวินาที หากหมดเวลา Edge Microgateway จะตอบสนองด้วยรหัสสถานะ 504 (เพิ่ม v2.4.x แล้ว)
แอตทริบิวต์ส่วนหัว
การตั้งค่าเหล่านี้จะกำหนดวิธีจัดการส่วนหัว HTTP บางรายการ
- x-forwarded-for: (ค่าเริ่มต้น: true) ตั้งค่าเป็น "เท็จ" เพื่อป้องกันไม่ให้มีการส่งส่วนหัว x-forwarded-for ไปยังเป้าหมาย โปรดทราบว่าหากส่วนหัว x-forwarded-for อยู่ในคำขอ ระบบจะกำหนดค่าของส่วนหัวเป็นค่า client-ip ใน Edge Analytics
- x-forwarded-host: (ค่าเริ่มต้น: true) ตั้งค่าเป็น "เท็จ" เพื่อป้องกันไม่ให้มีการส่งส่วนหัว x-forwarded-host ไปยังเป้าหมาย
- x-request-id: (ค่าเริ่มต้น: true) ตั้งค่าเป็น false เพื่อป้องกันไม่ให้มีการส่งส่วนหัว x-request-id ไปยังเป้าหมาย
- x-Response-time: (ค่าเริ่มต้น: true) ตั้งค่าเป็น false เพื่อป้องกันไม่ให้มีการส่งส่วนหัว x-response-time ไปยังเป้าหมาย
- via: (ค่าเริ่มต้น: true) ตั้งค่าเป็น false เพื่อป้องกันไม่ให้มีการส่งผ่านส่วนหัวไปยังเป้าหมาย
แอตทริบิวต์ oauth
การตั้งค่าเหล่านี้จะกำหนดค่าวิธีบังคับใช้การตรวจสอบสิทธิ์ไคลเอ็นต์โดย Edge Microgateway
- allowNoAuthorization: (ค่าเริ่มต้น: เท็จ) หากตั้งค่าเป็น "จริง" ระบบจะอนุญาตให้การเรียก API ผ่าน Edge Microgateway ได้โดยไม่ต้องมีส่วนหัวการให้สิทธิ์เลย ตั้งค่าเป็น "เท็จ" เพื่อกำหนดให้มีส่วนหัวการให้สิทธิ์ (ค่าเริ่มต้น)
- allowInvalidAuthorization: (ค่าเริ่มต้น: เท็จ) หากตั้งค่าเป็น "จริง" การเรียก API จะได้รับอนุญาตให้ส่งหากโทเค็นที่ส่งผ่านในส่วนหัวการให้สิทธิ์ไม่ถูกต้องหรือหมดอายุ ตั้งค่าเป็น "เท็จ" เพื่อกำหนดให้ใช้โทเค็นที่ถูกต้อง (ค่าเริ่มต้น)
- permissions-header: (ค่าเริ่มต้น: Authorization: Bearer) ส่วนหัวที่ใช้ส่งโทเค็นเพื่อการเข้าถึงไปยัง Edge Microgateway คุณอาจต้องการเปลี่ยนค่าเริ่มต้นในกรณีที่เป้าหมายจำเป็นต้องใช้ส่วนหัวการให้สิทธิ์เพื่อวัตถุประสงค์อื่น
- api-key-header: (ค่าเริ่มต้น: x-api-key) ชื่อของส่วนหัวหรือพารามิเตอร์การค้นหาที่ใช้ส่งคีย์ API ไปยัง Edge Microgateway ดูเพิ่มเติมที่การใช้คีย์ API
- keepAuthHeader: (ค่าเริ่มต้น: false) หากตั้งค่าเป็น "จริง" ส่วนหัวการให้สิทธิ์ที่ส่งในคำขอจะส่งไปยังเป้าหมาย (จะยังคงอยู่)
- allowOAuthOnly - หากตั้งค่าเป็น "จริง" API ทุกรายการต้องมีส่วนหัวการให้สิทธิ์ที่มีโทเค็นเพื่อการเข้าถึงสำหรับผู้ถือ อนุญาตให้คุณอนุญาตเฉพาะโมเดลความปลอดภัยของ OAuth เท่านั้น (โดยยังคงรักษาความเข้ากันได้แบบย้อนหลัง) (เพิ่ม 4.2.x)
- allowAPIKeyOnly -- หากตั้งค่าเป็น "จริง" API ทุกรายการต้องมีส่วนหัว x-api-key (หรือตำแหน่งที่กำหนดเอง) พร้อมคีย์ API อนุญาตให้คุณอนุญาตเฉพาะโมเดลความปลอดภัยคีย์ API เท่านั้น (ขณะที่ยังรักษาความเข้ากันได้แบบย้อนหลัง) (เพิ่มเวอร์ชัน 4.2.x)
แอตทริบิวต์เฉพาะปลั๊กอิน
ดู การใช้ปลั๊กอิน สำหรับรายละเอียดเกี่ยวกับแอตทริบิวต์ที่กำหนดค่าได้สำหรับแต่ละปลั๊กอิน
การกรองพร็อกซี
คุณกรองพร็อกซีที่รับรู้ Microgateway ที่อินสแตนซ์ Edge Microgateway จะประมวลผลได้
เมื่อ Edge Microgateway เริ่มทำงาน ระบบจะดาวน์โหลดพร็อกซี Microgateway-Aware ทั้งหมดในองค์กรที่เชื่อมโยงไว้ ใช้การกำหนดค่าต่อไปนี้เพื่อจำกัดพร็อกซีที่ไมโครเกตเวย์จะประมวลผล ตัวอย่างเช่น การกำหนดค่านี้จำกัดพร็อกซีที่ไมโครเกตเวย์จะประมวลผลเป็น 3 ประเภทดังนี้ edgemicro_proxy-1
, edgemicro_proxy-2
และ edgemicro_proxy-3
proxies: - edgemicro_proxy-1 - edgemicro_proxy-2 - edgemicro_proxy-3
การมาสก์ข้อมูลวิเคราะห์
การกำหนดค่าต่อไปนี้ป้องกันไม่ให้ข้อมูลเส้นทางคำขอแสดงในข้อมูลวิเคราะห์ Edge เพิ่มข้อมูลต่อไปนี้ลงในการกำหนดค่า Microgateway เพื่อมาสก์ URI คำขอและ/หรือเส้นทางคำขอ โปรดทราบว่า URI ประกอบด้วยชื่อโฮสต์และเส้นทางของคำขอ
analytics: mask_request_uri: 'string_to_mask' mask_request_path: 'string_to_mask'
การตั้งค่า Edge Microgateway เบื้องหลังไฟร์วอลล์ของบริษัท
รองรับ v4.2.x
หากติดตั้ง Edge Microgateway ไว้หลังไฟร์วอลล์ เกตเวย์อาจไม่สามารถสื่อสารกับ Apigee Edge ได้ ในกรณีนี้ มี 2 ตัวเลือกที่คุณสามารถพิจารณา ได้แก่
ตัวเลือก 1
ตัวเลือกที่ 1 คือตั้งค่าตัวเลือก edgemicro: proxy_tunnel ให้เป็นจริงในไฟล์การกำหนดค่า microgateway ดังนี้
edge_config: proxy: http://10.224.16.85:3128 proxy_tunnel: true
เมื่อ proxy_tunnel เป็น true Edge Microgateway จะใช้เมธอด HTTP CONNECT เพื่ออุโมงค์ข้อมูลคำขอ HTTP ผ่านการเชื่อมต่อ TCP รายการเดียว (กรณีนี้จะเกิดขึ้นหากตัวแปรสภาพแวดล้อมสำหรับการกำหนดค่าพร็อกซีเปิดใช้ TLS ด้วย)
ตัวเลือก 2
ตัวเลือกที่ 2 คือการระบุพร็อกซีและตั้งค่าพร็อกซี_tunnel เป็น "เท็จ" ในไฟล์การกำหนดค่า microgateway เช่น
edge_config: proxy: http://10.224.16.85:3128 proxy_tunnel: false
ในกรณีนี้ คุณตั้งค่าตัวแปรต่อไปนี้เพื่อควบคุมโฮสต์ของพร็อกซี HTTP แต่ละรายการที่ต้องการใช้ หรือโฮสต์ที่ไม่ควรจัดการพร็อกซี Edge Microgateway ได้: HTTP_PROXY, HTTPS_PROXY และ NO_PROXY
คุณตั้งค่า NO_PROXY เป็นรายการโดเมนที่คั่นด้วยคอมมา ซึ่ง Edge Microgateway ไม่ควรทำหน้าที่เป็นพร็อกซีให้ เช่น
export NO_PROXY='localhost,localhost:8080'
ตั้งค่า HTTP_PROXY และ HTTPS_PROXY เป็น Edge Microgateway สำหรับปลายทางของพร็อกซี HTTP จะส่งข้อความไปได้ เช่น
export HTTP_PROXY='http://localhost:3786' export HTTPS_PROXY='https://localhost:3786'
ดูข้อมูลเพิ่มเติมเกี่ยวกับตัวแปรเหล่านี้ได้ที่
https://www.npmjs.com/package/request#controlling-proxy-behaviour-using-environment-variables
ดูเพิ่มเติม
วิธีตั้งค่า Edge Microgateway หลังไฟร์วอลล์ของบริษัทในชุมชน Apigee
การใช้ไวลด์การ์ดในพร็อกซีที่รับรู้ถึง Microgateway
คุณใช้ไวลด์การ์ด "*" ได้อย่างน้อย 1 รายการในเส้นทางฐานของพร็อกซี edgemicro_* (Microgateway-aware) เช่น เส้นทางฐานของ /team/*/members จะช่วยให้ไคลเอ็นต์เรียกใช้ https://[host]/team/blue/members และ https://[host]/team/green/members ได้โดยไม่ต้องสร้างพร็อกซี API ใหม่เพื่อสนับสนุนทีมใหม่ โปรดทราบว่าไม่รองรับ /**/
สำคัญ: Apigee ไม่รองรับการใช้ไวลด์การ์ด "*" เป็นองค์ประกอบแรกของเส้นทางฐาน เช่น การค้นหาแบบ "/*/
" "ไม่รองรับ"
การแก้ไขข้อบกพร่องและการแก้ปัญหา
กำลังเชื่อมต่อกับโปรแกรมแก้ไขข้อบกพร่อง
คุณสามารถเรียกใช้ Edge Microgateway กับโปรแกรมแก้ไขข้อบกพร่อง เช่น เครื่องมือตรวจสอบโหนด ซึ่งเป็นประโยชน์ในการแก้ปัญหาและแก้ไขข้อบกพร่องของปลั๊กอินที่กำหนดเอง
- รีสตาร์ท Edge Microgateway ในโหมดแก้ไขข้อบกพร่อง ในการดำเนินการดังกล่าว ให้เพิ่ม
DEBUG=*
ด้านหน้าของคำสั่งเริ่มต้น ดังตัวอย่างต่อไปนี้
DEBUG=* edgemicro start -o myorg -e test -k db4e9e8a95aa7fabfdeacbb1169d0a8cbe42bec19c6b98129e02 -s 6e56af7c1b26dfe93dae78a735c8afc9796b077d105ae5618ce7ed
หมายเหตุ: ใน Windows ให้ใช้
SET DEBUG=*
- เริ่มใช้โปรแกรมแก้ไขข้อบกพร่องและตั้งค่าเพื่อฟังหมายเลขพอร์ตสำหรับกระบวนการแก้ไขข้อบกพร่อง
- ตอนนี้คุณสามารถดูโค้ด Edge Microgateway, ตั้งค่าเบรกพอยท์, นิพจน์การดู และอื่นๆ ได้แล้ว
คุณระบุแฟล็ก Node.js มาตรฐานที่เกี่ยวข้องกับโหมดแก้ไขข้อบกพร่องได้ ตัวอย่างเช่น --nolazy
จะช่วยแก้ไขข้อบกพร่องของโค้ดแบบอะซิงโครนัส
กำลังตรวจสอบไฟล์บันทึก
หากพบปัญหา โปรดตรวจสอบไฟล์บันทึกเพื่อดูรายละเอียดการดำเนินการและข้อมูลข้อผิดพลาด โปรดดูรายละเอียดที่หัวข้อการจัดการไฟล์บันทึก
การใช้การรักษาความปลอดภัยคีย์ API
คีย์ API เป็นกลไกแบบง่ายๆ ในการตรวจสอบสิทธิ์ไคลเอ็นต์ที่ส่งคำขอไปยัง Edge Microgateway คุณรับคีย์ API ได้โดยการคัดลอกค่าคีย์ผู้บริโภค (หรือเรียกอีกอย่างว่ารหัสไคลเอ็นต์) จากผลิตภัณฑ์ Apigee Edge ที่มีพร็อกซีการตรวจสอบสิทธิ์ Edge Microgateway
การแคชคีย์
คีย์ API จะแลกเปลี่ยนกับโทเค็นสำหรับผู้ถือ ซึ่งแคชเอาไว้ คุณปิดใช้การแคชได้โดยตั้งค่าส่วนหัว Cache-Control: no-cache
ในคำขอขาเข้าไปยัง Edge Microgateway
การใช้การรักษาความปลอดภัยโทเค็น OAuth2
โปรดดูรายละเอียดเกี่ยวกับการใช้โทเค็น OAuth กับคำขอพร็อกซีที่หัวข้อ Secure Edge Microgateway
การใช้คีย์ API
โปรดดูรายละเอียดเกี่ยวกับการใช้คีย์ API กับคำขอพร็อกซีที่หัวข้อ Secure Edge Microgateway
การกำหนดค่าชื่อคีย์ API
โดยค่าเริ่มต้น x-api-key
คือชื่อที่ใช้สำหรับส่วนหัวคีย์ API หรือพารามิเตอร์การค้นหา คุณสามารถเปลี่ยนค่าเริ่มต้นนี้ในไฟล์การกำหนดค่าได้ตามที่อธิบายไว้ในการเปลี่ยนแปลงการกำหนดค่า
เช่น หากต้องการเปลี่ยนชื่อเป็น apiKey ให้ทำดังนี้
oauth: allowNoAuthorization: false allowInvalidAuthorization: false api-key-header: apiKey