ข้อมูลอ้างอิงการกําหนดค่าพร็อกซีของ API

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

ในฐานะนักพัฒนาซอฟต์แวร์ที่ทำงานร่วมกับ Apigee Edge กิจกรรมการพัฒนาหลักของคุณจะเกี่ยวข้องกับ การกำหนดค่าพร็อกซี API ที่ทำหน้าที่เป็นพร็อกซีสำหรับ API หรือบริการแบ็กเอนด์ เอกสารนี้เป็น การอ้างอิงองค์ประกอบการกำหนดค่าทั้งหมดที่คุณใช้ได้เมื่อสร้างพร็อกซี API

หากคุณกำลังเรียนรู้วิธีสร้างพร็อกซี API ขอแนะนำให้เริ่มต้นจากหัวข้อ สร้าง API แบบง่าย พร็อกซี

วิธีที่นิยมใช้กันมากที่สุดในการแก้ไขการกำหนดค่าพร็อกซี ได้แก่

• การใช้ ตัวแก้ไข XML ภายใน Edge UI
• ดาวน์โหลดการกำหนดค่าและแก้ไขในเครื่อง ตามที่อธิบายไว้ใน Local การพัฒนาการกำหนดค่าพร็อกซี

การพัฒนาการกำหนดค่าพร็อกซีในเครื่อง

คุณดาวน์โหลดการกำหนดค่าพร็อกซีเพื่อแก้ไขในเครื่องได้ วันและเวลา ให้คุณอัปโหลดผลลัพธ์ไปยัง Edge วิธีนี้จะช่วยให้คุณผสานรวมพร็อกซี ลงในการควบคุมต้นทาง การกำหนดเวอร์ชัน และเวิร์กโฟลว์อื่นๆ ที่แชร์ นอกจากนี้ กำหนดค่าพร็อกซีภายในเครื่อง คุณสามารถใช้ตัวแก้ไขและการตรวจสอบ XML ของคุณเอง และเครื่องมือการประมาณที่กำหนดได้เอง

ส่วนนี้จะอธิบายวิธีใช้ UI เพื่อดาวน์โหลดการกำหนดค่าพร็อกซีที่มีอยู่ รวมทั้งวิธีแก้ไข จากนั้นจึงอัปโหลดกลับไปยัง Edge เพื่อทำให้ใช้งานได้ คุณยังสามารถใช้ Apigeetool เพื่อดาวน์โหลดการกำหนดค่าพร็อกซีใหม่และทำให้การกำหนดค่าใช้งานได้ (โดยใช้ fetchproxy และ deployproxy คำสั่ง ตามลำดับ)

วิธีแก้ไขการกำหนดค่าพร็อกซีในเครื่องโดยใช้ UI

1. ดาวน์โหลดการกำหนดค่าพร็อกซีปัจจุบันใน Edge UI (ในพร็อกซี API ดู เลือกโปรเจ็กต์ > ดาวน์โหลดการแก้ไข)
2. สร้างไดเรกทอรีใหม่และขยายไฟล์ ZIP ที่ดาวน์โหลดไว้ในเครื่องของคุณ ได้

   หากต้องการขยายไฟล์ ZIP คุณสามารถใช้ยูทิลิตี เช่น unzip ดังต่อไปนี้ ตัวอย่างได้แก่

   mkdir myappdir
   unzip ./my-app_app_rev3_2019_04_20.zip -d myappdir

   เนื้อหาแบบขยายในไฟล์ ZIP ควรคล้ายกับโครงสร้างที่อธิบายไว้ใน โครงสร้างพร็อกซี API

3. แก้ไขไฟล์ต้นฉบับตามความจำเป็น สำหรับคำอธิบายของไฟล์ต้นฉบับในพร็อกซี การกำหนดค่า โปรดดู ไฟล์การกำหนดค่าและ โครงสร้างไดเรกทอรีของพร็อกซี API

   เช่น หากต้องการเปิดใช้ การเฝ้าติดตามด้านสุขภาพใน พร็อกซี API ให้แก้ไขไฟล์การกำหนดค่า TargetEndpoint ใน ไดเรกทอรี /apiproxy/targets/ ไฟล์เริ่มต้นในไดเรกทอรีนี้คือ default.xml แต่อาจมีไฟล์ที่ใช้ชื่ออื่นหากคุณใช้ เป้าหมายแบบมีเงื่อนไข

   ในกรณีนี้ หากไม่มีไฟล์การกำหนดค่า TargetEndpoint และไดเรกทอรีอยู่ สร้างได้

4. หลังจากที่แก้ไขไฟล์การกำหนดค่าพร็อกซีเสร็จแล้ว โปรดบันทึกการเปลี่ยนแปลง
5. เปลี่ยนเป็นไดเรกทอรีใหม่ที่คุณสร้างขึ้นเมื่อคุณขยายไฟล์ ZIP (รากของ ไฟล์การกำหนดค่าที่ขยาย)

   ตัวอย่างเช่น ถ้าคุณขยายไฟล์ลงในไดเรกทอรี /myappdir ให้เปลี่ยนเป็น ไดเรกทอรีดังกล่าว ดังตัวอย่างต่อไปนี้

   cd myappdir

   คุณควรเปลี่ยนเป็นไดเรกทอรีนี้ก่อนที่จะเก็บไฟล์การกำหนดค่าพร็อกซีอีกครั้ง เนื่องจากคุณไม่ต้องการให้ไดเรกทอรี /myappdir รวมอยู่ในไฟล์ ZIP ไดเรกทอรีระดับบนสุดในไฟล์ ZIP ต้องเป็น /apiproxy

6. เก็บไฟล์การกำหนดค่าพร็อกซีอีกครั้ง รวมถึงไฟล์ใหม่หรือไฟล์ที่มีการเปลี่ยนแปลง คุณสามารถใช้ เช่น zip ตามตัวอย่างต่อไปนี้ วันที่

   zip my-new-proxy.zip -r .

   ไดเรกทอรีระดับบนสุดในไฟล์ ZIP ต้องเป็น /apiproxy

   ไม่มีข้อกำหนดพิเศษสำหรับชื่อไฟล์ ZIP ตัวอย่างเช่น คุณไม่จำเป็นต้อง เพิ่มหมายเลขการแก้ไขหรือระบุวันที่ในชื่อไฟล์ แต่การทำเช่นนี้สามารถ ซึ่งมีประโยชน์ในการแก้ไขข้อบกพร่องหรือการควบคุมแหล่งที่มา

   Edge จะเพิ่มหมายเลขการแก้ไขของการกำหนดค่าพร็อกซีใหม่ให้คุณเมื่ออัปโหลด ได้

7. อัปโหลดการกำหนดค่าพร็อกซีใหม่โดยใช้ Edge UI (ในพร็อกซี API ดู เลือกโปรเจ็กต์ > อัปโหลดการแก้ไขใหม่)

   หากคุณได้รับข้อผิดพลาด เช่น Bundle is invalid. Empty bundle. ให้ตรวจสอบว่า ไดเรกทอรีระดับบนสุดของไฟล์ ZIP ของคุณคือ /apiproxy หากไม่ใช่ ให้เก็บถาวร ไฟล์การกำหนดค่าพร็อกซีจากรากของไดเรกทอรีที่ขยาย

   หลังจากอัปโหลดการกำหนดค่าพร็อกซีใหม่ Edge จะเพิ่มหมายเลขการแก้ไขและ จะแสดงในมุมมองสรุปการแก้ไข

   Edge จะไม่ทำให้การแก้ไขใหม่ใช้งานได้หลังจากที่คุณอัปโหลดเวอร์ชันดังกล่าวด้วย UI

8. ทำให้การแก้ไขใหม่ใช้งานได้

สำหรับข้อมูลเพิ่มเติม โปรดดู บทแนะนำ: วิธีดาวน์โหลดพร็อกซีโดยใช้ UI และ API การจัดการใน ชุมชน Apigee

โครงสร้างพร็อกซี API

พร็อกซี API ประกอบด้วยการกำหนดค่าดังต่อไปนี้

โครงสร้างไดเรกทอรีพร็อกซี API และเนื้อหา

คอมโพเนนต์ในตารางด้านบนกำหนดโดยไฟล์การกำหนดค่าในข้อมูลต่อไปนี้ โครงสร้างไดเรกทอรี

ไฟล์การกำหนดค่าและไดเรกทอรี โครงสร้างของพร็อกซี API

ส่วนนี้จะอธิบายถึงไฟล์การกำหนดค่าและโครงสร้างไดเรกทอรีของพร็อกซี API

• การกำหนดค่าพื้นฐาน
• ProxyEndpoint
• TargetEndpoint
  • การกำหนดค่า TLS/SSL TargetEndpoint
• นโยบาย
• โฟลว์
• แหล่งข้อมูล

การกำหนดค่าพื้นฐาน

/apiproxy/weatherapi.xml

การกำหนดค่าพื้นฐานสำหรับพร็อกซี API ซึ่งจะกำหนดชื่อของพร็อกซี API ชื่อ ต้องไม่ซ้ำกันภายในองค์กร

ตัวอย่างการกำหนดค่า

<APIProxy name="weatherapi">
</APIProxy>

องค์ประกอบการกำหนดค่าฐาน

ProxyEndpoint

รูปภาพต่อไปนี้แสดงขั้นตอนการส่งคำขอ/การตอบกลับ

/apiproxy/proxies/default.xml

การกำหนดค่า ProxyEndpoint จะกำหนดอินเทอร์เฟซขาเข้า (สำหรับไคลเอ็นต์) สำหรับ API พร็อกซี เมื่อคุณกำหนดค่า ProxyEndpoint คุณกำลังกำหนดค่าเครือข่ายที่ กำหนดวิธีที่แอปพลิเคชันไคลเอ็นต์ ("แอป") ควรเรียกใช้ API พร็อกซี

ตัวอย่างการกำหนดค่า ProxyEndpoint ต่อไปนี้จะถูกเก็บไว้ใน /apiproxy/proxies:

<ProxyEndpoint name="default">
  <PreFlow/>
  <Flows/>
  <PostFlow/>
  <HTTPProxyConnection>
    <BasePath>/weather</BasePath>
    <VirtualHost>default</VirtualHost>
  </HTTPProxyConnection>
  <FaultRules/>
  <DefaultFaultRule/>
  <RouteRule name="default">
    <TargetEndpoint>default</TargetEndpoint>
  </RouteRule>
</ProxyEndpoint>

องค์ประกอบการกำหนดค่าที่จำเป็นใน ProxyEndpoint พื้นฐานมีดังนี้

การกำหนดค่า ProxyEndpoint Elements

วิธีกำหนดค่า RouteRule

TargetEndpoint ที่มีชื่อจะอ้างถึงไฟล์การกำหนดค่าภายใต้ /apiproxy/targets เพื่อ ซึ่ง RouteRule จะส่งต่อคำขอหลังจากประมวลผลโดย ProxyEndpoint

เช่น RouteRule ต่อไปนี้จะอ้างถึงการกําหนดค่า /apiproxy/targets/myTarget.xml:

<RouteRule name="default">
  <TargetEndpoint>myTarget</TargetEndpoint>
</RouteRule>

การเรียกใช้ URL โดยตรง

ProxyEndpoint ยังสามารถเรียกใช้บริการแบ็กเอนด์ได้โดยตรงอีกด้วย การเรียกใช้ URL โดยตรงจะข้าม ตั้งชื่อว่าการกำหนดค่า TargetEndpoints ใน /apiproxy/targets) ด้วยเหตุนี้ TargetEndpoint คือการกำหนดค่าพร็อกซี API ที่เป็นตัวเลือก แต่ในทางปฏิบัติแล้วจะเป็นการเรียกใช้โดยตรง ไม่แนะนำให้ใช้ ProxyEndpoint

ตัวอย่างเช่น RouteRule ต่อไปนี้ทำการเรียก HTTP ไปยัง http://api.mycompany.com/v2

<RouteRule name="default">
  <URL>http://api.mycompany.com/v2</URL> 
</RouteRule>

เส้นทางแบบมีเงื่อนไข

RouteRule สามารถเชื่อมโยงเพื่อรองรับการกำหนดเส้นทางแบบไดนามิกขณะรันไทม์ คําขอขาเข้าอาจเป็น กำหนดเส้นทางไปยังการกำหนดค่า TargetEndpoint ที่มีชื่อ ไปยัง URL โดยตรง หรือไปยัง URL ทั้ง 2 รายการรวมกัน ขึ้นอยู่กับส่วนหัว HTTP เนื้อหาข้อความ พารามิเตอร์การค้นหา หรือข้อมูลบริบท เช่น วัน ภาษา ฯลฯ

RouteRule แบบมีเงื่อนไขจะทำงานเหมือนกับคำสั่งแบบมีเงื่อนไขอื่นๆ ใน Apigee Edge ดูข้อมูลอ้างอิงเงื่อนไขและข้อมูลอ้างอิงตัวแปร

ตัวอย่างเช่น ชุดค่าผสม RouteRule ต่อไปนี้จะประเมินคำขอขาเข้าก่อนเพื่อยืนยัน ค่าของส่วนหัว HTTP หากส่วนหัว HTTP routeTo มีค่า TargetEndpoint1 จากนั้นระบบจะส่งต่อคำขอไปยัง TargetEndpoint ที่ชื่อ TargetEndpoint1 หากไม่ใช่ คำขอขาเข้าจะถูกส่งต่อไปยัง http://api.mycompany.com/v2

<RouteRule name="MyRoute">
  <Condition>request.header.routeTo = "TargetEndpoint1"</Condition>
  <TargetEndpoint>TargetEndpoint1</TargetEndpoint>
</RouteRule>
<RouteRule name="default">
  <URL>http://api.mycompany.com/v2</URL>
</RouteRule>

เส้นทาง Null

คุณสามารถกำหนด RouteRule แบบ null เพื่อสนับสนุนกรณีที่ข้อความคำขอไม่ ต้องส่งต่อไปยัง TargetEndpoint วิธีนี้มีประโยชน์เมื่อ ProxyEndpoint ดำเนินการทั้งหมด การประมวลผลที่จำเป็น เช่น โดยใช้ JavaScript เพื่อเรียกใช้บริการภายนอก หรือ ดึงข้อมูลจากการค้นหาไปยังบริการ API ที่เก็บคีย์/ค่า

ตัวอย่างเช่น พารามิเตอร์ต่อไปนี้จะกำหนดเส้นทาง Null

<RouteRule name="GoNowhere"/>

เส้นทาง Null แบบมีเงื่อนไขอาจมีประโยชน์ ในตัวอย่างต่อไปนี้ มีการกำหนดค่าเส้นทาง Null เป็น ดำเนินการเมื่อส่วนหัว HTTP request.header.X-DoNothing มีค่าอื่นที่ไม่ใช่ null

<RouteRule name="DoNothingOnDemand">
  <Condition>request.header.X-DoNothing != null</Condition>
</RouteRule>

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

การใช้งานเส้นทาง Null แบบมีเงื่อนไขที่ใช้ได้จริงจะรองรับการแคช ใช้ค่า ที่นโยบายแคชตั้งค่าไว้ คุณสามารถกำหนดค่าพร็อกซี API เพื่อเรียกใช้ฟิลด์ เส้นทาง Null เมื่อมีการแสดงรายการจากแคช

<RouteRule name="DoNothingUnlessTheCacheIsStale">
  <Condition>lookupcache.LookupCache-1.cachehit is true</Condition>
</RouteRule>

TargetEndpoint

TargetEndpoint เทียบเท่ากับขาออกของ ProxyEndpoint TargetEndpoint ทำหน้าที่เป็น ไปยังบริการแบ็กเอนด์หรือ API -- ไคลเอ็นต์จะส่งคำขอและรับการตอบกลับ

พร็อกซี API ไม่มี TargetEndpoints สามารถกำหนดค่า ProxyEndpoints ให้เรียก URL โดยตรง ปกติแล้วพร็อกซี API ที่ไม่มี TargetEndpoints จะมี ProxyEndpoint ที่ เรียกใช้บริการแบ็กเอนด์โดยตรง หรือที่ได้รับการกำหนดค่าให้เรียกใช้บริการโดยใช้ Java หรือ JavaScript

การกำหนดค่าปลายทางปลายทาง

/targets/default.xml

TargetEndpoint จะกำหนดการเชื่อมต่อขาออกจาก Apigee Edge ไปยังบริการอื่นหรือ ทรัพยากร

ตัวอย่างการกำหนดค่า TargetEndpoint มีดังนี้

<TargetEndpoint name="default">
  <PreFlow/>
  <Flows/>
  <PostFlow/>
  <HTTPTargetConnection>
    <URL>http://mocktarget.apigee.net</URL>
    <SSLInfo/>
  </HTTPTargetConnection>
  <FaultRules/>
  <DefaultFaultRule/>
  <ScriptTarget/>
  <LocalTargetConnection/>
</TargetEndpoint>

การกำหนดค่าปลายทางปลายทาง Elements

TargetEndpoint สามารถเรียกเป้าหมายด้วยวิธีใดวิธีหนึ่งต่อไปนี้

• HTTPTargetConnection สำหรับการเรียก HTTP(S)
• LocalTargetConnection สำหรับเชนพร็อกซีกับพร็อกซีในเครื่อง
• ScriptTarget สำหรับการเรียกไปยังแพลตฟอร์ม Edge สคริปต์ Node.js

กำหนดค่าเพียงรายการเดียวใน TargetEndpoint

การกำหนดค่า TargetEndpoint สำหรับ TLS/SSL

TargetEndpoints มักต้องจัดการการเชื่อมต่อ HTTPS ที่มีแบ็กเอนด์ที่แตกต่างกัน โครงสร้างพื้นฐาน ด้วยเหตุนี้ ระบบจึงรองรับการตั้งค่าการกำหนดค่า TLS/SSL จำนวนหนึ่ง

TLS/SSL องค์ประกอบการกำหนดค่าปลายทางปลายทาง

<Ciphers>
 <Cipher>TLS_RSA_WITH_3DES_EDE_CBC_SHA</Cipher>    
 <Cipher>TLS_RSA_WITH_DES_CBC_SHA</Cipher>
</Ciphers>

<Protocols>
 <Protocol>TLSv1.1</Protocol>
 <Protocol>TLSv1.2</Protocol>
</Protocols>

<CommonName wildcardMatch="true">*.myhost.com</CommonName>

ตัวอย่าง TargetEndpoint ที่เปิดใช้การตรวจสอบสิทธิ์ไคลเอ็นต์ขาออก

<TargetEndpoint name="default">
  <HttpTargetConnection>
        <URL>https://myservice.com</URL>
    <SSLInfo>
      <Enabled>true</Enabled>
      <ClientAuthEnabled>true</ClientAuthEnabled>
      <KeyStore>myKeystore</KeyStore>
      <KeyAlias>myKey</KeyAlias>
      <TrustStore>myTruststore</TrustStore>
    </SSLInfo>
  </HttpTargetConnection>
</TargetEndpoint>

สำหรับคำแนะนำโดยละเอียด โปรดดูการกำหนดค่า TLS จาก Edge ไปยังแบ็กเอนด์ (ระบบคลาวด์และ Private Cloud)

การใช้ ตัวแปรโฟลว์เพื่อตั้งค่า TLS/SSL แบบไดนามิก

คุณยังสามารถตั้งค่ารายละเอียด TLS/SSL แบบไดนามิกเพื่อรองรับข้อกำหนดรันไทม์ที่ยืดหยุ่น ตัวอย่างเช่น หากพร็อกซีเชื่อมต่อกับเป้าหมาย 2 รายการที่อาจมีความแตกต่างกัน (เป้าหมายทดสอบและ เวอร์ชันที่ใช้งานจริง) คุณสามารถทำให้พร็อกซี API ตรวจสอบแบบเป็นโปรแกรมได้ว่าเป็นสภาพแวดล้อมใด การเรียกใช้และตั้งค่าการอ้างอิงแบบไดนามิกไปยังคีย์สโตร์และ Truststore ที่เหมาะสม ดังต่อไปนี้ บทความในชุมชน Apigee จะอธิบายสถานการณ์นี้อย่างละเอียดมากขึ้นและให้ API ที่นำไปใช้งานได้ ตัวอย่างพร็อกซี: https://community.apigee.com/articles/21424/dynamic-sslinfo-for-targetendpoint-using-variable.html

ในตัวอย่างต่อไปนี้เกี่ยวกับวิธีตั้งค่าแท็ก <SSLInfo> ใน การกำหนดค่า TargetEndpoint สามารถระบุค่าขณะรันไทม์ ตัวอย่างเช่น โดยการใช้ Java ข้อความไฮไลต์, นโยบาย JavaScript หรือนโยบายมอบหมายข้อความ ใช้ตัวแปรข้อความใดก็ได้ มีค่าที่คุณต้องการตั้งค่า

อนุญาตให้ใช้ตัวแปรในองค์ประกอบต่อไปนี้เท่านั้น

<SSLInfo>
    <Enabled>{myvars.ssl.enabled}</Enabled>
    <ClientAuthEnabled>{myvars.ssl.client.auth.enabled}</ClientAuthEnabled>
    <KeyStore>{myvars.ssl.keystore}</KeyStore>
    <KeyAlias>{myvars.ssl.keyAlias}</KeyAlias>
    <TrustStore>{myvars.ssl.trustStore}</TrustStore>
</SSLInfo>

การใช้ การอ้างอิงเพื่อตั้งค่า TLS/SSL แบบไดนามิก

เมื่อกำหนดค่า TargetEndpoint ที่ใช้ HTTPS คุณต้องพิจารณากรณีเมื่อ ใบรับรอง TLS/SSL หมดอายุ หรือคุณต้องอัปเดตใบรับรองหากมีการเปลี่ยนแปลงการกำหนดค่าระบบ ใน การติดตั้ง Edge สำหรับ Private Cloud เมื่อกำหนดค่า TLS/SSL โดยใช้ค่าคงที่ หรือ เมื่อใช้ตัวแปรโฟลว์ มีโอกาสที่คุณจะต้องรีสตาร์ทโปรแกรมประมวลผลข้อความ

โปรดดูข้อมูลเพิ่มเติมที่หัวข้ออัปเดต TLS ใบรับรอง

อย่างไรก็ตาม คุณสามารถเลือกกำหนดค่า TargetEndpoint ให้ใช้การอ้างอิงไปยังฟังก์ชัน keystore หรือ Truststore แทน ข้อดีของการใช้ข้อมูลอ้างอิงคือคุณสามารถอัปเดต การอ้างอิงเพื่อชี้ไปยังคีย์สโตร์หรือ Truststore อื่นเพื่ออัปเดตใบรับรอง TLS/SSL โดยไม่มี ต้องรีสตาร์ทโปรแกรมประมวลผลข้อความ

ตัวอย่างเช่น ตัวอย่างด้านล่างคือ TargetEndpoint ที่ใช้การอ้างอิงไปยังคีย์สโตร์

<SSLInfo> 
    <Enabled>true</Enabled> 
    <ClientAuthEnabled>false</ClientAuthEnabled> 
    <KeyStore>ref://keystoreref</KeyStore> 
    <KeyAlias>myKeyAlias</KeyAlias> 
</SSLInfo>

ใช้การเรียก API ของ POST ต่อไปนี้เพื่อสร้างข้อมูลอ้างอิงที่ชื่อ keystoreref ดังนี้

curl -X POST  -H "Content-Type:application/xml" https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/references \
-d '<ResourceReference name="keystoreref">
    <Refers>myTestKeystore</Refers>
    <ResourceType>KeyStore</ResourceType>
</ResourceReference>' -u email:password

ข้อมูลอ้างอิงจะระบุชื่อของคีย์สโตร์และประเภทของคีย์สโตร์

ใช้การเรียก GET API ต่อไปนี้เพื่อดูข้อมูลอ้างอิง

curl -X GET https://api.enterprise.apigee.com/v1/o/[org_name}/e/{env_name}/references/keystoreref -u uname:password

หากต้องการเปลี่ยนการอ้างอิงให้ชี้ไปยังคีย์สโตร์อื่นในภายหลัง โปรดตรวจสอบให้แน่ใจว่าชื่อแทนมี ชื่อเดียวกัน ให้ใช้การเรียก PUT ต่อไปนี้

curl -X PUT -H "Content-Type:application/xml" https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/references/keystoreref \
-d '<ResourceReference name="keystoreref">
    <Refers>myNewKeystore</Refers>
    <ResourceType>KeyStore</ResourceType>
</ResourceReference>' -u email:password

TargetEndpoint ด้วยการจัดสรรภาระงานเป้าหมาย

TargetEndpoints รองรับการจัดสรรภาระงานใน TargetServers ที่มีชื่อหลายรายการโดยใช้โหลด 3 แบบ การสร้างสมดุลของอัลกอริทึม

ดูวิธีการอย่างละเอียดได้ที่การจัดสรรภาระงานในแบ็กเอนด์ เซิร์ฟเวอร์

นโยบาย

ไดเรกทอรี /policies ในพร็อกซี API มีนโยบายทั้งหมดที่ใช้ได้ แนบอยู่กับโฟลว์ในพร็อกซี API

องค์ประกอบการกำหนดค่านโยบาย

ไฟล์แนบนโยบาย

รูปภาพต่อไปนี้แสดงลำดับการดำเนินการของโฟลว์พร็อกซี API

ดังที่แสดงด้านบน

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

<Step><Name>MyPolicy</Name></Step>

ระบบจะบังคับใช้นโยบายตามลำดับที่แนบกับโฟลว์ เช่น

<Step><Name>FirstPolicy</Name></Step>
<Step><Name>SecondPolicy</Name></Step>

การกำหนดค่าไฟล์แนบนโยบาย Elements

โฟลว์

ProxyEndpoint และ TargetEndpoint กำหนดไปป์ไลน์สำหรับคำขอและข้อความตอบกลับ การประมวลผล ไปป์ไลน์การประมวลผลประกอบด้วยโฟลว์คำขอและขั้นตอนการตอบกลับ คำขอแต่ละรายการ โฟลว์และขั้นตอนการตอบสนองแบ่งย่อยเป็น PreFlow ซึ่งมี "conditional" ที่ไม่บังคับอย่างน้อย 1 รายการ หรือ "ตั้งชื่อแล้ว" และ PostFlow

• PreFlow: ทำงานเสมอ เรียกใช้ก่อนโฟลว์แบบมีเงื่อนไข
• PostFlow: ทำงานเสมอ ดำเนินการหลังจากโฟลว์แบบมีเงื่อนไข

นอกจากนี้ คุณสามารถเพิ่ม PostClientFlow ลงใน ProxyEndpoint ซึ่งจะทำงานหลังจาก ระบบจะส่งการตอบสนองไปยังแอปไคลเอ็นต์ที่ขอ เฉพาะนโยบายการบันทึกข้อความและ แนบส่วนขยาย Google Stackdriver Logging ได้ กับขั้นตอนนี้ PostClientFlow ลดเวลาในการตอบสนองของพร็อกซี API และแสดงข้อมูลสำหรับ การบันทึกที่ไม่มีการคำนวณจนกว่าจะส่งคืนการตอบสนองไปยังไคลเอ็นต์ เช่น client.sent.start.timestamp และ client.sent.end.timestamp กระบวนการนี้ใช้อยู่ สำหรับการวัดช่วงเวลาระหว่างการประทับเวลาเริ่มต้นและสิ้นสุดสำหรับการตอบกลับเป็นหลัก

ดูวิดีโอแสดงวิธีการสั้นๆ

ต่อไปนี้เป็นตัวอย่างของ PostClientFlow ที่มีนโยบายการบันทึกข้อความแนบอยู่

    ...
    <PostFlow name="PostFlow">
        <Request/>
        <Response/>
    </PostFlow>
    <PostClientFlow>
        <Request/>
        <Response>
            <Step>
                <Name>Message-Logging-1</Name>
            </Step>
        </Response>
    </PostClientFlow>
    ...

ไปป์ไลน์การประมวลผลพร็อกซี API จะดำเนินการโฟลว์ตามลำดับต่อไปนี้

ไปป์ไลน์คำขอ:

1. ขั้นตอนเบื้องต้นของคำขอพร็อกซี
2. ขั้นตอนแบบมีเงื่อนไขของคำขอพร็อกซี (ไม่บังคับ)
3. PostFlow ของคำขอพร็อกซี
4. ขั้นตอนเบื้องต้นของคำขอเป้าหมาย
5. คำขอขั้นตอนแบบมีเงื่อนไขของคำขอเป้าหมาย (ไม่บังคับ)
6. PostFlow ของคำขอเป้าหมาย

ไปป์ไลน์การตอบกลับ:

1. ขั้นตอนเบื้องต้นของการตอบสนองเป้าหมาย
2. ขั้นตอนแบบมีเงื่อนไขของการตอบสนองเป้าหมาย (ไม่บังคับ)
3. PostFlow ของการตอบสนองเป้าหมาย
4. ขั้นตอนเบื้องต้นการตอบกลับพร็อกซี
5. ขั้นตอนแบบมีเงื่อนไขของการตอบกลับพร็อกซี (ไม่บังคับ)
6. PostFlow ของการตอบกลับพร็อกซี
7. การตอบกลับ PostClientFlow (ไม่บังคับ)

เฉพาะโฟลว์ที่มีไฟล์แนบนโยบายเท่านั้นที่ต้องกำหนดค่าใน ProxyEndpoint หรือ การกำหนดค่า TargetEndpoint ต้องระบุ PreFlow และ PostFlow ใน ProxyEndpoint หรือ การกำหนดค่า TargetEndpoint เมื่อต้องบังคับใช้นโยบายระหว่าง PreFlow หรือ PostFlow การประมวลผล

ซึ่งตรงข้ามกับขั้นตอนแบบมีเงื่อนไข การจัดลำดับองค์ประกอบ PreFlow และ PostFlow ไม่ได้ --พร็อกซี API จะดำเนินการกับแต่ละพร็อกซีในจุดที่เหมาะสมในไปป์ไลน์เสมอ ไม่ว่าจะแสดงอยู่ที่ใดในการกำหนดค่าปลายทาง

ขั้นตอนแบบมีเงื่อนไข

ProxyEndpoints และ TargetEndpoints รองรับขั้นตอนแบบมีเงื่อนไขได้ไม่จำกัดจำนวน (รวมถึง หรือ "ขั้นตอนที่ตั้งชื่อแล้ว")

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

เมื่อกำหนดขั้นตอนแบบมีเงื่อนไข คุณจะสามารถใช้ขั้นตอนการประมวลผลในพร็อกซี API อ้างอิงจาก:

• URI คำขอ
• กริยา HTTP (GET/PUT/POST/DELETE)
• ค่าของพารามิเตอร์การค้นหา ส่วนหัว และพารามิเตอร์แบบฟอร์ม
• เงื่อนไขประเภทอื่นๆ อีกมากมาย

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

<Flows>
  <Flow name="TokenEndpoint">
    <Condition>proxy.pathsuffix MatchesPath "/accesstoken"</Condition>
    <Request>
      <Step>
        <Name>GenerateAccessToken</Name>
      </Step>
    </Request> 
  </Flow>
</Flows>   

องค์ประกอบการกำหนดค่าโฟลว์

กำลังประมวลผลขั้นตอน

Apigee Edge จะบังคับใช้การจัดลำดับตามลำดับของโฟลว์แบบมีเงื่อนไข ขั้นตอนแบบมีเงื่อนไข ดำเนินการจากบนลงล่าง โฟลว์แบบมีเงื่อนไขแรกซึ่งมีเงื่อนไขที่ประเมินเป็น เรียกใช้ true และดำเนินการโฟลว์แบบมีเงื่อนไขเพียงรายการเดียว

ตัวอย่างเช่น ในการกำหนดค่าโฟลว์ต่อไปนี้ คำขอขาเข้าที่ไม่มี คำต่อท้ายเส้นทาง /first หรือ /second จะทําให้ ThirdFlow เพื่อบังคับใช้ โดยบังคับใช้นโยบาย Return404

<Flows>
  <Flow name="FirstFlow">
    <Condition>proxy.pathsuffix MatchesPath "/first"</Condition>
    <Request>
      <Step><Name>FirstPolicy</Name></Step>
    </Request>
  </Flow>
  <Flow name="SecondFlow">
    <Condition>proxy.pathsuffix MatchesPath "/second"</Condition>
    <Request>
      <Step><Name>FirstPolicy</Name></Step>
      <Step><Name>SecondPolicy</Name></Step>
    </Request>
  </Flow>
  <Flow name="ThirdFlow">
    <Request>
      <Step><Name>Return404</Name></Step>
    </Request>
  </Flow>
</Flows>

แหล่งข้อมูล

"ทรัพยากร" (ไฟล์ทรัพยากรสำหรับใช้ในพร็อกซี API) คือสคริปต์ โค้ด และการเปลี่ยนรูปแบบ XSL ที่แนบไปกับโฟลว์โดยใช้นโยบายได้ สิ่งเหล่านี้จะปรากฏใน "สคริปต์" ของ API ตัวแก้ไขพร็อกซีใน UI การจัดการ

โปรดดูที่ไฟล์ทรัพยากรสำหรับ ประเภททรัพยากร

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

นโยบายในสภาพแวดล้อมใดก็ได้สามารถใช้อ้างอิงทรัพยากรซึ่งจัดเก็บไว้ที่ระดับองค์กรได้ นโยบายในสภาพแวดล้อมนั้นอ้างอิงทรัพยากรที่เก็บไว้ที่ระดับสภาพแวดล้อมได้ ต ทรัพยากรที่จัดเก็บในระดับพร็อกซี API สามารถอ้างอิงได้โดยนโยบายในพร็อกซี API นั้นเท่านั้น