PythonScript 정책

이 페이지는 Apigee 및 Apigee Hybrid에 적용됩니다.

대상

Python 스크립트 정책을 사용하면 특히 필요한 기능이 Apigee에서 제공하는 즉시 사용 가능한 정책의 범위를 초과하는 경우 맞춤설정된 Python 기능을 API 프록시 흐름에 추가할 수 있습니다.

이 정책은 확장 가능한 정책이며, 이 정책을 사용하면 Apigee 라이선스에 따라 비용 또는 사용률이 영향을 받을 수 있습니다. 정책 유형 및 사용 영향에 대한 자세한 내용은 정책 유형을 참조하세요.

Python 언어 지원은 Jython 버전 2.5.2를 통해 제공됩니다. 추가하는 타사 라이브러리는 '순수 Python'(Python에만 구현)이어야 합니다. 라이브러리 추가에 대한 자세한 내용은 리소스 파일을 참조하세요.

Python 정책에는 실제 코드가 없습니다. 대신 Python 정책은 Python 리소스를 참조하고 Python 스크립트가 실행되는 API 흐름의 단계를 정의합니다. Apigee UI 프록시 편집기를 통해 스크립트를 업로드하거나 로컬에서 개발하는 API 프록시의 /resources/py 디렉터리에 포함할 수 있습니다.

샘플

Python 정책 및 스크립트

Python 스크립트 정책

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

이 예시에서는 ResourceURL 요소가 관련 Python 스크립트 리소스를 지정합니다.

Python 스크립트

여기에는 Python 스크립트 자체에 포함할 수 있는 항목이 표시됩니다.

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>

다음 표는 모든 정책 상위 요소의 공통 속성에 대해 설명합니다.

속성	설명	기본값	Presence
`name`	정책의 내부 이름입니다. `name` 속성의 값에는 문자, 숫자, 공백, 하이픈, 밑줄, 마침표가 포함될 수 있습니다. 이 값은 255자(영문 기준)를 초과할 수 없습니다. 원하는 경우 `<DisplayName>` 요소를 사용하여 관리 UI 프록시 편집기의 정책에 다른 자연어 이름을 사용하여 정책에 라벨을 지정합니다.	해당 사항 없음	필수
`continueOnError`	정책이 실패할 경우 오류가 반환되도록 하려면 `false`로 설정합니다. 이는 대부분의 정책에서 예상되는 동작입니다. 정책이 실패해도 흐름 실행이 계속되도록 하려면 `true`로 설정합니다. 참조: 오류 규칙은 오류 상태(continueOnError)에서만 트리거됨 현재 흐름 내에서 오류 처리	false	선택사항
`enabled`	정책을 시행하려면 `true`로 설정합니다. 정책을 중지하려면 `false`로 설정합니다. 정책이 흐름에 연결되어 있어도 정책이 시행되지 않습니다.	true	선택사항
`async`	이 속성은 지원이 중단되었습니다.	false	지원 중단됨

<DisplayName> 요소

name 속성 외에도 이 요소를 사용하여 관리 UI 프록시 편집기의 정책에 다른 자연어 이름으로 라벨을 지정합니다.

<DisplayName>Policy Display Name</DisplayName>

기본값

기본값	해당 사항 없음 이 요소를 생략하면 정책 `name` 속성 값이 사용됩니다.
Presence	선택사항
유형	문자열

해당 사항 없음

이 요소를 생략하면 정책 name 속성 값이 사용됩니다.

Presence 선택사항

유형 문자열

<ResourceURL> 요소

이 요소는 API 흐름에서 실행되는 기본 Python 파일을 지정합니다. 이 파일을 API 프록시 범위(API 프록시 번들의 /apiproxy/resources/py 아래 또는 API 프록시 편집기 탐색창의 스크립트 섹션) 또는 리소스 파일의 설명대로 여러 API 프록시에 다시 사용할 수 있도록 조직이나 환경 범위에 저장할 수 있습니다. 코드에서 자바스크립트 객체 모델의 객체, 메서드, 속성을 사용할 수 있습니다.

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

기본값:	없음
Presence:	필수
유형:	문자열

<IncludeURL> 요소

<ResourceURL> 요소를 사용하여 지정한 기본 Python 파일에 종속 항목으로 로드할 Python 파일을 지정합니다. 스크립트는 정책에 나열된 순서대로 평가됩니다.

추가 <IncludeURL> 요소를 사용하여 Python 종속 항목 리소스를 두 개 이상 포함합니다.

경고: Python 파일이 조직 또는 환경 수준에서 저장되면 -F 옵션을 사용하여 또는 REST 클라이언트를 통해 파일 첨부로 cURL을 올바르게 업로드했는지 확인하세요. Content-Type은 multipart/form-data입니다. 자세한 내용은 리소스 파일을 참조하세요.

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

기본값:	없음
Presence:	선택사항
유형:	문자열

오류 코드

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause	Fix
`steps.script.ScriptEvaluationFailed`	`500`	The PythonScript policy can throw several different types of ScriptExecutionFailed errors. Commonly seen types of errors include NameError and ZeroDivisionError.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name	Cause	Fix
`InvalidResourceUrlFormat`	If the format of the resource URL specified within the `<ResourceURL>` or the `<IncludeURL>` element of the PythonScript policy is invalid, then the deployment of the API proxy fails.
`InvalidResourceUrlReference`	If the `<ResourceURL>` or the `<IncludeURL>` elements refer to a PythonScript file that does not exist, then the deployment of the API proxy fails. The referenced source file must exist either the API proxy, environment, or organization level.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors.

Variables	Where	Example
`fault.name="fault_name"`	`fault_name` is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	`fault.name Matches "ScriptExecutionFailed"`
`pythonscript.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`pythonscript.PythonScript-1.failed = true`

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

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

Example fault rule

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