Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

정책 오류 참조

Apigee Edge 문서입니다.
Apigee X 문서로 이동 정보

AccessControl 정책

이 섹션에서는 반환되는 오류 코드, 오류 메시지, 그리고 이 정책이 오류를 트리거할 때 Edge에서 설정하는 오류 변수를 설명합니다. 오류를 처리하기 위해 오류 규칙을 개발 중인 경우, 이 정보는 중요합니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항 및 오류 처리를 참조하세요.

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	원인	해결
`accesscontrol.IPDeniedAccess`	403	클라이언트 IP 주소 또는 API 요청에서 전달된 IP 주소가 액세스 제어 정책의 `<MatchRule>` 요소 내 `<SourceAddress>` 요소에 지정된 IP 주소와 일치하며 `<MatchRule>` 요소의 `action` 속성이 `DENY`로 설정됩니다.

오류 변수

이러한 변수는 런타임 오류가 발생하면 설정됩니다. 자세한 내용은 정책 오류 관련 변수를 참조하세요.

변수	위치	예
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name Matches "IPDeniedAccess"`
`acl.policy_name.failed`	`policy_name`은 오류를 발생시킨 정책의 사용자 지정 이름입니다.	`acl.AC-AllowAccess.failed = true`

오류 응답 예시

참고: 오류 처리에서 권장사항은 오류 응답의 errorcode 부분을 트래핑하는 것입니다. 변경될 수 있으므로 faultstring의 텍스트에 의존하지 마세요.

{
   "fault":{
     "faultstring":"Access Denied for client ip : 52.211.243.3"
      "detail":{
         "errorcode":"accesscontrol.IPDeniedAccess"
      }
   }
}

오류 규칙 예시

<FaultRule name="IPDeniedAccess">
    <Step>
        <Name>AM-IPDeniedAccess</Name>
        <Condition>(fault.name Matches "IPDeniedAccess") </Condition>
    </Step>
    <Condition>(acl.failed = true) </Condition>
</FaultRule>

AccessEntity 정책

관련 정보는 정책 오류에 대해 알아야 할 사항과 오류 처리를 참조하세요.

런타임 오류

없음

배포 오류

오류 이름	오류 문자열	HTTP 상태	발생 상황
`InvalidEntityType`	`Invalid type [entity_type] in ACCESSENTITYStepDefinition [policy_name]`	해당 없음	사용된 항목 유형은 지원되는 유형 중 하나여야 합니다.

AssignMessage 정책

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge 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.assignmessage.SetVariableFailed 500 The policy was not able to set a variable. See the fault string for the name of the unresolved variable.

Fault code	HTTP status	Cause
`steps.assignmessage.SetVariableFailed`	500	The policy was not able to set a variable. See the fault string for the name of the unresolved variable.
`steps.assignmessage.VariableOfNonMsgType`	500	This error occurs if the `source` attribute in the `<Copy>` element is set to a variable which is not of type message. Message type variables represent entire HTTP requests and responses. The built-in Edge flow variables `request`, `response`, and `message` are of type message. To learn more about message variables, see the Variables reference.
`steps.assignmessage.UnresolvedVariable`	500	This error occurs if a variable specified in the Assign Message policy is either: out of scope (not available in the specific flow where the policy is being executed) or can't be resolved (is not defined)

steps.assignmessage.VariableOfNonMsgType

500

This error occurs if the source attribute in the <Copy> element is set to a variable which is not of type message.

Message type variables represent entire HTTP requests and responses. The built-in Edge flow variables request, response, and message are of type message. To learn more about message variables, see the Variables reference.

steps.assignmessage.UnresolvedVariable

500

This error occurs if a variable specified in the Assign Message policy is either:

out of scope (not available in the specific flow where the policy is being executed)
can't be resolved (is not defined)

Deployment errors

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

Error name	Cause	Fix
`InvalidIndex`	If the index specified in the `<Copy>` and/or `<Remove>` elements of the Assign Message policy is 0 or a negative number, then deployment of the API Proxy fails.
`InvalidVariableName`	If the child element `<Name>` is empty or not specified in the `<AssignVariable>` element, then the deployment of the API proxy fails because there is no valid variable name to which to assign a value. A valid variable name is required.
`InvalidPayload`	A payload specified in the policy is invalid.

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 "UnresolvedVariable"`
`assignmessage.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`assignmessage.AM-SetResponse.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":{  
      "detail":{  
         "errorcode":"steps.assignmessage.VariableOfNonMsgType"
      },
      "faultstring":"AssignMessage[AM-SetResponse]: value of variable is not of type Message"
   }
}

Example fault rule

    <FaultRule name="Assign Message Faults">    <Step>
        <Name>AM-CustomNonMessageTypeErrorResponse</Name>
        <Condition>(fault.name Matches "VariableOfNonMsgType") </Condition>
    </Step>
    <Step>
        <Name>AM-CustomSetVariableErrorResponse</Name>
        <Condition>(fault.name = "SetVariableFailed")</Condition>
    </Step>
    <Condition>(assignmessage.failed = true) </Condition>
</FaultRule>

BasicAuthentication 정책

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle errors. 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.basicauthentication.InvalidBasicAuthenticationSource`	500	On a decode when the incoming Base64 encoded string does not contain a valid value or the header is malformed (e.g., does not start with "Basic").
`steps.basicauthentication.UnresolvedVariable`	500	The required source variables for the decode or encode are not present. This error can only occur if `IgnoreUnresolvedVariables` is false.

Deployment errors

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

Error name	Occurs when	Fix
`UserNameRequired`	The `<User>` element must be present for the named operation.
`PasswordRequired`	The `<Password>` element must be present for the named operation.
`AssignToRequired`	The `<AssignTo>` element must be present for the named operation.
`SourceRequired`	The `<Source>` element must be present for the named operation.

Fault variables

These variables are set when a runtime error occurs. 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 "UnresolvedVariable"`
`BasicAuthentication.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`BasicAuthentication.BA-Authenticate.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":{  
      "detail":{  
         "errorcode":"steps.basicauthentication.UnresolvedVariable"
      },
      "faultstring":"Unresolved variable : request.queryparam.password"
   }
}

Example fault rule

<FaultRule name="Basic Authentication Faults">
    <Step>
        <Name>AM-UnresolvedVariable</Name>
        <Condition>(fault.name Matches "UnresolvedVariable") </Condition>
    </Step>
    <Step>
        <Name>AM-AuthFailedResponse</Name>
        <Condition>(fault.name = "InvalidBasicAuthenticationSource")</Condition>
    </Step>
    <Condition>(BasicAuthentication.BA-Authentication.failed = true) </Condition>
</FaultRule>

ConcurrentRateLimit 정책

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle errors. 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 Occurs when

Fault code	HTTP status	Occurs when
`policies.concurrentratelimit.ConcurrentRatelimtViolation`	503	ConcurrentRatelimit connection exceeded. Connection limit : {0} Note: The Fault code shown on the left is correct, although it contains a misspelling ("limt"). Be sure to use the code exactly as shown here when creating fault rules to trap this error.

policies.concurrentratelimit.ConcurrentRatelimtViolation

503

ConcurrentRatelimit connection exceeded. Connection limit : {0}

Note: The Fault code shown on the left is correct, although it contains a misspelling ("limt"). Be sure to use the code exactly as shown here when creating fault rules to trap this error.

Deployment errors

Error name	Occurs when
`InvalidCountValue`	ConcurrentRatelimit invalid count value specified.
`ConcurrentRatelimitStepAttachment\ NotAllowedAtProxyEndpoint`	Concurrent Ratelimit policy {0} attachment is not allowed at proxy request/response/fault paths. This policy must be placed on the Target Endpoint.
`ConcurrentRatelimitStepAttachment\ MissingAtTargetEndpoint`	Concurrent Ratelimit policy {0} attachment is missing at target request/response/fault paths. This policy must be placed in the Target Request Preflow, Target Response Postflow, and DefaultFaultRule.
`InvalidTTLForMessageTimeOut`	ConcurrentRatelimit invalid ttl value specified for message timeout. It must be a positive integer.

Fault variables

These variables are set when this policy triggers an error. 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 "ConcurrentRatelimtViolation"` Note: The Error code shown in the example is correct, although it contains a misspelling ("limt"). Please be sure to use the code exactly as shown here when creating fault rules to trap this error.
`concurrentratelimit.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`concurrentratelimit.CRL-RateLimitPolicy.failed = true`

Example error response

If the rate limit is exceeded, the policy returns only an HTTP status 503 to the client.

Example fault rule

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRules>
    <FaultRule name="Quota Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "ConcurrentRatelimtViolation") </Condition>
        </Step>
        <Condition>concurrentratelimit.CRL-RateLimitPolicy.failed=true</Condition>
    </FaultRule>
</FaultRules>

DecodeJWS 정책

이 섹션에서는 반환되는 오류 코드, 오류 메시지, 정책이 오류를 트리거할 때 Edge에서 설정하는 오류 변수를 설명합니다. 오류를 처리하기 위해 오류 규칙을 개발 중인 경우, 이 정보는 중요합니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항 및 오류 처리를 참조하세요.

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	발생 상황
`steps.jws.FailedToDecode`	401	정책에서 JWS를 디코딩할 수 없습니다. JWS가 손상되었을 수 있습니다.
`steps.jws.FailedToResolveVariable`	401	정책의 `<Source>` 요소에 지정된 흐름 변수가 존재하지 않는 경우 발생합니다.
`steps.jws.InvalidClaim`	401	소유권 주장 누락, 소유권 주장 불일치, 헤더 또는 헤더 불일치 누락
`steps.jws.InvalidJsonFormat`	401	JWS 헤더에 잘못된 JSON이 있습니다.
`steps.jws.InvalidJws`	401	이 오류는 JWS 서명 확인이 실패하면 발생합니다.
`steps.jws.InvalidPayload`	401	JWS 페이로드가 잘못되었습니다.
`steps.jws.InvalidSignature`	401	`<DetachedContent>`가 생략되고 JWS에 분리된 콘텐츠 페이로드가 있습니다.
`steps.jws.MissingPayload`	401	JWS 페이로드가 누락되었습니다.
`steps.jws.NoAlgorithmFoundInHeader`	401	JWS에서 알고리즘 헤더가 생략되면 발생합니다.
`steps.jws.UnknownException`	401	알 수 없는 예외가 발생했습니다.

배포 오류

이 오류는 이 정책이 포함된 프록시를 배포할 때 발생할 수 있습니다.

오류 이름 발생 상황

InvalidAlgorithm 유효한 값은 RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512뿐입니다.

오류 이름	발생 상황
`InvalidAlgorithm`	유효한 값은 RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512뿐입니다.
`EmptyElementForKeyConfiguration` `FailedToResolveVariable` `InvalidConfigurationForActionAndAlgorithmFamily` `InvalidConfigurationForVerify` `InvalidEmptyElement` `InvalidFamiliesForAlgorithm` `InvalidKeyConfiguration` `InvalidNameForAdditionalClaim` `InvalidNameForAdditionalHeader` `InvalidPublicKeyId` `InvalidPublicKeyValue` `InvalidSecretInConfig` `InvalidTypeForAdditionalClaim` `InvalidTypeForAdditionalHeader` `InvalidValueForElement` `InvalidValueOfArrayAttribute` `InvalidVariableNameForSecret` `MissingConfigurationElement` `MissingElementForKeyConfiguration` `MissingNameForAdditionalClaim` `MissingNameForAdditionalHeader`	기타 발생 가능한 배포 오류

EmptyElementForKeyConfiguration

FailedToResolveVariable

InvalidConfigurationForActionAndAlgorithmFamily

InvalidConfigurationForVerify

InvalidEmptyElement

InvalidFamiliesForAlgorithm

InvalidKeyConfiguration

InvalidNameForAdditionalClaim

InvalidNameForAdditionalHeader

InvalidPublicKeyId

InvalidPublicKeyValue

InvalidSecretInConfig

InvalidTypeForAdditionalClaim

InvalidTypeForAdditionalHeader

InvalidValueForElement

InvalidValueOfArrayAttribute

InvalidVariableNameForSecret

MissingConfigurationElement

MissingElementForKeyConfiguration

MissingNameForAdditionalClaim

MissingNameForAdditionalHeader

기타 발생 가능한 배포 오류

오류 변수

이러한 변수는 런타임 오류가 발생하면 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	위치	예
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name Matches "TokenExpired"`
`JWS.failed`	모든 JWS 정책은 오류 발생 시 동일한 변수를 설정합니다.	`jws.JWS-Policy.failed = true`

오류 응답 예시

오류 처리에서 오류 응답의 errorcode 부분을 트래핑하는 것이 가장 좋습니다. 변경될 수 있으므로 faultstring의 텍스트에 의존하지 마세요.

오류 규칙 예시

<FaultRules>
    <FaultRule name="JWS Policy Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "TokenExpired")</Condition>
        </Step>
        <Condition>JWS.failed=true</Condition>
    </FaultRule>
</FaultRules>

DecodeJWT 정책

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	원인
`steps.jwt.FailedToDecode`	401	정책이 JWT를 디코딩할 수 없는 경우에 발생합니다. JWT의 형식이 잘못되었거나 유효하지 않거나 디코딩할 수 없습니다.
`steps.jwt.FailedToResolveVariable`	401	정책의 `<Source>` 요소에 지정된 흐름 변수가 존재하지 않는 경우 발생합니다.
`steps.jwt.InvalidToken`	401	정책의 `<Source>` 요소에 지정된 흐름 변수가 범위를 벗어나거나 해결할 수 없는 경우 발생합니다.

배포 오류

이 오류는 이 정책이 포함된 프록시를 배포할 때 발생할 수 있습니다.

오류 이름	원인	해결
`InvalidEmptyElement`	디코딩할 JWT가 포함된 흐름 변수가 정책의 `<Source>` 요소에 지정되지 않은 경우 발생합니다.

오류 변수

이러한 변수는 런타임 오류가 발생하면 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	위치	예
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name Matches "TokenExpired"`
`JWT.failed`	모든 JWT 정책은 오류 발생 시 동일한 변수를 설정합니다.	`JWT.failed = true`

오류 응답 예시

JWT 정책 오류 코드

오류 처리에서 권장사항은 오류 응답의 errorcode 부분을 트래핑하는 것입니다. 변경될 수 있으므로 faultstring의 텍스트에 의존하지 마세요.

오류 규칙 예시

    <FaultRules>
        <FaultRule name="JWT Policy Errors">
            <Step>
                <Name>JavaScript-1</Name>
                <Condition>(fault.name Matches "TokenExpired")</Condition>
            </Step>
            <Condition>JWT.failed=true</Condition>
        </FaultRule>
    </FaultRules>

ExtractVariables 정책

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	원인
`steps.extractvariables.ExecutionFailed`	500	이 오류는 다음과 같은 경우에 발생합니다. 입력 페이로드(JSON, XML)가 비어 있습니다. 정책에 전달된 입력(JSON, XML 등)이 잘못되었거나 형식이 잘못되었습니다.
`steps.extractvariables.ImmutableVariable`	500	정책에 사용된 변수는 변경할 수 없습니다. 정책에서 이 변수를 설정할 수 없습니다.
`steps.extractvariables.InvalidJSONPath`	500	이 오류는 정책의 `JSONPath` 요소에 잘못된 JSON 경로가 사용되는 경우 발생합니다. 예를 들어 JSON 페이로드에는 `Name` 객체가 없지만 정책의 경로로 `Name`을 지정하면 이 오류가 발생합니다.
`steps.extractvariables.JsonPathParsingFailure`	500	이 오류는 정책이 JSON 경로를 파싱하고 `Source` 요소에 지정된 흐름 변수에서 데이터를 추출할 수 없는 경우에 발생합니다. 일반적으로 `Source` 요소에 지정된 흐름 변수가 현재 흐름에 없으면 이 오류가 발생합니다.
`steps.extractvariables.SetVariableFailed`	500	이 오류는 정책이 값을 변수로 설정하지 못하는 경우에 발생합니다. 이러한 오류는 일반적으로 이름이 중첩된 점으로 구분된 형식으로 된 동일한 단어로 시작하는 여러 변수에 값을 할당하려고 하면 발생합니다.
`steps.extractvariables.SourceMessageNotAvailable`	500	이 오류는 SOAPMessageValidation 정책의 `Source` 요소에 지정된 message 변수가 다음 중 하나일 때 발생합니다. 범위를 벗어난 경우(정책이 실행 중인 특정 흐름에서 사용할 수 없음) 확인할 수 없는 경우(정의되지 않음)
`steps.extractvariables.UnableToCast`	500	이 오류는 정책이 추출된 값을 변수로 전송할 수 없는 경우에 발생합니다. 일반적으로 한 데이터 유형의 값을 다른 데이터 유형의 변수로 설정하려고 하면 이 오류가 발생합니다.

배포 오류

이 오류는 이 정책이 포함된 프록시를 배포할 때 발생할 수 있습니다.

오류 이름	원인	해결
`NothingToExtract`	정책에 `URIPath`, `QueryParam`, `Header`, `FormParam`, `XMLPayload` 또는 `JSONPayload` 요소가 없으면 추출할 대상이 없기 떄문에 API 프록시 배포는 실패합니다.
`NONEmptyPrefixMappedToEmptyURI`	이 오류는 정책에, `XMLPayload` 요소 아래의 `Namespace` 요소에서 정의된 프리픽스가 있지만 URI가 정의되지 않은 경우에 발생합니다.
`DuplicatePrefix`	이 오류는 `XMLPayload` 요소 아래의 `Namespace` 요소에서 두 번 이상 정의된 프리픽스와 동일한 프리픽스가 정책에 있으면 발생합니다.
`NoXPathsToEvaluate`	정책의 `XMLPayload` 요소 내에 `XPath` 요소가 없으면 이 오류로 인해 API 프록시 배포가 실패합니다. XML 페이로드에서 변수를 추출하려면 `XPath` 하위 요소를 지정해야 합니다.
`EmptyXPathExpression`	정책이 `XMLPayload` 요소 내에 빈 `XPath` 표현식을 포함하는 경우 API 프록시 배포에 실패합니다.
`NoJSONPathsToEvaluate`	정책의 `JSONPayload` 요소 내에 `JSONPath` 요소가 없으면 이 오류로 인해 API 프록시 배포가 실패합니다.
`EmptyJSONPathExpression`	정책이 `XMLPayload` 요소 내에 빈 `XPath` 표현식을 포함하는 경우 API 프록시 배포에 실패합니다.
`MissingName`	정책이 `QueryParam`, `Header`, `FormParam` 또는 `Variable`과 같은 정책 요소 안에 필요한 `name` 속성을 가지지 않는다면 API 프록시가 실패합니다.
`PatternWithoutVariable`	정책에 `Pattern` 요소 내에 지정된 변수가 없으면 API 프록시 배포는 실패합니다. `Pattern` 요소에는 추출된 데이터가 저장될 변수의 이름이 필요합니다.
`CannotBeConvertedToNodeset`	정책에 `Variable` 유형이 nodeset로 정의된 `XPath` 표현식이 있지만 표현식을 nodeset로 변환할 수 없으면 API 프록시 배포가 실패합니다.
`JSONPathCompilationFailed`	정책에서 지정된 JSON 경로를 컴파일할 수 없습니다.
`InstantiationFailed`	정책을 인스턴스화할 수 없습니다.
`XPathCompilationFailed`	`XPath` 요소에 사용된 프리픽스 또는 값이 정책에 선언된 네임스페이스의 일부가 아닌 경우 API 프록시의 배포는 실패합니다.
`InvalidPattern`	정책의 `URIPath`, `QueryParam`, `Header`, `FormParam`, `XMLPayload` 또는 `JSONPayload`와 같은 요소에서 `Pattern` 요소의 정의가 잘못되었으면 API 프록시 배포가 실패합니다. `Pattern` 요소는 변수를 포함하지 않으면 잘못된 것으로 간주됩니다. 패턴 일치에 대한 자세한 내용은 일치 및 변수 생성 정보를 참조하세요.

오류 변수

이러한 변수는 이 정책이 런타임 시 오류를 트리거할 때 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	위치	예
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name = "SourceMessageNotAvailable"`
`extractvariables.policy_name.failed`	`policy_name`은 오류를 발생시킨 정책의 사용자 지정 이름입니다.	`extractvariables.EV-ParseJsonResponse.failed = true`

오류 응답 예시

참고: 오류 처리에서 권장사항은 오류 응답의 errorcode 부분을 트래핑하는 것입니다. 변경될 수 있으므로 faultstring의 텍스트에 의존하지 마세요.

{
   "fault":{
      "detail":{
         "errorcode":"steps.extractvariables.SourceMessageNotAvailable"
      },
      "faultstring":"request message is not available for ExtractVariable: EV-ParseJsonResponse"
   }
}

오류 규칙 예시

<FaultRule name="Extract Variable Faults">
    <Step>
        <Name>AM-CustomErrorMessage</Name>
        <Condition>(fault.name = "SourceMessageNotAvailable") </Condition>
    </Step>
    <Condition>(extractvariables.EM-ParseJsonResponse.failed = true) </Condition>
</FaultRule>

GenerateJWS 정책

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	발생 상황
`steps.jws.GenerationFailed`	401	정책이 JWS를 생성하지 못했습니다.
`steps.jws.InsufficientKeyLength`	401	HS256 알고리즘의 키가 32바이트 미만인 경우
`steps.jws.InvalidClaim`	401	소유권 주장 누락, 소유권 주장 불일치, 헤더 또는 헤더 불일치 누락
`steps.jws.InvalidCurve`	401	키에서 지정한 곡선은 타원 곡선 알고리즘에 유효하지 않습니다.
`steps.jws.InvalidJsonFormat`	401	JWS 헤더에 잘못된 JSON이 있습니다.
`steps.jws.InvalidPayload`	401	JWS 페이로드가 잘못되었습니다.
`steps.jws.InvalidSignature`	401	`<DetachedContent>`가 생략되고 JWS에 분리된 콘텐츠 페이로드가 있습니다.
`steps.jws.KeyIdMissing`	401	인증 정책은 JWKS를 공개 키의 소스로 사용하지만 서명된 JWS의 헤더에 `kid` 속성이 포함되어 있지 않습니다.
`steps.jws.KeyParsingFailed`	401	주어진 키 정보에서 공개 키를 파싱할 수 없습니다.
`steps.jws.MissingPayload`	401	JWS 페이로드가 누락되었습니다.
`steps.jws.NoAlgorithmFoundInHeader`	401	JWS에서 알고리즘 헤더가 생략되면 발생합니다.
`steps.jws.SigningFailed`	401	GenerateJWS에서 HS384 또는 HS512 알고리즘의 최소 크기보다 작은 키일 때 발생합니다.
`steps.jws.UnknownException`	401	알 수 없는 예외가 발생했습니다.
`steps.jws.WrongKeyType`	401	잘못된 유형의 키가 지정되었습니다. 예를 들어 타원 곡선 알고리즘의 RSA 키를 지정하거나 RSA 알고리즘의 곡선 키를 지정하는 경우입니다.

배포 오류

이 오류는 이 정책이 포함된 프록시를 배포할 때 발생할 수 있습니다.

오류 이름 발생 상황

InvalidAlgorithm 유효한 값은 RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512뿐입니다.

오류 이름	발생 상황
`InvalidAlgorithm`	유효한 값은 RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512뿐입니다.
`EmptyElementForKeyConfiguration` `FailedToResolveVariable` `InvalidConfigurationForActionAndAlgorithmFamily` `InvalidConfigurationForVerify` `InvalidEmptyElement` `InvalidFamiliesForAlgorithm` `InvalidKeyConfiguration` `InvalidNameForAdditionalClaim` `InvalidNameForAdditionalHeader` `InvalidPublicKeyId` `InvalidPublicKeyValue` `InvalidSecretInConfig` `InvalidTypeForAdditionalClaim` `InvalidTypeForAdditionalHeader` `InvalidValueForElement` `InvalidValueOfArrayAttribute` `InvalidVariableNameForSecret` `MissingConfigurationElement` `MissingElementForKeyConfiguration` `MissingNameForAdditionalClaim` `MissingNameForAdditionalHeader`	기타 발생 가능한 배포 오류

EmptyElementForKeyConfiguration

FailedToResolveVariable

InvalidConfigurationForActionAndAlgorithmFamily

InvalidConfigurationForVerify

InvalidEmptyElement

InvalidFamiliesForAlgorithm

InvalidKeyConfiguration

InvalidNameForAdditionalClaim

InvalidNameForAdditionalHeader

InvalidPublicKeyId

InvalidPublicKeyValue

InvalidSecretInConfig

InvalidTypeForAdditionalClaim

InvalidTypeForAdditionalHeader

InvalidValueForElement

InvalidValueOfArrayAttribute

InvalidVariableNameForSecret

MissingConfigurationElement

MissingElementForKeyConfiguration

MissingNameForAdditionalClaim

MissingNameForAdditionalHeader

기타 발생 가능한 배포 오류

오류 변수

이러한 변수는 런타임 오류가 발생하면 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	위치	예
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name Matches "TokenExpired"`
`JWS.failed`	모든 JWS 정책은 오류 발생 시 동일한 변수를 설정합니다.	`jws.JWS-Policy.failed = true`

오류 응답 예시

오류 처리에서 오류 응답의 errorcode 부분을 트래핑하는 것이 가장 좋습니다. 변경될 수 있으므로 faultstring의 텍스트에 의존하지 마세요.

오류 규칙 예시

<FaultRules>
    <FaultRule name="JWS Policy Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "TokenExpired")</Condition>
        </Step>
        <Condition>JWS.failed=true</Condition>
    </FaultRule>
</FaultRules>

GenerateJWT 정책

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Occurs when
`steps.jwt.AlgorithmInTokenNotPresentInConfiguration`	401	Occurs when the verification policy has multiple algorithms.
`steps.jwt.AlgorithmMismatch`	401	The algorithm specified in the Generate policy did not match the one expected in the Verify policy. The algorithms specified must match.
`steps.jwt.FailedToDecode`	401	The policy was unable to decode the JWT. The JWT is possibly corrupted.
`steps.jwt.GenerationFailed`	401	The policy was unable to generate the JWT.
`steps.jwt.InsufficientKeyLength`	401	For a key less than 32 bytes for the HS256 algorithm, less than 48 bytes for the HS386 algortithm, and less than 64 bytes for the HS512 algorithm.
`steps.jwt.InvalidClaim`	401	For a missing claim or claim mismatch, or a missing header or header mismatch.
`steps.jwt.InvalidCurve`	401	The curve specified by the key is not valid for the Elliptic Curve algorithm.
`steps.jwt.InvalidJsonFormat`	401	Invalid JSON found in the header or payload.
`steps.jwt.InvalidToken`	401	This error occurs when the JWT signature verification fails.
`steps.jwt.JwtAudienceMismatch`	401	The audience claim failed on token verification.
`steps.jwt.JwtIssuerMismatch`	401	The issuer claim failed on token verification.
`steps.jwt.JwtSubjectMismatch`	401	The subject claim failed on token verification.
`steps.jwt.KeyIdMissing`	401	The Verify policy uses a JWKS as a source for public keys, but the signed JWT does not include a `kid` property in the header.
`steps.jwt.KeyParsingFailed`	401	The public key could not be parsed from the given key information.
`steps.jwt.NoAlgorithmFoundInHeader`	401	Occurs when the JWT contains no algorithm header.
`steps.jwt.NoMatchingPublicKey`	401	The Verify policy uses a JWKS as a source for public keys, but the `kid` in the signed JWT is not listed in the JWKS.
`steps.jwt.SigningFailed`	401	In GenerateJWT, for a key less than the minimum size for the HS384 or HS512 algorithms
`steps.jwt.TokenExpired`	401	The policy attempts to verify an expired token.
`steps.jwt.TokenNotYetValid`	401	The token is not yet valid.
`steps.jwt.UnhandledCriticalHeader`	401	A header found by the Verify JWT policy in the `crit` header is not listed in `KnownHeaders`.
`steps.jwt.UnknownException`	401	An unknown exception occurred.
`steps.jwt.WrongKeyType`	401	Wrong type of key specified. For example, if you specify an RSA key for an Elliptic Curve algorithm, or a curve key for an RSA algorithm.

Deployment errors

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

Error name	Cause	Fix
`InvalidNameForAdditionalClaim`	The deployment will fail if the claim used in the child element `<Claim>` of the `<AdditionalClaims>` element is one of the following registered names: `kid`, `iss`, `sub`, `aud`, `iat`, `exp`, `nbf`, or `jti`.
`InvalidTypeForAdditionalClaim`	If the claim used in the child element `<Claim>` of the `<AdditionalClaims>` element is not of type `string`, `number`, `boolean`, or `map`, the deployment will fail.
`MissingNameForAdditionalClaim`	If the name of the claim is not specified in the child element `<Claim>` of the `<AdditionalClaims>` element, the deployment will fail.
`InvalidNameForAdditionalHeader`	This error ccurs when the name of the claim used in the child element `<Claim>` of the `<AdditionalClaims>` element is either `alg` or `typ`.
`InvalidTypeForAdditionalHeader`	If the type of claim used in the child element `<Claim>` of the `<AdditionalClaims>` element is not of type `string`, `number`, `boolean`, or `map`, the deployment will fail.
`InvalidValueOfArrayAttribute`	This error occurs when the value of the array attribute in the child element `<Claim>` of the `<AdditionalClaims>` element is not set to `true` or `false`.
`InvalidConfigurationForActionAndAlgorithm`	If the `<PrivateKey>` element is used with HS Family algorithms or the `<SecretKey>` element is used with RSA Family algorithms, the deployment will fail.
`InvalidValueForElement`	If the value specified in the `<Algorithm>` element is not a supported value, the deployment will fail.
`MissingConfigurationElement`	This error will occur if the `<PrivateKey>` element is not used with RSA family algorithms or the `<SecretKey>` element is not used with HS Family algorithms.
`InvalidKeyConfiguration`	If the child element `<Value>` is not defined in the `<PrivateKey>` or `<SecretKey>` elements, the deployment will fail.
`EmptyElementForKeyConfiguration`	If the ref attribute of the child element `<Value>` of the `<PrivateKey>` or `<SecretKey>` elements is empty or unspecified, the deployment will fail.
`InvalidVariableNameForSecret`	This error occurs if the flow variable name specified in the ref attribute of the child element `<Value>` of the `<PrivateKey>` or `<SecretKey>` elements does not contain the private prefix `(private.)`.
`InvalidSecretInConfig`	This error occurs if the child element `<Value>` of the `<PrivateKey>` or `<SecretKey>` elements does not contain the private prefix `(private.)`.
`InvalidTimeFormat`	If the value specified in the`<NotBefore>` element does not use a supported format, the deployment will fail.

오류 변수

이러한 변수는 런타임 오류가 발생하면 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	위치	예
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name Matches "TokenExpired"`
`JWT.failed`	모든 JWT 정책은 오류 발생 시 동일한 변수를 설정합니다.	`JWT.failed = true`

오류 응답 예시

JWT 정책 오류 코드

오류 처리에서 권장사항은 오류 응답의 errorcode 부분을 트래핑하는 것입니다. 변경될 수 있으므로 faultstring의 텍스트에 의존하지 마세요.

오류 규칙 예시

    <FaultRules>
        <FaultRule name="JWT Policy Errors">
            <Step>
                <Name>JavaScript-1</Name>
                <Condition>(fault.name Matches "TokenExpired")</Condition>
            </Step>
            <Condition>JWT.failed=true</Condition>
        </FaultRule>
    </FaultRules>

JavaCallout 정책

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	원인	해결
`steps.javacallout.ExecutionError`	500	Java콜아웃 정책을 실행하는 동안 Java 코드에서 예외가 발생하거나 null을 반환할 때 발생합니다.

배포 오류

이런 오류는 정책이 포함된 프록시를 배포할 때 발생할 수 있습니다.

오류 이름	오류 문자열	HTTP 상태	발생 상황
`ResourceDoesNotExist`	`Resource with name [name] and type [type] does not exist`	해당 없음	`<ResourceURL>` 요소에 지정된 파일이 존재하지 않습니다.
`JavaCalloutInstantiationFailed`	`Failed to instantiate the JavaCallout Class [classname]`	해당 없음	`<ClassName>` 요소에 지정된 클래스 파일이 jar에 없습니다.
`IncompatibleJavaVersion`	`Failed to load java class [classname] definition due to - [reason]`	해당 없음	오류 문자열을 참조하세요. 지원됨 소프트웨어 및 지원되는 버전을 참고하세요.
`JavaClassNotFoundInJavaResource`	`Failed to find the ClassName in java resource [jar_name] - [class_name]`	해당 없음	결함 문자열을 참조하세요.
`JavaClassDefinitionNotFound`	`Failed to load java class [class_name] definition due to - [reason]`	해당 없음	결함 문자열을 참조하세요.
`NoAppropriateConstructor`	`No appropriate constructor found in JavaCallout class [class_name]`	해당 없음	결함 문자열을 참조하세요.
`NoResourceForURL`	`Could not locate a resource with URL [string]`	해당 없음	결함 문자열을 참조하세요.

오류 변수

이러한 변수는 이 정책으로 오류가 트리거될 때 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	위치	예
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name Matches "ExecutionError"`
`javacallout.policy_name.failed`	`policy_name`은 오류를 발생시킨 정책의 사용자 지정 이름입니다.	`javacallout.JC-GetUserData.failed = true`

오류 응답 예시

{  
   "fault":{  
      "faultstring":"Failed to execute JavaCallout. [policy_name]",
      "detail":{  
         "errorcode":"javacallout.ExecutionError"
      }
   }
}

오류 규칙 예시

<FaultRule name="JavaCalloutFailed">
    <Step>
        <Name>AM-JavaCalloutError</Name>
    </Step>
    <Condition>(fault.name Matches "ExecutionError") </Condition>
</FaultRule>

자바스크립트 정책

이 섹션에서는 반환되는 오류 코드 및 오류 메시지와 오류 변수를 설명합니다. 이 정책이 오류를 트리거할 때 Edge에서 설정되는 값 오류를 처리하기 위해 오류 규칙을 개발 중인 경우, 이 정보는 중요합니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항 및 오류 처리를 참조하세요.

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	원인	해결
`steps.javascript.ScriptExecutionFailed`	500	자바스크립트 정책으로 인해 다양한 유형의 ScriptExecutionFailed 오류가 발생할 수 있습니다. 자주 볼 수 있는 오류 유형에는 RangeError, ReferenceError, SyntaxError, TypeError, URIError
`steps.javascript.ScriptExecutionFailedLineNumber`	500	JavaScript 코드에서 오류가 발생했습니다. 자세한 내용은 오류 문자열을 참조하세요.	해당 사항 없음
`steps.javascript.ScriptSecurityError`	500	JavaScript를 실행할 때 보안 오류가 발생했습니다. 자세한 내용은 오류 문자열을 참조하세요.	해당 없음

배포 오류

이 오류는 이 정책이 포함된 프록시를 배포할 때 발생할 수 있습니다.

오류 이름	원인	수정
`InvalidResourceUrlFormat`	자바스크립트 정책의 `<ResourceURL>` 또는 `<IncludeURL>` 요소 내에서 지정된 리소스 URL 형식이 잘못된 경우 API 프록시 배포가 실패합니다.
`InvalidResourceUrlReference`	`<ResourceURL>` 또는 `<IncludeURL>` 요소가 존재하지 않는 JavaScript 파일을 참조하는 경우 API 프록시 배포가 실패합니다. 참조된 소스 파일은 API 프록시, 환경 또는 조직 수준에 있어야 합니다.
`WrongResourceType`	이 오류는 배포 중에 `<ResourceURL>` 또는 `<IncludeURL>` JavaScript 정책의 요소는 jsc (JavaScript 파일) 이외의 리소스 유형을 참조합니다.
`NoResourceURLOrSource`	`<ResourceURL>` 요소가 선언되지 않았거나 리소스 URL이 이 요소 내에 정의되지 않은 경우. `<ResourceURL>` 요소는 필수 요소입니다. 또는 `<IncludeURL>` 요소가 선언됩니다. 리소스 URL은 이 요소 내에 정의되어 있지 않습니다. `<IncludeURL>` 요소는 선택사항입니다. 하지만 선언된 경우 리소스 URL을 `<IncludeURL>` 요소 내에 지정해야 합니다.

오류 변수

이러한 변수는 이 정책이 런타임 시 오류를 트리거할 때 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	위치	예
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name Matches "ScriptExecutionFailed"`
`javascript.policy_name.failed`	`policy_name`은 오류를 발생시킨 정책의 사용자 지정 이름입니다.	`javascript.JavaScript-1.failed = true`

오류 응답 예시

참고: 오류 처리에서 권장사항은 오류 응답의 errorcode 부분을 트래핑하는 것입니다. 변경될 수 있으므로 faultstring의 텍스트에 의존하지 마세요.

{
  "fault": {
    "faultstring": "Execution of SetResponse failed with error: Javascript runtime error: "ReferenceError: "status" is not defined. (setresponse.js:6)\"",
    "detail": {
      "errorcode": "steps.javascript.ScriptExecutionFailed"
    }
  }
}

오류 규칙 예시

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

JSONThreatProtection 정책

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	원인
`steps.jsonthreatprotection.ExecutionFailed`	500	JSONThreatProtection 정책은 다양한 유형의 ExecutionFailed 오류를 발생시킬 수 있습니다. 이러한 오류의 대부분은 정책에 설정된 특정 임계값을 초과할 때 발생합니다. 이러한 오류 유형은 다음과 같습니다. 객체 항목 이름 길이 객체 항목 수 배열 요소 수, 컨테이너 깊이, 문자열 문자열 값 길이. 이 오류는 페이로드에 잘못된 JSON 객체가 포함된 경우에도 발생합니다.
`steps.jsonthreatprotection.SourceUnavailable`	500	이 오류는 `<Source>` 요소에 지정된 메시지 변수가 다음 중 하나일 때 발생합니다. 범위를 벗어난 경우(정책이 실행 중인 특정 흐름에서 사용할 수 없음) 유효한 값 `request`, `response` 또는 `message` 중 하나가 아님
`steps.jsonthreatprotection.NonMessageVariable`	500	이 오류는 `<Source>` 요소가 메시지 유형이 아닌 변수로 설정된 경우에 발생합니다.

배포 오류

없음

오류 변수

이러한 변수는 이 정책으로 오류가 트리거될 때 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	위치	예
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name Matches "SourceUnavailable"`
`jsonattack.policy_name.failed`	`policy_name`은 오류를 발생시킨 정책의 사용자 지정 이름입니다.	`jsonattack.JTP-SecureRequest.failed = true`

오류 응답 예시

{
  "fault": {
    "faultstring": "JSONThreatProtection[JPT-SecureRequest]: Execution failed. reason: JSONThreatProtection[JTP-SecureRequest]: Exceeded object entry name length at line 2",
    "detail": {
      "errorcode": "steps.jsonthreatprotection.ExecutionFailed"
    }
  }
}

오류 규칙 예시

<FaultRule name="JSONThreatProtection Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ExecutionFailed") </Condition>
    </Step>
    <Condition>(jsonattack.JPT-SecureRequest.failed = true) </Condition>
</FaultRule>

JSONThreatProtection 정책 유형은 다음 오류 코드를 정의합니다.

JSONtoXML 정책

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`steps.jsontoxml.ExecutionFailed`	500	The input payload (JSON) is empty or the input (JSON) passed to JSON to XML policy is invalid or malformed.
`steps.jsontoxml.InCompatibleTypes`	500	This error occurs if the type of the variable defined in the `<Source>` element and the `<OutputVariable>` element are not the same. It is mandatory that the type of the variables contained within the `<Source>` element and the `<OutputVariable>` element matches. The valid types are `message` and `string`.
`steps.jsontoxml.InvalidSourceType`	500	This error occurs if the type of the variable used to define the `<Source>` element is invalid. The valid types of variable are `message` and `string`.
`steps.jsontoxml.OutputVariableIsNotAvailable`	500	This error occurs if the variable specified in the `<Source>` element of the JSON to XML Policy is of type string and the `<OutputVariable>` element is not defined. The `<OutputVariable>` element is mandatory when the variable defined in the `<Source>` element is of type string.
`steps.jsontoxml.SourceUnavailable`	500	This error occurs if the message variable specified in the `<Source>` element of the JSON to XML policy is either: out of scope (not available in the specific flow where the policy is being executed) or can't be resolved (is not defined)

Deployment errors

None.

Fault variables

These variables are set when a runtime error occurs. 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 "SourceUnavailable"`
`jsontoxml.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`jsontoxml.JSON-to-XML-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": "JSONToXML[JSON-to-XML-1]: Source xyz is not available",
    "detail": {
      "errorcode": "steps.json2xml.SourceUnavailable"
    }
  }
}

Example fault rule

<FaultRule name="JSON To XML Faults">
    <Step>
        <Name>AM-SourceUnavailableMessage</Name>
        <Condition>(fault.name Matches "SourceUnavailable") </Condition>
    </Step>
    <Step>
        <Name>AM-BadJSON</Name>
        <Condition>(fault.name = "ExecutionFailed")</Condition>
    </Step>
    <Condition>(jsontoxml.JSON-to-XML-1.failed = true) </Condition>
</FaultRule>

KeyValueMapOperations 정책

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause	Fix
`steps.keyvaluemapoperations.SetVariableFailed`	500	This error occurs if you try to retrieve a value from an encrypted key value map and set the value to a variable whose name does not have the prefix `private`. The prefix, which is required for basic security purposes during debugging, hides the encrypted values from API proxy Trace and debug sessions.
`steps.keyvaluemapoperations.UnsupportedOperationException`	500	This error occurs if the `mapIdentifier` attribute is set to empty string in the Key Value Map Operations policy.

Deployment errors

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

Error name	Cause	Fix
`InvalidIndex`	If the `index` attribute specified in the `<Get>` element of Key Value Map Operations policy is zero or a negative number, then the deployment of the API proxy fails. The index starts from `1`, so an index of zero or negative integer is considered as invalid.
`KeyIsMissing`	This error occurs if the `<Key>` element is completely missing or `<Parameter>` element is missing within `<Key>` element underneath the `<Entry>` of the `<InitialEntries>` element of the Key Value Map Operations policy.
`ValueIsMissing`	This error occurs if the `<Value>` element is missing underneath the `<Entry>` element of the `<InitialEntries>` element of the Key Value Map Operations policy.

LDAP 정책

This policy uses the following error codes:

Error Code	Message
`InvalidAttributeName`	`Invalid attribute name {0}.`
`InvalidSearchBase`	`Search base can not be empty.`
`InvalidValueForPassword`	`Invalid value for password field. It can not be empty.`
`InvalidSearchScope`	`Invalid scope {0}. Allowed scopes are {1}.`
`InvalidUserCredentials`	`Invalid user credentials.`
`InvalidExternalLdapReference`	`Invalid external ldap reference {0}.`
`LdapResourceNotFound`	`Ldap resource {0} not found.`
`BaseDNRequired`	`Base DN required.`
`OnlyReferenceOrValueIsAllowed`	`Only value or reference is allowed for {0}.`
`AttributesRequired`	`At least one attribute required for search action.`
`UserNameIsNull`	`User name is null.`
`SearchQueryAndUserNameCannotBePresent`	`Both search query and username can not be present in the authentication action. Please specify either one of them.`

MessageLogging 정책

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`steps.messagelogging.StepDefinitionExecutionFailed`	500	See fault string.

Deployment errors

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

Error name	Cause	Fix
`InvalidProtocol`	The deployment of the MessageLogging policy can fail with this error if the protocol specified within the `<Protocol>` element is not valid. The valid protocols are TCP and UDP. For sending syslog messages over TLS/SSL, only TCP is supported.
`InvalidPort`	The deployment of the MessageLogging policy can fail with this error if the port number is not specified within the `<Port>` element or if it is not valid. The port number must be an integer greater than zero.

Fault variables

These variables are set when a runtime error occurs. 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 "StepDefinitionExecutionFailed"`
`messagelogging.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`messagelogging.ML-LogMessages.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":{  
      "detail":{  
         "errorcode":"steps.messagelogging.StepDefinitionExecutionFailed"
      },
      "faultstring":"Execution failed"
   }
}

Example fault rule

<FaultRule name="MessageLogging">
    <Step>
        <Name>ML-LogMessages</Name>
        <Condition>(fault.name Matches "StepDefinitionExecutionFailed") </Condition>
    </Step>
    <Condition>(messagelogging.ML-LogMessages.failed = true) </Condition>
</FaultRule>

OASValidation 정책

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`steps.oasvalidation.Failed`	500	Request message body cannot be validated against the provided OpenAPI Specification.
`steps.oasvalidation.SourceMessageNotAvailable`	500	Variable specified in the `<Source>` element of the policy is either out of scope or cannot be resolved.
`steps.oasvalidation.NotMessageVariable`	500	`<Source>` element is set to a variable that is not of type message.

Deployment errors

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

Error name	Cause
`ResourceDoesNotExist`	OpenAPI Specification referenced in the `<OASResource>` element does not exist.
`ResourceCompileFailed`	OpenAPI Specification that is included in the deployment contains errors that prevent it from being compiled. This generally indicates that the specification is not a well-formed OpenAPI Specification 3.0.
`BadResourceURL`	OpenAPI Specification referenced in the `<OASResource>` element cannot be processed. This can occur if the file is not a JSON or YAML file or the file URL is not specified correctly.

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 "ResourceDoesNotExist"`
`oasvalidation.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`oasvalidation.myoaspolicy.failed = true`

PopulateCache 정책

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP Status	Occurs when
`policies.populatecache.EntryCannotBeCached`	500	An entry cannot be cached. The message object being cached is not an instance of a class that is Serializable.

Deployment errors

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

Error name	Cause	Fix
`InvalidCacheResourceReference`	This error occurs if the `<CacheResource>` element in the PopulateCache policy is set to a name that does not exist in the environment where the API proxy is being deployed.
`CacheNotFound`	The cache specified in the `<CacheResource>` element does not exist.

Fault variables

These variables are set when this policy triggers an error. 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 = "EntryCannotBeCached"`
`populatecache.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`populatecache.POP-CACHE-1.failed = true`

Example error response

{
  "fault": {
    "faultstring": "[entry] can not be cached. Only serializable entries are cached.",
    "detail": {
      "errorcode": "steps.populatecache.EntryCannotBeCached"
    }
  }
}

Example fault rule

<FaultRule name="Populate Cache Fault">
    <Step>
        <Name>AM-EntryCannotBeCached</Name>
        <Condition>(fault.name Matches "EntryCannotBeCached") </Condition>
    </Step>
    <Condition>(populatecache.POP-CACHE-1.failed = true) </Condition>
</FaultRule>

LookupCache 정책

이 섹션에서는 이 정책이 오류를 트리거할 때 설정되는 오류 메시지 및 흐름 변수에 대해 설명합니다. 이 정보는 프록시에 대한 오류 규칙을 개발하는 중이라면 중요합니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항 및 오류 처리를 참조하세요.

오류 코드 프리픽스

N/A

런타임 오류

이 정책은 런타임 오류를 발생시키지 않습니다.

배포 오류

이 오류는 이 정책이 포함된 프록시를 배포할 때 발생할 수 있습니다.

오류 이름	원인	수정
`InvalidCacheResourceReference`	이 오류는 `<CacheResource>` 요소의 이름이 API 프록시가 배포되는 환경에 존재하지 않는 이름으로 설정되는 경우에 발생합니다.
`InvalidTimeout`	`<CacheLookupTimeoutInSeconds>` 요소가 음수로 설정되면 API 프록시 배포가 실패합니다.
`CacheNotFound`	이 오류는 오류 메시지에 언급된 특정 캐시가 특정 메시지 프로세서 구성요소에 생성되지 않은 경우에 발생합니다.

오류 변수

해당 없음

오류 응답 예시

N/A

InvalidateCache 정책

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

Error code prefix

N/A

Runtime errors

This policy does not throw any runtime errors.

Deployment errors

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

Error name	Cause	Fix
`InvalidCacheResourceReference`	This error occurs if the `<CacheResource>` element in the InvalidateCache policy is set to a name that does not exist in the environment where the API proxy is being deployed.
`CacheNotFound`	This error occurs if the specific cache mentioned in the error message has not been created on a specific Message Processor component.

Fault variables

N/A

Example error response

N/A

ResponseCache 정책

오류 코드 프리픽스

N/A

런타임 오류

이 정책은 런타임 오류를 발생시키지 않습니다.

배포 오류

이 오류는 이 정책이 포함된 프록시를 배포할 때 발생할 수 있습니다.

오류 이름	원인	수정
`InvalidTimeout`	ResponseCache 정책의 `<CacheLookupTimeoutInSeconds>` 요소가 음수로 설정되면 API 프록시 배포가 실패합니다.
`InvalidCacheResourceReference`	이 오류는 ResponseCache 정책의 `<CacheResource>` 요소가 API 프록시가 배포되는 환경에 존재하지 않는 이름으로 설정되는 경우에 발생합니다.
`ResponseCacheStepAttachmentNotAllowedReq`	이 오류는 동일한 ResponseCache 정책이 API 프록시의 흐름 내에서 여러 요청 경로에 연결된 경우 발생합니다.
`ResponseCacheStepAttachmentNotAllowedResp`	이 오류는 동일한 ResponseCache 정책이 API 프록시의 흐름 내에서 여러 응답 경로에 연결된 경우 발생합니다.
`InvalidMessagePatternForErrorCode`	이 오류는 ResponseCache 정책에서 `<SkipCacheLookup>` 또는 `<SkipCachePopulation>` 요소에 잘못된 조건이 포함된 경우에 발생합니다.
`CacheNotFound`	이 오류는 오류 메시지에 언급된 특정 캐시가 특정 메시지 프로세서 구성요소에 생성되지 않은 경우에 발생합니다.

오류 변수

해당 없음

오류 응답 예시

N/A

OAuthV2 정책

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause	Thrown by operations
`steps.oauth.v2.access_token_expired`	401	The access token is expired.	VerifyAccessToken InvalidateToken
`steps.oauth.v2.access_token_not_approved`	401	The access token was revoked.	VerifyAccessToken
`steps.oauth.v2.apiresource_doesnot_exist`	401	The requested resource does not exist any of the API products associated with the access token.	VerifyAccessToken
`steps.oauth.v2.FailedToResolveAccessToken`	500	The policy expected to find an access token in a variable specified in the `<AccessToken>` element, but the variable could not be resolved.	GenerateAccessToken
`steps.oauth.v2.FailedToResolveAuthorizationCode`	500	The policy expected to find an authorization code in a variable specified in the `<Code>` element, but the variable could not be resolved.	GenerateAuthorizationCode
`steps.oauth.v2.FailedToResolveClientId`	500	The policy expected to find the Client ID in a variable specified in the `<ClientId>` element, but the variable could not be resolved.	GenerateAccessToken GenerateAuthorizationCode GenerateAccessTokenImplicitGrant RefreshAccessToken
`steps.oauth.v2.FailedToResolveRefreshToken`	500	The policy expected to find a refresh token in a variable specified in the `<RefreshToken>` element, but the variable could not be resolved.	RefreshAccessToken
`steps.oauth.v2.FailedToResolveToken`	500	The policy expected to find a token in a variable specified in the `<Tokens>` element, but the variable could not be resolved.	ValidateToken InvalidateToken
`steps.oauth.v2.InsufficientScope`	403	The access token presented in the request has a scope that does not match the scope specified in the verify access token policy. To learn about scope, see Working with OAuth2 scopes.	VerifyAccessToken
`steps.oauth.v2.invalid_access_token`	401	The access token sent from the client is invalid.	VerifyAccessToken
`steps.oauth.v2.invalid_client`	401	This error name is returned when the `<GenerateResponse>` property of the policy is set to true and the client ID sent in the request is invalid. Check to be sure you are using the correct client key and secret values for the Developer App associated with your proxy. Typically, these values are sent as a Base64 encoded Basic Authorization header. Note: It is recommended that you change existing fault rule conditions to catch both the `invalid_client` and `InvalidClientIdentifier` names. See the 16.09.21 Release Notes for more information and an example.	GenerateAccessToken RefreshAccessToken
`steps.oauth.v2.InvalidRequest`	400	This error name is used for multiple different kinds of errors, typically for missing or incorrect parameters sent in the request. If `<GenerateResponse>` is set to `false`, use fault variables (described below) to retrieve details about the error, such as the fault name and cause.	GenerateAccessToken GenerateAuthorizationCode GenerateAccessTokenImplicitGrant RefreshAccessToken
`steps.oauth.v2.InvalidAccessToken`	401	The authorization header does not have the word "Bearer", which is required. For example: `Authorization: Bearer your_access_token`	VerifyAccessToken
`steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound`	401	The API proxy is not in the Product associated with the access token. Tips: Be sure that the product associated with the access token is configured correctly. For example, if you use wildcards in resource paths, be sure the wildcards are being used correctly. See Create API products for details. See also this Apigee Community post for more guidance on causes for this error.	VerifyAccessToken
`steps.oauth.v2.InvalidClientIdentifier`	500	This error name is returned when the `<GenerateResponse>` property of the policy is set to false and the client ID sent in the request is invalid. Check to be sure you are using the correct client key and secret values for the Developer App associated with your proxy. Typically, these values are sent as a Base64 encoded Basic Authorization header. Note: In this situation, this error used to be called `invalid_client`. It is recommended that you change existing fault rule conditions to catch both the `invalid_client` and `InvalidClientIdentifier` names. See the 16.09.21 Release Notes for more information and an example.	GenerateAccessToken RefreshAccessToken
`steps.oauth.v2.InvalidParameter`	500	The policy must specify either an access token or an authorization code, but not both.	GenerateAuthorizationCode GenerateAccessTokenImplicitGrant
`steps.oauth.v2.InvalidTokenType`	500	The `<Tokens>/<Token>` element requires you to specify the token type (for example, `refreshtoken`). If the client passes the wrong type, this error is thrown.	ValidateToken InvalidateToken
`steps.oauth.v2.MissingParameter`	500	The response type is `token`, but no grant types are specified.	GenerateAuthorizationCode GenerateAccessTokenImplicitGrant
`steps.oauth.v2.UnSupportedGrantType`	500	The client specified a grant type that is unsupported by the policy (not listed in the <SupportedGrantTypes> element). Note: There is currently a bug where unsupported grant type errors are not thrown correctly. If an unsupported grant type error occurs, the proxy does not enter the Error Flow, as expected.	GenerateAccessToken GenerateAuthorizationCode GenerateAccessTokenImplicitGrant RefreshAccessToken

Deployment errors

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

Error name	Cause
`InvalidValueForExpiresIn`	For the `<ExpiresIn>` element, valid values are positive integers and `-1`.
`InvalidValueForRefreshTokenExpiresIn`	For the `<RefreshTokenExpiresIn>` element, valid values are positive integers and `-1`.
`InvalidGrantType`	An invalid grant type is specified in the `<SupportedGrantTypes>` element. See the policy reference for a list of valid types.
`ExpiresInNotApplicableForOperation`	Be sure that the operations specified in the <Operations> element support expiration. For example, the VerifyToken operation does not.
`RefreshTokenExpiresInNotApplicableForOperation`	Be sure that the operations specified in the <Operations> element support refresh token expiration. For example, the VerifyToken operation does not.
`GrantTypesNotApplicableForOperation`	Be sure that the grant types specified in <SupportedGrantTypes> are supported for the specified operation.
`OperationRequired`	You must specify an operation in this policy using the `<Operation>` element. Note: If the `<Operation>` element is missing, the UI throws a schema validation error.
`InvalidOperation`	You must specify a valid operation in this policy using the `<Operation>` element. Note: If the `<Operation>` element is invalid, the UI throws a schema validation error.
`TokenValueRequired`	You must specify a token `<Token>` value in the `<Tokens>` element.

Fault variables

These variables are set when this policy triggers an error at runtime.

Note: You an use these variables to create Fault Rule conditions. These variables are populated when an error occurs if <GenerateResponse> is set to false. If <GenerateResponse> is true, the policy returns a response to the client immediately if an error occurs -- the error flow is skipped and these variables are not populated. 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 = "InvalidRequest"`
`oauthV2.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`oauthV2.GenerateAccesstoken.failed = true`
`oauthV2.policy_name.fault.name`	`policy_name` is the user-specified name of the policy that threw the fault.	`oauthV2.GenerateAccesstoken.fault.name = InvalidRequest` Note: For the VerifyAccessToken operation, the fault name includes this suffix: `keymanagement.service` For example: `keymanagement.service.invalid_access_token`
`oauthV2.policy_name.fault.cause`	`policy_name` is the user-specified name of the policy that threw the fault.	`oauthV2.GenerateAccesstoken.cause = Required param : grant_type`

Example error response

These responses are sent back to the client if the <GenerateResponse> element is true.

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.

If <GenerateResponse> is true, the policy returns errors in this format for operations that generate tokens and codes. For a complete list, see see OAuth HTTP error response reference.

{"ErrorCode" : "invalid_client", "Error" :"ClientId is Invalid"}

If <GenerateResponse> is true, the policy returns errors in this format for verify and validate operations. For a complete list, see see OAuth HTTP error response reference.

{  
   {  
      "fault":{  
         "faultstring":"Invalid Access Token",
         "detail":{  
            "errorcode":"keymanagement.service.invalid_access_token"
         }
      }
   }

Example fault rule

<FaultRule name=OAuthV2 Faults">
    <Step>
        <Name>AM-InvalidClientResponse</Name>
        <Condition>(fault.name = "invalid_client") OR (fault.name = "InvalidClientIdentifier")</Condition>
    </Step>
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
        <Condition>(fault.name = "invalid_access_token")</Condition>
    </Step>
    <Condition>(oauthV2.failed = true) </Condition>
</FaultRule>

GetOAuthV2Info 정책

Runtime errors

These errors can occur when the policy executes. The error names shown below are the strings that are assigned to the fault.name variable when an error occurs. See the Fault variables section below for more details.

Fault code	HTTP status	Cause
`steps.oauth.v2.access_token_expired`	500	The access token sent to the policy is expired.
`steps.oauth.v2.authorization_code_expired`	500	The authorization code sent to the policy is expired.
`steps.oauth.v2.invalid_access_token`	500	The access token sent to the policy is invalid.
`steps.oauth.v2.invalid_client-invalid_client_id`	500	The client ID sent to the policy is invalid.
`steps.oauth.v2.invalid_refresh_token`	500	The refresh token sent to the policy is invalid.
`steps.oauth.v2.invalid_request-authorization_code_invalid`	500	The authorization code sent to the policy is invalid.
`steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound`	401	Please see this Apigee Community post for information about troubleshooting this error.
`steps.oauth.v2.refresh_token_expired`	500	The refresh token sent to the policy is expired.

Deployment errors

Refer to the message reported in the UI for information about deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

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 "IPDeniedAccess"`
`oauthV2.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`oauthV2.GetTokenInfo.failed = true`
`oauthV2.policy_name.fault.name`	`policy_name` is the user-specified name of the policy that threw the fault.	`oauthV2.GetToKenInfo.fault.name = invalid_client-invalid_client_id`
`oauthV2.policy_name.fault.cause`	`policy_name` is the user-specified name of the policy that threw the fault.	`oauthV2.GetTokenInfo.cause = ClientID is Invalid`

Example error response

{  
   "fault":{  
      "faultstring":"ClientId is Invalid",
      "detail":{  
         "errorcode":"keymanagement.service.invalid_client-invalid_client_id"
      }
   }
}

Example fault rule

<FaultRule name="OAuthV2 Faults">
    <Step>
        <Name>AM-InvalidClientIdResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_client-invalid_client_id")</Condition>
</FaultRule>

SetOAuthV2Info 정책

이 섹션에서는 이 정책이 오류를 트리거할 때 반환되는 오류 코드 및 오류 메시지와 Edge에서 설정한 오류 변수를 설명합니다. 오류를 처리하기 위해 오류 규칙을 개발 중인 경우, 이 정보는 중요합니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항 및 오류 처리를 참조하세요.

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	원인
`steps.oauth.v2.access_token_expired`	500	정책에 전송된 액세스 토큰이 만료되었습니다.
`steps.oauth.v2.invalid_access_token`	500	정책에 전송된 액세스 토큰이 잘못되었습니다.
`steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound`	401	이 오류 문제 해결에 대한 자세한 내용은 Apigee 커뮤니티 게시물을 참조하세요.

배포 오류

배포 오류에 대한 자세한 내용은 UI에 보고된 메시지를 참조하세요.

오류 변수

이러한 변수는 이 정책이 런타임 시 오류를 트리거할 때 설정됩니다.

변수	항목 설명	예시
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name = "invalid_access_token"`
`oauthV2.policy_name.failed`	`policy_name`은 오류를 발생시킨 정책의 사용자 지정 이름입니다.	`oauthV2.SetTokenInfo.failed = true`
`oauthV2.policy_name.fault.name`	`policy_name`은 오류를 발생시킨 정책의 사용자 지정 이름입니다.	`oauthV2.SetTokenInfo.fault.name = invalid_access_token`
`oauthv2.policy_name.fault.cause`	`policy_name`은 오류를 발생시킨 정책의 사용자 지정 이름입니다.	`oauthV2.SetTokenInfo.cause = Invalid Access Token`

오류 응답 예시

{
  "fault": {
    "faultstring": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

오류 규칙 예시

<FaultRule name=SetOAuthV2Info Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
        <Condition>(fault.name = "invalid_access_token")</Condition>
    </Step>
    <Condition>(oauthV2.failed = true) </Condition>
</FaultRule>

DeleteOAuthV2Info 정책

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`steps.oauth.v2.invalid_access_token`	401	The access token sent to the policy is invalid.
`steps.oauth.v2.invalid_request-authorization_code_invalid`	401	The authorization code sent to the policy is invalid.
`steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound`	401	Please see this Apigee Community post for information about troubleshooting this error.

Deployment errors

Refer to the message reported in the UI for information about deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

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 = "invalid_access_token"`
`oauthV2.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`oauthV2.DeleteTokenInfo.failed = true`
`oauthV2.policy_name.fault.name`	`policy_name` is the user-specified name of the policy that threw the fault.	`oauthV2.DeleteTokenInfo.fault.name = invalid_access_token`
`oauthv2.policy_name.fault.cause`	`policy_name` is the user-specified name of the policy that threw the fault.	`oauthV2.DeleteTokenInfo.cause = Invalid Access Token`

Example error response

{
  "fault": {
    "faultstring": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

Example fault rule

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="DeleteOAuthV2Info_Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_access_token")</Condition>
</FaultRule>

OAuthv1.0a 정책

The OAuthV1 Policy type defines the following error codes.

For OAuth-related HTTP error codes, see OAuth HTTP error response reference.

Error Code	Message

`AppKeyNotResolved`	`Could not resolve the app key with variable {0}`
`ConsumerKeyNotResolved`	`Could not resolve the consumer key with variable {0}`
`RequestTokenNotResolved`	`Could not resolve the request token with the variable {0}`
`AccessTokenNotResolved`	`Could not resolve the access token with the variable {0}`
`ResponseGenerationError`	`Error while generating response : {0}`
`UnableToDetermineOperation`	`Unable to determine an operation for stepDefinition {0}`
`UnableToResolveOAuthConfig`	`Unable to resolve the OAuth configuration for {0}`
`AtLeastOneParamRequired`	`At least one of AccessToken, RequestToken or ConsumerKey must be specified in stepDefinition {0}`
`SpecifyValueOrRefReqToken`	`Specify Request Token as value or ref in stepDefinition {0}`
`SpecifyValueOrRefAccToken`	`Specify Access Token as value or ref in stepDefinition {0}`
`SpecifyValueOrRefConKey`	`Specify Consumer Key as value or ref in stepDefinition {0}`
`SpecifyValueOrRefAppKey`	`Specify App Key as value or ref in stepDefinition {0}`
`ExpiresInNotApplicableForOperation`	`ExpiresIn element is not valid for operation {0}`
`InvalidValueForExpiresIn`	`Invalid value for ExpiresIn element for operation {0}`
`FailedToFetchApiProduct`	`Failed to fetch api product for key {0}`
`InvalidTokenType`	`Valid token types : {0}, Invalid toke type {1} in stepDefinition {2}`
`TokenValueRequired`	`Token value is required in stepDefinition {0}`
`FailedToResolveRealm`	`Failed to resolve realm {0}`

GetOAuthV1Info 정책

No error codes are specified for the Get OAuth v1.0a Info policy.

DeleteOAuthV1Info 정책

On success, the policy returns a 200 status.

On failure, the policy returns 404 and output similar to the following (depending on whether you are deleting an access token, request token, or verifier.):

HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 144
Connection: keep-alive

{"fault":{"faultstring":"Invalid Access Token","detail":{"errorcode":"keymanagement.service.invalid_request-access_token_invalid"}}}

PythonScript 정책

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>

할당량 정책

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	원인	해결
`policies.ratelimit.FailedToResolveQuotaIntervalReference`	500	`<Interval>` 요소가 할당량 정책 내에 정의되지 않은 경우 발생합니다. 이 요소는 필수이며 할당량에 적용되는 시간 간격을 지정하는 데 사용됩니다. 시간 간격 `<TimeUnit>` 요소로 정의된 대로 분, 시간, 일, 주, 월이 될 수 있습니다.
`policies.ratelimit.FailedToResolveQuotaIntervalTimeUnitReference`	500	`<TimeUnit>` 요소가 할당량 정책 내에 정의되지 않은 경우 발생합니다. 이 요소는 필수이며 할당량에 적용되는 시간 단위를 지정하는 데 사용됩니다. 시간 간격은 분, 시간, 일, 주 또는 월 단위일 수 있습니다.
`policies.ratelimit.InvalidMessageWeight`	500	흐름 변수를 통해 지정된 `<MessageWeight>` 요소의 값이 잘못된 경우에(정수가 아닌 값) 발생합니다.
`policies.ratelimit.QuotaViolation`	500	할당량 한도를 초과했습니다.	해당 없음

배포 오류

오류 이름	원인	해결
`InvalidQuotaInterval`	`<Interval>` 요소에 지정된 할당량 간격이 정수가 아닌 경우 API 프록시 배포가 실패합니다. 예를 들어 지정된 할당량 간격이 `<Interval>` 요소에서 0.1이면 API 프록시 배포가 실패합니다.
`InvalidQuotaTimeUnit`	`<TimeUnit>` 요소에 지정된 시간 단위가 지원되지 않는 경우 API 프록시 배포가 실패합니다. 지원되는 시간 단위는 `minute`, `hour`, `day`, `week`, `month`입니다.
`InvalidQuotaType`	`<Quota>` 요소의 `type` 속성에 의해 지정된 할당량 유형이 잘못된 경우 API 프록시 배포가 실패합니다. 지원되는 할당량 유형은 `default`, `calendar`, `flexi`, `rollingwindow`입니다.
`InvalidStartTime`	`<StartTime>` 요소에 지정된 시간 형식이 잘못된 경우 API 프록시 배포가 실패합니다. 유효한 형식은 `yyyy-MM-dd HH:mm:ss`이며 ISO 8601 날짜 및 시간 형식입니다. 예를 들어 `<StartTime>` 요소에 지정된 시간이 `7-16-2017 12:00:00`인 경우 API 프록시 배포가 실패합니다.
`StartTimeNotSupported`	할당량 유형이 `calendar` 유형이 아닌 `<StartTime>` 요소가 지정된 경우 API 프록시 배포가 실패합니다. `<StartTime>` 요소는 `calendar` 할당량 유형에만 지원됩니다. 예를 들어 `<Quota>` 요소에서 `type` 속성이 `flexi` 또는 `rolling window`로 설정된 경우 API 프록시 배포가 실패합니다.
`InvalidTimeUnitForDistributedQuota`	`<Distributed>` 요소가 `true`로 설정되고 `<TimeUnit>` 요소가 `second`로 설정된 경우 API 프록시 배포가 실패합니다. timeunit `second`는 분산 할당량에 유효하지 않습니다.
`InvalidSynchronizeIntervalForAsyncConfiguration`	Quota 정책의 `<AsynchronousConfiguration>` 요소 내에 있는 `<SyncIntervalInSeconds>` 요소에 지정된 값이 0 미만이면 API 프록시 배포가 실패합니다.
`InvalidAsynchronizeConfigurationForSynchronousQuota`	`<AsynchronousConfiguration>` 요소를 사용하여 비동기 구성이 정의된 Quota 정책에서 `<AsynchronousConfiguration>` 요소의 값이 `true`로 설정된 경우 API 프록시의 배포가 실패합니다.

오류 변수

이러한 변수는 이 정책으로 오류가 트리거될 때 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	위치	예
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name Matches "QuotaViolation"`
`ratelimit.policy_name.failed`	`policy_name`은 오류를 발생시킨 정책의 사용자 지정 이름입니다.	`ratelimit.QT-QuotaPolicy.failed = true`

오류 응답 예시

참고: 오류 처리에서 권장사항은 오류 응답의 errorcode 부분을 트래핑하는 것입니다. 변경될 수 있으므로 faultstring의 텍스트에 의존하지 마세요.

{  
   "fault":{  
      "detail":{  
         "errorcode":"policies.ratelimit.QuotaViolation"
      },
      "faultstring":"Rate limit quota violation. Quota limit  exceeded. Identifier : _default"
   }
}

오류 규칙 예시

<FaultRules>
    <FaultRule name="Quota Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "QuotaViolation") </Condition>
        </Step>
        <Condition>ratelimit.Quota-1.failed=true</Condition>
    </FaultRule>
</FaultRules>

ResetQuota 정책

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	원인
`policies.resetquota.InvalidRLPolicy`	500	할당량 재설정 정책의 `<Quota>` 요소에 지정된 할당량 정책은 API 프록시에 정의되어 있지 않으므로 흐름 중에 사용할 수 없습니다. `<Quota>` 요소는 필수이며 할당량 재설정 정책을 통해 카운터를 업데이트해야 하는 대상 할당량 정책을 식별합니다.
`policies.resetquota.FailedToResolveAllowCountRef`	N/A	정책의 `<Allow>` 요소에서 허용 개수를 포함한 변수 참조를 값으로 확인할 수 없습니다. 이 요소는 필수이며 줄일 할당량 카운터의 양을 지정합니다.
`policies.resetquota.FailedToResolveRLPolicy`	500	`<Quota>` 요소의 `ref` 속성에서 참조한 변수는 확인할 수 없습니다.

배포 오류

이 오류는 이 정책이 포함된 프록시를 배포할 때 발생할 수 있습니다.

오류 이름	원인	수정
`InvalidCount`	할당량 재설정 정책의 `<Allow>` 요소에 지정된 개수 값이 정수가 아니면 API 프록시 배포가 실패합니다.

RaiseFault 정책

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	원인
`steps.raisefault.RaiseFault`	500	오류 문자열을 참조하세요.

배포 오류

없음

오류 변수

이러한 변수는 런타임 오류가 발생하면 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	위치	예
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name = "RaiseFault"`
`raisefault.policy_name.failed`	`policy_name`은 정책을 구성하는 사용자 지정 이름입니다. 결함을 일으켰습니다.	`raisefault.RF-ThrowError.failed = true`

오류 응답 예시

참고: 오류 처리에서 권장사항은 오류 응답의 errorcode 부분을 트래핑하는 것입니다. 변경될 수 있으므로 faultstring의 텍스트에 의존하지 마세요.

{
   "fault":{
      "detail":{
         "errorcode":"steps.raisefault.RaiseFault"
      },
      "faultstring":"Raising fault. Fault name: [name]"
   }
}

RegularExpressionProtection 정책

이 섹션에서는 정책이 오류를 트리거할 때 Edge에서 설정한 오류 코드, 오류 메시지, 오류 변수를 설명합니다. 오류를 처리하기 위해 오류 규칙을 개발 중인 경우, 이 정보는 중요합니다. 오류를 캡처하고 자체 커스텀 오류를 발생시키려면 정책 루트 요소에서 continueOnError="true" 속성을 설정합니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항 및 오류 처리를 참조하세요.

에지 정책에서 반환되는 오류는 오류 코드 참조에 설명된 일관된 형식을 따릅니다.

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	메시지

ExecutionFailed	RegularExpressionProtection StepDefinition {0} 실행할 수 없음. 이유: {1}
InstantiationFailed	RegularExpressionProtection StepDefinition {0} 인스턴스화할 수 없음.
NonMessageVariable	{0} 변수가 메시지로 확인되지 않습니다.
SourceMessageNotAvailable	{0} 메시지는 RegularExpressionProtection StepDefinition {1}에서 사용할 수 없음
ThreatDetected	{0}에서 정규 표현식 위협이 감지됨: 정규식: {1} 입력: {2}
VariableResolutionFailed	{0} 변수를 확인할 수 없음

배포 오류

오류 코드	메시지	해결

CannotBeConvertedToNodeset	RegularExpressionProtection {0}: xpath {1}의 결과를 노드 집합으로 변환할 수 없습니다. 컨텍스트 {2}
DuplicatePrefix	RegularExpressionProtection {0}: 중복된 접두사 {1}
EmptyJSONPathExpression	RegularExpressionProtection {0}: 빈 JSONPath 표현식
EmptyXPathExpression	RegularExpressionProtection {0}: 빈 XPath 표현식
InvalidRegularExpression	RegularExpressionProtection {0}: 잘못된 정규 표현식 {1}, 컨텍스트 {2}
JSONPathCompilationFailed	RegularExpressionProtection {0}: jsonpath {1} 컴파일할 수 없음. 컨텍스트 {2}
NONEmptyPrefixMappedToEmptyURI	RegularExpressionProtection {0}: 빈 URI에 비어 있지 않은 프리픽스 {1} 매핑할 수 없음
NoPatternsToEnforce	RegularExpressionProtection {0}: {1}에 적용할 패턴이 없습니다.
NothingToEnforce	RegularExpressionProtection {0}: URIPath, QueryParam, Header, FormParam, XML 로드, JSON페이 중 하나 이상이 필수임
XPathCompilationFailed	RegularExpressionProtection {0}: xpath {1} 컴파일할 수 없음. 컨텍스트 {2}

오류 변수

이러한 변수는 이 정책으로 오류가 트리거될 때 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	각 항목의 의미는 다음과 같습니다.	예
`fault.name="fault_name"`	`fault_name`은 위 표에 나열된 오류의 이름입니다.	`fault.name Matches "ThreatDetected"`
`regularexpressionprotection.policy_name.failed`	`policy_name`은 오류를 발생시킨 정책의 사용자 지정 이름입니다.	`regularexpressionprotection.Regular-Expressions-Protection-1.failed = true`

SOAPMessageValidation 정책

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드 HTTP 상태 원인 수정

steps.messagevalidation.SourceMessageNotAvailable

500

이 오류는 정책의 <Source> 요소에 지정된 변수가 다음 중 하나인 경우에 발생합니다.

범위를 벗어난 경우(정책이 실행 중인 특정 흐름에서 사용할 수 없음)
확인할 수 없는 경우(정의되지 않음)

steps.messagevalidation.NonMessageVariable

500

이 오류는 SOAPMessageValidation 정책의 <Source> 요소가 메시지 유형이 아닌 변수로 설정된 경우 발생합니다.

메시지 유형 변수는 전체 HTTP 요청 및 응답을 나타냅니다. 기본 제공되는 Edge 흐름 변수 request, response, message는 메시지 유형입니다. message 변수에 대한 자세한 내용은 변수 참조를 확인하세요.

steps.messagevalidation.Failed 500 이 오류는 SOAPMessageValidation 정책이 XSD 스키마 또는 WSDL 정의에 대해 입력 메시지 페이로드의 유효성을 검사하는 데 실패하는 경우 발생합니다. 페이로드 메시지에 잘못된 JSON 또는 XML이 있는 경우에도 이 오류가 발생합니다.

배포 오류

이 오류는 이 정책이 포함된 프록시를 배포할 때 발생할 수 있습니다.

오류 이름	원인	수정
`InvalidResourceType`	SOAPMessageValidation 정책의 `<ResourceURL>` 요소는 정책에서 지원하지 않는 리소스 유형으로 설정됩니다.
`ResourceCompileFailed`	SOAPMessageValidation 정책의 `<ResourceURL>` 요소에서 참조하는 리소스 스크립트에 컴파일하지 못하도록 하는 오류가 포함되어 있습니다.
`RootElementNameUnspecified`	SOAPMessageValidation 정책의 `<Element>` 요소에 루트 요소의 이름이 포함되지 않습니다.
`InvalidRootElementName`	SOAPMessageValidation 정책의 `<Element>` 요소에는 유효한 요소 이름을 지정할 때 XML 규칙을 준수하지 않는 루트 요소 이름이 포함되어 있습니다.

SAMLAssertion 정책

Deployment errors

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

Error name	Cause	Fix
`SourceNotConfigured`	One or more of the following elements of the Validate SAML Assertion policy is not defined or empty: `<Source>`, `<XPath>`, `<Namespaces>`, `<Namespace>`.
`TrustStoreNotConfigured`	If the `<TrustStore>` element is empty or not specified in the ValidateSAMLAssertion policy, then the deployment of the API proxy fails. A valid Trust Store is required.
`NullKeyStoreAlias`	If the child element `<Alias>` is empty or not specified in the `<Keystore>` element of Generate SAML Assertion policy, then the deployment of the API proxy fails. A valid Keystore alias is required.
`NullKeyStore`	If the child element `<Name>` is empty or not specified in the `<Keystore>` element of GenerateSAMLAssertion policy, then the deployment of the API proxy fails. A valid Keystore name is required.
`NullIssuer`	If the `<Issuer>` element is empty or not specified in the Generate SAML Assertion policy, then the deployment of the API proxy fails. A valid `<Issuer>` value is required.

Fault variables

These variables are set when a runtime error occurs. 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. The fault name is the last part of the fault code.	`fault.name = "InvalidMediaTpe"`
`GenerateSAMLAssertion.failed`	For a validate SAML assertion policy configuration, the error prefix is `ValidateSAMLAssertion`.	`GenerateSAMLAssertion.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": "GenerateSAMLAssertion[GenSAMLAssert]: Invalid media type",
    "detail": {
      "errorcode": "steps.saml.generate.InvalidMediaTpe"
    }
  }
}

Example fault rule

<FaultRules>
    <FaultRule name="invalid_saml_rule">
        <Step>
            <Name>invalid-saml</Name>
        </Step>
        <Condition>(GenerateSAMLAssertion.failed = "true")</Condition>
    </FaultRule>
</FaultRules>

ServiceCallout 정책

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드 HTTP 상태 원인 해결

steps.servicecallout.ExecutionFailed

500

이 오류는 다음과 같은 때에 발생할 수 있습니다.

정책이 잘못되었거나 유효하지 않은 입력을 처리하도록 요청받았을 때
백엔드 대상 서비스가 오류 상태(기본적으로 4xx 또는 5xx)를 반환할 때

steps.servicecallout.RequestVariableNotMessageType 500 정책에 지정된 요청 변수가 메시지 유형이 아닙니다. 예를 들어 문자열이거나 기타 메시지 외 유형인 경우 이 오류가 표시됩니다.

steps.servicecallout.RequestVariableNotRequestMessageType 500 정책에 지정된 요청 변수가 요청 메시지 유형이 아닙니다. 예를 들어 응답 유형인 경우 이 오류가 표시됩니다.

배포 오류

이 오류는 이 정책이 포함된 프록시를 배포할 때 발생할 수 있습니다.

오류 이름	원인	수정
`URLMissing`	`<HTTPTargetConnection>` 내의 `<URL>` 요소가 없거나 비어 있습니다.
`ConnectionInfoMissing`	이 오류는 정책에 `<HTTPTargetConnection>` 또는 `<LocalTargetConnection>` 요소가 없는 경우 발생합니다.
`InvalidTimeoutValue`	이 오류는 `<Timeout>` 값이 음수이거나 0이면 발생합니다.

오류 변수

이러한 변수는 런타임 오류가 발생하면 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	위치	예
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name = "RequestVariableNotMessageType"`
`servicecallout.policy_name.failed`	`policy_name`은 오류를 발생시킨 정책의 사용자 지정 이름입니다.	`servicecallout.SC-GetUserData.failed = true`

오류 응답 예시

참고: 오류 처리에서 권장사항은 오류 응답의 errorcode 부분을 트래핑하는 것입니다. 변경될 수 있으므로 faultstring의 텍스트에 의존하지 마세요.

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.servicecallout.RequestVariableNotMessageType"
      },
      "faultstring":"ServiceCallout[ServiceCalloutGetMockResponse]: 
            request variable data_str value is not of type Message"
   }
}

오류 규칙 예시

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="RequestVariableNotMessageType">
    <Step>
        <Name>AM-RequestVariableNotMessageType</Name>
    </Step>
    <Condition>(fault.name = "RequestVariableNotMessageType")</Condition>
</FaultRule>

SpikeArrest 정책

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	원인
`policies.ratelimit.FailedToResolveSpikeArrestRate`	`500`	이 오류는 `<Rate>` 요소 내에 속도 설정이 포함된 변수의 참조를 급증 저지 정책에서의 값으로 확인할 수 없는 경우에 발생합니다. 이 요소는 필수이며 `intpm` 또는 `intps` 형식으로 급증 저지 속도를 지정하는 데 사용됩니다.
`policies.ratelimit.InvalidMessageWeight`	`500`	이 오류는 흐름 변수를 통해 `<MessageWeight>` 요소에 지정된 값이 잘못된 경우에(정수가 아닌 값) 발생합니다.
`policies.ratelimit.SpikeArrestViolation`	`429`	비율 제한을 초과했습니다. <ph type="x-smartling-placeholder"> </ph> 참고: 프라이빗 클라우드의 경우 반환되는 기본 HTTP 상태 코드는 `500`입니다. `429`로 반환된 상태 코드를 변경하려면 API를 사용하여 이 속성을 설정하세요. 결함 규칙 예에 설명된 호출

배포 오류

이 오류는 이 정책이 포함된 프록시를 배포할 때 발생할 수 있습니다.

오류 이름	원인	수정
`InvalidAllowedRate`	급증 저지 정책의 `<Rate>` 요소에 지정된 급증 저지 비율이 정수가 아니거나 속도에 `ps` 또는 `pm`이 서픽스로 없는 경우 API 프록시 배포가 실패합니다.

오류 변수

이러한 변수는 런타임 오류가 발생하면 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	위치	예시
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name Matches "SpikeArrestViolation"`
`ratelimit.policy_name.failed`	`policy_name`은 오류를 발생시킨 정책의 사용자 지정 이름입니다.	`ratelimit.SA-SpikeArrestPolicy.failed = true`

오류 응답 예시

다음은 오류 응답의 예시입니다.

참고: 오류 처리에서 권장사항은 오류 응답의 errorcode 부분을 트래핑하는 것입니다. 변경될 수 있으므로 faultstring의 텍스트에 의존하지 마세요.

{  
   "fault":{  
      "detail":{  
         "errorcode":"policies.ratelimit.SpikeArrestViolation"
      },
      "faultstring":"Spike arrest violation. Allowed rate : 10ps"
   }
}

오류 규칙 예시

다음은 SpikeArrestViolation 오류를 처리하기 위한 오류 규칙의 예시입니다.

<FaultRules>
    <FaultRule name="Spike Arrest Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "SpikeArrestViolation") </Condition>
        </Step>
        <Condition>ratelimit.Spike-Arrest-1.failed=true</Condition>
    </FaultRule>
</FaultRules>

StatisticsCollector 정책

런타임 오류

없음

배포 오류

오류 이름	원인	수정
`UnsupportedDatatype`	Statistics Collector 정책의 `<Statistic>` 요소에 ref 속성으로 지정된 변수 유형이 지원되지 않으면 API 프록시 배포가 실패합니다. 지원되는 데이터 유형은 `string`, `integer`, `float`, `long`, `double`, `boolean`입니다.
`InvalidName`	Statistics Collector 정책의 `<Statistic>` 요소 내에서 정의된 지정된 변수에 대해 수집된 데이터를 참조하는 이름이 시스템 정의 변수와 충돌하는 경우 API 프록시 배포가 실패합니다. 알려진 시스템 정의 변수 중 일부는 `organization` 및 `environment`입니다.
`DatatypeMissing`	Statistics Collector 정책의 `<Statistic>` 요소 내 `ref` 속성으로 지정된 변수 유형이 없으면 API 프록시 배포가 실패합니다.

오류 변수

없음

VerifyAPIKey 정책

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	원인
`keymanagement.service.CompanyStatusNotActive`	401	사용 중인 API 키가 있는 개발자 앱과 연결된 회사가 비활성 상태입니다. 회사의 상태가 비활성으로 설정되면 해당 회사와 연결된 개발자 또는 앱에 액세스할 수 없습니다. 조직 관리자는 관리 API를 사용하여 회사 상태를 변경할 수 있습니다. 회사의 상태 설정을 참조하세요.
`keymanagement.service.DeveloperStatusNotActive`	401	사용 중인 API 키가 있는 개발자 앱을 만든 개발자가 비활성 상태입니다. 앱 개발자의 상태가 비활성으로 설정되면 해당 개발자에 의해 생성된 모든 개발자 앱은 비활성화됩니다. 적절한 권한을 가진 관리자(예: 조직 관리자)는 다음과 같은 방법으로 개발자 상태를 변경할 수 있습니다. 관리 API: 개발자 상태 설정 관리 UI: 앱 개발자 등록에서 개발자 비활성화 및 활성화에 대한 안내를 참조하세요.
`keymanagement.service.invalid_client-app_not_approved`	401	API 키와 연결된 개발자 앱이 취소되었습니다. 취소된 앱은 API 제품에 액세스할 수 없으며 Apigee Edge에서 관리하는 API를 호출할 수 없습니다. 조직 관리자는 관리 API를 사용하여 개발자 앱의 상태를 변경할 수 있습니다. 개발자 앱 승인 또는 취소를 참조하세요.
`oauth.v2.FailedToResolveAPIKey`	401	정책은 정책의 <APIKey> 요소에 지정된 변수에서 API 키를 찾습니다.이 오류는 예상 변수가 존재하지 않는 경우 발생합니다(해결할 수 없음).
`oauth.v2.InvalidApiKey`	401	Edge에서 잘못된 API 키를 수신했습니다. Edge가 데이터베이스에서 키를 조회할 때, 이는 요청에서 전송된 것과 정확하게 일치해야 합니다. API가 이전에 작동했다면 키가 다시 생성되지 않았는지 확인합니다. 키가 다시 생성된 경우 이전 키를 사용하려고 하면 이 오류가 표시됩니다. 자세한 내용은 앱 등록 및 API 키 관리를 참조하세요.
`oauth.v2.InvalidApiKeyForGivenResource`	401	Edge에서 API 키를 수신했으며 유효한 상태이지만 제품을 통해 API 프록시와 연결된 개발자 앱의 승인된 키와 일치하지 않습니다.

참고: 현재 Edge는 ApiKeyNotApproved 오류를 정확하게 보고하지 않습니다. 대신 키가 승인되지 않은 경우(상태가 '취소됨' 또는 '대기중'으로 설정됨) 대신 FailedToResolveAPIKey 오류가 표시됩니다. 자세한 내용과 가능한 해결 방법은 Apigee 커뮤니티에 있는 이 게시물을 참조하세요.

배포 오류

이 오류는 이 정책이 포함된 프록시를 배포할 때 발생할 수 있습니다.

오류 이름	원인
`SpecifyValueOrRefApiKey`	`<APIKey>` 요소에 지정된 값 또는 키가 없습니다.

오류 변수

이러한 변수는 런타임 오류가 발생하면 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	항목 설명	예시
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name Matches "FailedToResolveAPIKey"`
`oauthV2.policy_name.failed`	`policy_name`은 오류를 발생시킨 정책의 사용자 지정 이름입니다.	`oauthV2.VK-VerifyAPIKey.failed = true`

오류 응답 예시

참고: 오류 처리에서 권장사항은 오류 응답의 errorcode 부분을 트래핑하는 것입니다. 변경될 수 있으므로 faultstring의 텍스트에 의존하지 마세요.

{
   "fault":{
      "faultstring":"Invalid ApiKey",
      "detail":{
         "errorcode":"oauth.v2.InvalidApiKey"
      }
   }
}

{
   "fault":{
      "detail":{
         "errorcode":"keymanagement.service.DeveloperStatusNotActive"
      },
      "faultstring":"Developer Status is not Active"
   }
}

오류 규칙 예시

<FaultRule name="FailedToResolveAPIKey">
    <Step>
        <Name>AM-FailedToResolveAPIKey</Name>
    </Step>
    <Condition>(fault.name Matches "FailedToResolveAPIKey") </Condition>
</FaultRule>

JWS 정책 인증

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	발생 상황
`steps.jws.AlgorithmInTokenNotPresentInConfiguration`	401	확인 정책에 알고리즘이 여러 개 있으면 발생합니다.
`steps.jws.AlgorithmMismatch`	401	생성 정책에 의해 헤더에 지정된 알고리즘이 확인 정책에서 예상한 알고리즘과 일치하지 않습니다. 지정된 알고리즘이 일치해야 합니다.
`steps.jws.ContentIsNotDetached`	401	`<DetachedContent>`는 JWS에 분리된 콘텐츠 페이로드가 포함되어 있지 않으면 지정됩니다.
`steps.jws.FailedToDecode`	401	정책에서 JWS를 디코딩할 수 없습니다. JWS가 손상되었을 수 있습니다.
`steps.jws.InsufficientKeyLength`	401	HS256 알고리즘의 키가 32바이트 미만인 경우
`steps.jws.InvalidClaim`	401	소유권 주장 누락, 소유권 주장 불일치, 헤더 또는 헤더 불일치 누락
`steps.jws.InvalidCurve`	401	키에서 지정한 곡선은 타원 곡선 알고리즘에 유효하지 않습니다.
`steps.jws.InvalidJsonFormat`	401	JWS 헤더에 잘못된 JSON이 있습니다.
`steps.jws.InvalidJws`	401	이 오류는 JWS 서명 확인이 실패하면 발생합니다.
`steps.jws.InvalidPayload`	401	JWS 페이로드가 잘못되었습니다.
`steps.jws.InvalidSignature`	401	`<DetachedContent>`가 생략되고 JWS에 분리된 콘텐츠 페이로드가 있습니다.
`steps.jws.KeyIdMissing`	401	인증 정책은 JWKS를 공개 키의 소스로 사용하지만 서명된 JWS의 헤더에 `kid` 속성이 포함되어 있지 않습니다.
`steps.jws.KeyParsingFailed`	401	주어진 키 정보에서 공개 키를 파싱할 수 없습니다.
`steps.jws.MissingPayload`	401	JWS 페이로드가 누락되었습니다.
`steps.jws.NoAlgorithmFoundInHeader`	401	JWS에서 알고리즘 헤더가 생략되면 발생합니다.
`steps.jws.NoMatchingPublicKey`	401	확인 정책은 JWKS를 공개 키의 소스로 사용하지만 서명된 JWS의 `kid`는 JWKS에 나열되지 않습니다.
`steps.jws.UnhandledCriticalHeader`	401	`crit` 헤더의 JWS 확인 정책에서 발견한 헤더는 `KnownHeaders`에 나열되지 않습니다.
`steps.jws.UnknownException`	401	알 수 없는 예외가 발생했습니다.
`steps.jws.WrongKeyType`	401	잘못된 유형의 키가 지정되었습니다. 예를 들어 타원 곡선 알고리즘의 RSA 키를 지정하거나 RSA 알고리즘의 곡선 키를 지정하는 경우입니다.

배포 오류

이 오류는 이 정책이 포함된 프록시를 배포할 때 발생할 수 있습니다.

오류 이름 발생 상황

InvalidAlgorithm 유효한 값은 RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512뿐입니다.

EmptyElementForKeyConfiguration

FailedToResolveVariable

InvalidConfigurationForActionAndAlgorithmFamily

InvalidConfigurationForVerify

InvalidEmptyElement

InvalidFamiliesForAlgorithm

InvalidKeyConfiguration

InvalidNameForAdditionalClaim

InvalidNameForAdditionalHeader

InvalidPublicKeyId

InvalidPublicKeyValue

InvalidSecretInConfig

InvalidTypeForAdditionalClaim

InvalidTypeForAdditionalHeader

InvalidValueForElement

InvalidValueOfArrayAttribute

InvalidVariableNameForSecret

MissingConfigurationElement

MissingElementForKeyConfiguration

MissingNameForAdditionalClaim

MissingNameForAdditionalHeader

기타 발생 가능한 배포 오류

오류 변수

이러한 변수는 런타임 오류가 발생하면 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	위치	예
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name Matches "TokenExpired"`
`JWS.failed`	모든 JWS 정책은 오류 발생 시 동일한 변수를 설정합니다.	`jws.JWS-Policy.failed = true`

오류 응답 예시

오류 처리에서 오류 응답의 errorcode 부분을 트래핑하는 것이 가장 좋습니다. 변경될 수 있으므로 faultstring의 텍스트에 의존하지 마세요.

오류 규칙 예시

<FaultRules>
    <FaultRule name="JWS Policy Errors">
        <Step>
            <Name>JavaScript-1</Name>
            <Condition>(fault.name Matches "TokenExpired")</Condition>
        </Step>
        <Condition>JWS.failed=true</Condition>
    </FaultRule>
</FaultRules>

VerifyJWT 정책

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	발생 상황
`steps.jwt.AlgorithmInTokenNotPresentInConfiguration`	401	확인 정책에 알고리즘이 여러 개 있으면 발생합니다.
`steps.jwt.AlgorithmMismatch`	401	생성 정책에 지정된 알고리즘이 확인 정책에서 예상되는 알고리즘과 일치하지 않습니다. 지정된 알고리즘이 일치해야 합니다.
`steps.jwt.FailedToDecode`	401	정책이 JWT를 디코딩할 수 없습니다. JWT가 손상되었을 수 있습니다.
`steps.jwt.GenerationFailed`	401	정책이 JWT를 생성하지 못했습니다.
`steps.jwt.InsufficientKeyLength`	401	HS256 알고리즘은 32바이트 미만, HS386 알고리즘은 48바이트 미만, HS512 알고리즘은 64바이트 미만의 키일 때 발생합니다.
`steps.jwt.InvalidClaim`	401	소유권 주장 누락, 소유권 주장 불일치, 헤더 또는 헤더 불일치 누락
`steps.jwt.InvalidCurve`	401	키에서 지정한 곡선은 타원 곡선 알고리즘에 유효하지 않습니다.
`steps.jwt.InvalidJsonFormat`	401	헤더 또는 페이로드에 잘못된 JSON이 있습니다.
`steps.jwt.InvalidToken`	401	이 오류는 JWT 서명 확인이 실패하면 발생합니다.
`steps.jwt.JwtAudienceMismatch`	401	토큰 확인 시 잠재 고객 소유권 주장이 실패했습니다.
`steps.jwt.JwtIssuerMismatch`	401	발급기관 클레임이 토큰 확인에 실패했습니다.
`steps.jwt.JwtSubjectMismatch`	401	주체 클레임이 토큰 확인에 실패했습니다.
`steps.jwt.KeyIdMissing`	401	인증 정책은 JWKS를 공개 키의 소스로 사용하지만 서명된 JWT의 헤더에 `kid` 속성이 포함되지 않습니다.
`steps.jwt.KeyParsingFailed`	401	주어진 키 정보에서 공개 키를 파싱할 수 없습니다.
`steps.jwt.NoAlgorithmFoundInHeader`	401	JWT에 알고리즘 헤더가 없으면 발생합니다.
`steps.jwt.NoMatchingPublicKey`	401	인증 정책은 JWKS를 공개 키의 소스로 사용하지만 서명된 JWT의 `kid`가 JWKS에 나열되지 않습니다.
`steps.jwt.SigningFailed`	401	GenerateJWT에서, HS384 또는 HS512 알고리즘의 최소 크기보다 작은 키일 때 발생합니다.
`steps.jwt.TokenExpired`	401	정책이 만료된 토큰을 확인하려고 시도합니다.
`steps.jwt.TokenNotYetValid`	401	토큰이 아직 유효하지 않습니다.
`steps.jwt.UnhandledCriticalHeader`	401	`crit` 헤더의 JWT 인증 정책에서 찾은 헤더가 `KnownHeaders`에 표시되지 않습니다.
`steps.jwt.UnknownException`	401	알 수 없는 예외가 발생했습니다.
`steps.jwt.WrongKeyType`	401	잘못된 유형의 키가 지정되었습니다. 예를 들어 타원 곡선 알고리즘의 RSA 키를 지정하거나 RSA 알고리즘의 곡선 키를 지정하는 경우입니다.

배포 오류

이 오류는 이 정책이 포함된 프록시를 배포할 때 발생할 수 있습니다.

오류 이름	원인	수정
`InvalidNameForAdditionalClaim`	`<AdditionalClaims>` 요소의 하위 요소 `<Claim>`에 사용된 클레임이 다음 등록된 이름 `kid`, `iss`, `sub`, `aud`, `iat`, `exp`, `nbf` 또는 `jti` 중 하나인 경우 배포가 실패합니다.
`InvalidTypeForAdditionalClaim`	`<AdditionalClaims>` 요소의 하위 요소 `<Claim>`에 사용된 클레임이 `string`, `number`, `boolean` 또는 `map` 유형이 아니면 배포가 실패합니다.
`MissingNameForAdditionalClaim`	`<AdditionalClaims>` 요소의 하위 요소 `<Claim>`에서 클레임 이름이 지정되지 않으면 배포가 실패합니다.
`InvalidNameForAdditionalHeader`	이 오류는 `<AdditionalClaims>` 요소의 하위 요소 `<Claim>`에 사용된 클레임 이름이 `alg` 또는 `typ`일 때 발생합니다.
`InvalidTypeForAdditionalHeader`	`<AdditionalClaims>` 요소의 하위 요소 `<Claim>`에 사용된 클레임 유형이 `string`, `number`, `boolean` 또는 `map` 유형이 아니면 배포가 실패합니다.
`InvalidValueOfArrayAttribute`	이 오류는 `<AdditionalClaims>` 요소의 하위 요소 `<Claim>`에 있는 배열 속성 값이 `true` 또는 `false`로 설정되지 않은 경우에 발생합니다.
`InvalidValueForElement`	`<Algorithm>` 요소에 지정된 값이 지원되는 값이 아니면 배포가 실패합니다.
`MissingConfigurationElement`	이 오류는 `<PrivateKey>` 요소가 RSA 계열 알고리즘과 함께 사용되지 않거나 `<SecretKey>` 요소가 HS 제품군 알고리즘과 함께 사용되지 않는 경우에 발생합니다.
`InvalidKeyConfiguration`	하위 요소 `<Value>`가 `<PrivateKey>` 또는 `<SecretKey>` 요소에 정의되어 있지 않으면 배포가 실패합니다.
`EmptyElementForKeyConfiguration`	`<PrivateKey>` 또는 `<SecretKey>` 요소의 하위 요소 `<Value>`의 ref 속성이 비어 있거나 지정되지 않은 경우 배포가 실패합니다.
`InvalidConfigurationForVerify`	이 오류는 `<Id>` 요소가 `<SecretKey>` 요소 내에 정의된 경우에 발생합니다.
`InvalidEmptyElement`	이 오류는 JWT 확인 정책의 `<Source>` 요소가 비어 있는 경우에 발생합니다. 있는 경우 에지 흐름 변수 이름으로 정의해야 합니다.
`InvalidPublicKeyValue`	`<PublicKey>` 요소의 하위 요소 `<JWKS>`에 사용된 값이 RFC 7517에 지정된 유효한 형식을 사용하지 않으면 배포가 실패합니다.
`InvalidConfigurationForActionAndAlgorithm`	`<PrivateKey>` 요소가 HS Family 알고리즘과 함께 사용되거나 `<SecretKey>` 요소가 RSA Family 알고리즘과 함께 사용되면 배포가 실패합니다.

오류 변수

이러한 변수는 런타임 오류가 발생하면 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	위치	예
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name Matches "TokenExpired"`
`JWT.failed`	모든 JWT 정책은 오류 발생 시 동일한 변수를 설정합니다.	`JWT.failed = true`

오류 응답 예시

JWT 정책 오류 코드

오류 처리에서 권장사항은 오류 응답의 errorcode 부분을 트래핑하는 것입니다. 변경될 수 있으므로 faultstring의 텍스트에 의존하지 마세요.

오류 규칙 예시

    <FaultRules>
        <FaultRule name="JWT Policy Errors">
            <Step>
                <Name>JavaScript-1</Name>
                <Condition>(fault.name Matches "TokenExpired")</Condition>
            </Step>
            <Condition>JWT.failed=true</Condition>
        </FaultRule>
    </FaultRules>

XMLThreatProtection 정책

런타임 오류

이러한 오류는 정책이 실행될 때 발생할 수 있습니다.

오류 코드	HTTP 상태	원인
`steps.xmlthreatprotection.ExecutionFailed`	500	XMLThreatProtection 정책은 다양한 유형의 ExecutionFailed 오류를 발생시킬 수 있습니다. 이러한 오류의 대부분은 정책에 설정된 특정 임계값을 초과할 때 발생합니다. 이러한 오류의 유형에는 요소 이름 길이, 하위 요소 수, 노드 깊이, 속성 수, 속성 이름 길이 등이 포함됩니다. XMLThreatProtection 정책 런타임 오류 문제 해결 주제에서 전체 목록을 확인할 수 있습니다.
`steps.xmlthreatprotection.InvalidXMLPayload`	500	이 오류는 XMLThreatProtection 정책의 `<Source>` 요소에서 지정한 입력 메시지 페이로드가 유효한 XML 문서가 아닌 경우 발생합니다.
`steps.xmlthreatprotection.SourceUnavailable`	500	이 오류는 `<Source>` 요소에 지정된 메시지 변수가 다음 중 하나일 때 발생합니다. 범위를 벗어난 경우(정책이 실행 중인 특정 흐름에서 사용할 수 없음) 유효한 값 `request`, `response` 또는 `message` 중 하나가 아님
`steps.xmlthreatprotection.NonMessageVariable`	500	이 오류는 `<Source>` 요소가 메시지 유형이 아닌 변수로 설정된 경우에 발생합니다.

참고:

오류 이름 ExecutionFailed는 기본 오류 이름이며 감지된 오류 유형 하지만 이 기본값을 변경하려면 조직 수준 속성을 사용할 수 있습니다. 이 속성을 설정하면 오류 이름에 오류가 발생했습니다. 예: 'TextExceeded' 또는 'AttrValueExceeded'입니다. 사용 참고사항에서 다음을 참조하세요. 확인하세요.
500 HTTP 상태가 기본값입니다. HTTP 상태를 400으로 변경하여 요청 흐름 오류를 방지할 수 있습니다. 사용 참고사항에서 다음을 참조하세요. 확인하세요.

배포 오류

없음

오류 변수

이러한 변수는 런타임 오류가 발생하면 설정됩니다. 자세한 내용은 정책 오류에 대해 알아야 할 사항을 참조하세요.

변수	위치	예
`fault.name="fault_name"`	`fault_name`은 위의 런타임 오류 표에 나열된 오류 이름입니다. 오류 이름은 오류 코드의 마지막 부분입니다.	`fault.name Matches "SourceUnavailable"`
`xmlattack.policy_name.failed`	`policy_name`은 오류를 발생시킨 정책의 사용자 지정 이름입니다.	`xmlattack.XPT-SecureRequest.failed = true`

오류 응답 예시

참고: 오류 처리에서 권장사항은 오류 응답의 errorcode 부분을 트래핑하는 것입니다. 변경될 수 있으므로 faultstring의 텍스트에 의존하지 마세요.

{
  "fault": {
    "faultstring": "XMLThreatProtection[XPT-SecureRequest]: Execution failed. reason: XMLThreatProtection[XTP-SecureRequest]: Exceeded object entry name length at line 2",
    "detail": {
      "errorcode": "steps.xmlthreatprotection.ExecutionFailed"
    }
  }
}

오류 규칙 예시

<FaultRule name="XML Threat Protection Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ExecutionFailed") </Condition>
    </Step>
    <Condition>(xmlattack.XPT-SecureRequest.failed = true) </Condition>
</FaultRule>

XMLtoJSON 정책

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
`steps.xmltojson.ExecutionFailed`	500	This error occurs when the input payload (XML) is empty or the input XML is invalid or malformed.
`steps.xmltojson.InCompatibleType`	500	This error occurs if the type of the variable defined in the `<Source>` element and the `<OutputVariable>` element are not the same. It is mandatory that the type of the variables contained within the `<Source>` element and the `<OutputVariable>` element matches.
`steps.xmltojson.InvalidSourceType`	500	This error occurs if the type of the variable used to define the `<Source>` element is invalid.The valid types of variable are message and string.
`steps.xmltojson.OutputVariableIsNotAvailable`	500	This error occurs if the variable specified in the `<Source>` element of the XML to JSON policy is of type string and the `<OutputVariable>` element is not defined. The `<OutputVariable>` element is mandatory when the variable defined in the `<Source>` element is of type string.
`steps.xmltojson.SourceUnavailable`	500	This error occurs if the message variable specified in the `<Source>` element of the XML to JSON policy is either: out of scope (not available in the specific flow where the policy is being executed) or can't be resolved (is not defined)

Deployment errors

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

Error name	Cause	Fix
`EitherOptionOrFormat`	If one of the elements `<Options>` or `<Format>` is not declared in the XML to JSON Policy, then the deployment of the API proxy fails.
`UnknownFormat`	If the `<Format>` element within the XML to JSON policy has an unknown format defined, then the deployment of the API proxy fails. Predefined formats include: `xml.com`, `yahoo`, `google`, and `badgerFish`.

Fault variables

These variables are set when a runtime error occurs. 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 = "SourceUnavailable"`
`xmltojson.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`xmltojson.XMLtoJSON-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": "XMLToJSON[XMLtoJSON-1]: Source xyz is not available",
    "detail": {
      "errorcode": "steps.xml2json.SourceUnavailable"
    }
  }
}

Example fault rule

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="XML to JSON Faults">
    <Step>
        <Name>AM-SourceUnavailableMessage</Name>
        <Condition>(fault.name Matches "SourceUnavailable") </Condition>
    </Step>
    <Step>
        <Name>AM-BadXML</Name>
        <Condition>(fault.name = "ExecutionFailed")</Condition>
    </Step>
    <Condition>(xmltojson.XMLtoJSON-1.failed = true) </Condition>
</FaultRule>

XSLTransform 정책

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause	Fix
`steps.xsl.XSLSourceMessageNotAvailable`	500	This error occurs if the message or string variable specified in the `<Source>` element of the XSL Transform policy is either out of scope (not available in the specific flow where the policy is being executed) or can't be resolved (is not defined).
`steps.xsl.XSLEvaluationFailed`	500	This error occurs if the input XML payload is unavailable/malformed or the XSLTransform policy fails/is unable to transform the input XML file based on the transformation rules provided in the XSL file. There could be many different causes for the XSLTransform policy to fail. The reason for failure in the error message will provide more information on the cause.

Deployment errors

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

Error name	Cause	Fix
`XSLEmptyResourceUrl`	If the `<ResourceURL>` element in the XSL Transform policy is empty, then the deployment of the API proxy fails.
`XSLInvalidResourceType`	If the resource type specified in the `<ResourceURL>` element of the XSL Transform policy is not of type `xsl`, then the deployment of the API proxy fails.