นโยบาย PythonScript

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

อะไร

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

ระบบรองรับภาษา Python ผ่าน Jython เวอร์ชัน 2.5.2 ไลบรารีของบุคคลที่สามที่คุณเพิ่มต้องเป็น "Python ล้วน" (ใช้งานได้ใน Python เท่านั้น) ดูข้อมูลเพิ่มเติมเกี่ยวกับการเพิ่มไลบรารีได้ที่ ไฟล์ทรัพยากร

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

ตัวอย่าง

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Script name="Python-1">
        <DisplayName>Python-1</DisplayName>
        <ResourceURL>py://myscript.py</ResourceURL>
</Script>

import base64

username = flow.getVariable("request.formparam.client_id")
password = flow.getVariable("request.formparam.client_secret")

base64string = base64.encodestring('%s:%s' % (username, password))[:-1]
authorization = "Basic "+base64string

flow.setVariable("authorizationParam",authorization)

ข้อมูลอ้างอิงองค์ประกอบ

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Script name="Python-1">
    <DisplayName>Python-1</DisplayName>
    <ResourceURL>py://myscript.py</ResourceURL>
    <IncludeURL>py://myscript_dependency.py</IncludeURL>
</Script>

ตารางต่อไปนี้อธิบายแอตทริบิวต์ทั่วไปในองค์ประกอบระดับบนสุดของนโยบายทั้งหมด

<DisplayName> องค์ประกอบ

ใช้เพิ่มเติมจากแอตทริบิวต์ name เพื่อติดป้ายกำกับนโยบายใน เครื่องมือแก้ไขพร็อกซี UI การจัดการด้วยชื่อที่เป็นภาษาธรรมชาติต่างกัน

<DisplayName>Policy Display Name</DisplayName>

<ResourceURL> องค์ประกอบ

องค์ประกอบนี้จะระบุไฟล์ Python หลักที่จะทำงานในโฟลว์ API คุณสามารถจัดเก็บไฟล์นี้ไว้ในขอบเขตพร็อกซี API (ใน /apiproxy/resources/py ในบันเดิลพร็อกซี API หรือในส่วนสคริปต์ของบานหน้าต่าง Navigator ของเครื่องมือแก้ไขพร็อกซี API) หรือในขอบเขตองค์กรหรือสภาพแวดล้อมเพื่อนำไปใช้ซ้ำในพร็อกซี API หลายรายการตามที่อธิบายไว้ใน ไฟล์ทรัพยากร โค้ดของคุณสามารถใช้ ออบเจ็กต์ เมธอด และพร็อพเพอร์ตี้ของ โมเดลออบเจ็กต์ JavaScript ได้

<ResourceURL>py://myscript.py</ResourceURL>

<IncludeURL> องค์ประกอบ

ระบุไฟล์ Python ที่จะโหลดเป็นทรัพยากร Dependency ของไฟล์ Python หลักที่ระบุด้วยองค์ประกอบ <ResourceURL> ระบบจะประเมินสคริปต์ตามลำดับที่แสดงในนโยบาย

รวมทรัพยากร Dependency ของ Python มากกว่า 1 รายการด้วยองค์ประกอบเพิ่มเติม <IncludeURL>

<IncludeURL>py://myscript_dependency.py</IncludeURL>

รหัสข้อผิดพลาด

ส่วนนี้จะอธิบายรหัสข้อผิดพลาดและข้อความแสดงข้อผิดพลาดที่ส่งกลับและตัวแปรข้อบกพร่อง ที่ Edge กำหนดไว้เมื่อนโยบายนี้ทริกเกอร์ข้อผิดพลาด ข้อมูลนี้สำคัญที่ควรทราบ หากคุณพัฒนากฎความผิด จัดการกับข้อผิดพลาด หากต้องการเรียนรู้เพิ่มเติม โปรดดูที่สิ่งที่คุณจำเป็นต้องทราบ เกี่ยวกับข้อผิดพลาดของนโยบายและการจัดการ ข้อผิดพลาด

ข้อผิดพลาดเกี่ยวกับรันไทม์

ข้อผิดพลาดเหล่านี้อาจเกิดขึ้นเมื่อนโยบายทำงาน

ข้อผิดพลาดในการทำให้ใช้งานได้

ข้อผิดพลาดเหล่านี้อาจเกิดขึ้นเมื่อคุณใช้พร็อกซีที่มีนโยบายนี้

ตัวแปรความผิดพลาด

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

ตัวอย่างการตอบสนองข้อผิดพลาด

{
  "fault": {
    "faultstring": "Execution of SetResponse failed with error: Pythonscript runtime error: "ReferenceError: "status" is not defined.\"",
    "detail": {
      "errorcode": "steps.script.ScriptExecutionFailed"
    }
  }
}

ตัวอย่างกฎข้อผิดพลาด

<FaultRule name="PythonScript Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ScriptExecutionFailed") </Condition>
    </Step>
    <Condition>(pythonscript.PythonScript-1.failed = true) </Condition>
</FaultRule>

หัวข้อที่เกี่ยวข้อง