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

Referenz zu Richtlinienfehlern

Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an. info

AccessControl-Richtlinie

Dieser Abschnitt beschreibt die Fehlercodes und Fehlermeldungen, die zurückgegeben werden, und die Fehlervariablen, die von Edge festgelegt werden, wenn diese Richtlinie einen Fehler auslöst. Diese Informationen sind wichtig, wenn Sie Fehlerregeln zur Verarbeitung von Fehlern entwickeln. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen und Fehler beheben.

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Ursache	Beheben
`accesscontrol.IPDeniedAccess`	403	Die Client-IP-Adresse oder eine in der API-Anfrage übergebene IP-Adresse entspricht einer IP-Adresse, die im Element `<SourceAddress>` des Elements `<MatchRule>` der Zugriffssteuerungsrichtlinie angegeben ist, und das Attribut `action` des Elements `<MatchRule>` ist auf `DENY` festgelegt.

Fehlervariablen

Diese Variablen werden bei Laufzeitfehlern festgelegt. Weitere Informationen finden Sie unter Für Richtlinienfehler spezifische Variablen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "IPDeniedAccess"`
`acl.policy_name.failed`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`acl.AC-AllowAccess.failed = true`

Beispiel für eine Fehlerantwort

Hinweis: Als Fehlerbehandlung empfehlen wir, den errorcode-Teil der Fehlerantwort zu extrahieren. Verlassen Sie sich nicht auf den Text in faultstring. Er kann sich ändern.

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

Beispiel für eine Fehlerregel

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

AccessEntity-Richtlinie

For related information, see What you need to know about policy errors and Handling faults.

Runtime errors

None.

Deployment errors

Error name	Fault string	HTTP status	Occurs when
`InvalidEntityType`	`Invalid type [entity_type] in ACCESSENTITYStepDefinition [policy_name]`	N/A	The entity type used must be one of the supported types.

AssignMessage-Richtlinie

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode HTTP-Status Ursache Beheben

steps.assignmessage.SetVariableFailed 500 Die Richtlinie konnte keine Variable festlegen. Sehen Sie sich den Fehlerstring für den Namen der nicht aufgelösten Variable an.

Fehlercode	HTTP-Status	Ursache
`steps.assignmessage.SetVariableFailed`	500	Die Richtlinie konnte keine Variable festlegen. Sehen Sie sich den Fehlerstring für den Namen der nicht aufgelösten Variable an.
`steps.assignmessage.VariableOfNonMsgType`	500	Dieser Fehler tritt auf, wenn für das Attribut `source` im Element `<Copy>` eine Variable festgelegt ist, die nicht vom Typ message ist. Nachrichtentypvariablen stellen ganze HTTP-Anfragen und -Antworten dar. Der integrierte Edge Die Flussvariablen `request`, `response` und `message` sind vom Typ „message“. Weitere Informationen zu Nachrichtenvariablen finden Sie in der Variablenreferenz.
`steps.assignmessage.UnresolvedVariable`	500	Dieser Fehler tritt bei einer Variablen auf, die in der Richtlinie "Nachricht zuweisen" angegeben ist, wenn die Variable Der Wert liegt außerhalb des Bereichs (ist nicht in dem spezifischen Ablauf verfügbar, in dem die Richtlinie ausgeführt wird) oder Kann nicht aufgelöst werden (nicht definiert)

steps.assignmessage.VariableOfNonMsgType

500

Dieser Fehler tritt auf, wenn für das Attribut source im Element <Copy> eine Variable festgelegt ist, die nicht vom Typ message ist.

Nachrichtentypvariablen stellen ganze HTTP-Anfragen und -Antworten dar. Der integrierte Edge Die Flussvariablen request, response und message sind vom Typ „message“. Weitere Informationen zu Nachrichtenvariablen finden Sie in der Variablenreferenz.

steps.assignmessage.UnresolvedVariable

500

Dieser Fehler tritt bei einer Variablen auf, die in der Richtlinie "Nachricht zuweisen" angegeben ist, wenn die Variable

Der Wert liegt außerhalb des Bereichs (ist nicht in dem spezifischen Ablauf verfügbar, in dem die Richtlinie ausgeführt wird)
Kann nicht aufgelöst werden (nicht definiert)

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy bereitstellen, der diese Richtlinie enthält.

Fehlername	Ursache	Beheben
`InvalidIndex`	Wenn der in den Elementen `<Copy>` und/oder `<Remove>` der Richtlinie "Nachricht zuweisen" angegebene Wert 0 oder eine negative Zahl ist, schlägt die Bereitstellung des API-Proxys fehl.
`InvalidVariableName`	Wenn das untergeordnete Element `<Name>` leer ist oder nicht im Element `<AssignVariable>` angegeben ist, schlägt die Bereitstellung des API-Proxys fehl, da kein gültiger Variablenname vorhanden ist, dem ein Wert zugewiesen werden soll. Ein gültiger Variablenname ist erforderlich.
`InvalidPayload`	Eine in der Richtlinie angegebene Nutzlast ist ungültig.

Fehlervariablen

Diese Variablen werden festgelegt, wenn diese Richtlinie zur Laufzeit einen Fehler auslöst. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "UnresolvedVariable"`
`assignmessage.policy_name.failed`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`assignmessage.AM-SetResponse.failed = true`

Beispiel für eine Fehlerantwort

Hinweis: Bei der Fehlerbehandlung besteht die Best Practice darin, den Teil errorcode der Fehlerantwort zu beachten. Verlassen Sie sich nicht auf den Text in faultstring. Er kann sich ändern.

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.assignmessage.VariableOfNonMsgType"
      },
      "faultstring":"AssignMessage[AM-SetResponse]: value of variable is not of type Message"
   }
}

Beispiel für eine Fehlerregel

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

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Ursache	Beheben
`steps.basicauthentication.InvalidBasicAuthenticationSource`	500	Bei einer Decodierung, wenn der eingehende Base64-codierte String keinen gültigen Wert enthält oder der Header fehlerhaft ist (z. B. nicht mit "Basic" beginnen)
`steps.basicauthentication.UnresolvedVariable`	500	Die erforderlichen Quellvariablen für die Decodierung oder Codierung sind nicht vorhanden. Dieser Fehler kann nur auftreten, wenn `IgnoreUnresolvedVariables` auf "false" gesetzt ist.

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy mit dieser Richtlinie bereitstellen.

Fehlername	Tritt auf, wenn Folgendes eintritt	Beheben
`UserNameRequired`	Das Element `<User>` muss für den benannten Vorgang vorhanden sein.
`PasswordRequired`	Das Element `<Password>` muss für den benannten Vorgang vorhanden sein.
`AssignToRequired`	Das Element `<AssignTo>` muss für den benannten Vorgang vorhanden sein.
`SourceRequired`	Das Element `<Source>` muss für den benannten Vorgang vorhanden sein.

Fehlervariablen

Diese Variablen werden bei Laufzeitfehlern festgelegt. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "UnresolvedVariable"`
`BasicAuthentication.policy_name.failed`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`BasicAuthentication.BA-Authenticate.failed = true`

Beispiel für eine Fehlerantwort

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.basicauthentication.UnresolvedVariable"
      },
      "faultstring":"Unresolved variable : request.queryparam.password"
   }
}

Beispiel für eine Fehlerregel

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

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

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	Occurs when
`steps.jws.FailedToDecode`	401	The policy was unable to decode the JWS. The JWS is possibly corrupted.
`steps.jws.FailedToResolveVariable`	401	Occurs when the flow variable specified in the `<Source>` element of the policy does not exist.
`steps.jws.InvalidClaim`	401	For a missing claim or claim mismatch, or a missing header or header mismatch.
`steps.jws.InvalidJsonFormat`	401	Invalid JSON found in the JWS header.
`steps.jws.InvalidJws`	401	This error occurs when the JWS signature verification fails.
`steps.jws.InvalidPayload`	401	The JWS payload is invalid.
`steps.jws.InvalidSignature`	401	`<DetachedContent>` is omitted and the JWS has a detached content payload.
`steps.jws.MissingPayload`	401	The JWS payload is missing.
`steps.jws.NoAlgorithmFoundInHeader`	401	Occurs when the JWS omits the algorithm header.
`steps.jws.UnknownException`	401	An unknown exception occurred.

Deployment errors

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

Error name Occurs when

InvalidAlgorithm The only valid values are: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512.

Error name	Occurs when
`InvalidAlgorithm`	The only valid values are: 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`	Other possible deployment errors.

EmptyElementForKeyConfiguration

FailedToResolveVariable

InvalidConfigurationForActionAndAlgorithmFamily

InvalidConfigurationForVerify

InvalidEmptyElement

InvalidFamiliesForAlgorithm

InvalidKeyConfiguration

InvalidNameForAdditionalClaim

InvalidNameForAdditionalHeader

InvalidPublicKeyId

InvalidPublicKeyValue

InvalidSecretInConfig

InvalidTypeForAdditionalClaim

InvalidTypeForAdditionalHeader

InvalidValueForElement

InvalidValueOfArrayAttribute

InvalidVariableNameForSecret

MissingConfigurationElement

MissingElementForKeyConfiguration

MissingNameForAdditionalClaim

MissingNameForAdditionalHeader

Other possible deployment errors.

Fehlervariablen

Diese Variablen werden bei Laufzeitfehlern festgelegt. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "TokenExpired"`
`JWS.failed`	Bei allen JWT-Richtlinien wird im Fall eines Fehlers dieselbe Variable festgelegt.	`jws.JWS-Policy.failed = true`

Beispiel für eine Fehlerantwort

Bei der Fehlerbehandlung besteht die Best Practice darin, den errorcode-Teil der Fehlerantwort zu beachten. Verlassen Sie sich nicht auf den Text in faultstring. Er kann sich ändern.

Beispiel für eine Fehlerregel

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

In diesem Abschnitt werden die Fehlercodes und Fehlermeldungen beschrieben, die zurückgegeben werden, sowie die Fehlervariablen, die von Edge festgelegt werden, wenn diese Richtlinie einen Fehler auslöst. Diese Informationen sind wichtig, wenn Sie Fehlerregeln zur Verarbeitung von Fehlern entwickeln. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen und Fehler beheben.

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Ursache
`steps.jwt.FailedToDecode`	401	Tritt auf, wenn die Richtlinie das JWT nicht decodieren kann. Das JWT ist möglicherweise fehlerhaft oder ungültig oder anderweitig nicht decodierbar.
`steps.jwt.FailedToResolveVariable`	401	Tritt auf, wenn die im Element `<Source>` der Richtlinie angegebene Flussvariable nicht vorhanden ist.
`steps.jwt.InvalidToken`	401	Tritt auf, wenn die im Element `<Source>` der Richtlinie angegebene Ablaufvariable den Gültigkeitsbereich überschreitet oder nicht aufgelöst werden kann.

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy mit dieser Richtlinie bereitstellen.

Fehlername	Ursache	Beheben
`InvalidEmptyElement`	Tritt auf, wenn die Flussvariable, die das zu decodierende JWT enthält, nicht im Element `<Source>` der Richtlinie angegeben ist.

Fehlervariablen

Diese Variablen werden bei Laufzeitfehlern festgelegt. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "TokenExpired"`
`JWT.failed`	Bei allen JWT-Richtlinien wird im Fall eines Fehlers dieselbe Variable festgelegt.	`JWT.failed = true`

Beispiel für eine Fehlerantwort

JWT-Richtlinienfehlercodes

Bei der Fehlerbehandlung besteht die Best Practice darin, den errorcode-Teil der Fehlerantwort zu beachten. Verlassen Sie sich nicht auf den Text in faultstring. Er kann sich ändern.

Beispiel für eine Fehlerregel

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

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Ursache
`steps.extractvariables.ExecutionFailed`	500	Dieser Fehler tritt in folgenden Fällen auf: die Eingabe-Nutzlast (JSON, XML) leer ist. die an die Richtlinie übergebene Eingabe (JSON, XML usw.) ungültig oder fehlerhaft ist.
`steps.extractvariables.ImmutableVariable`	500	Eine in der Richtlinie verwendete Variable ist unveränderlich. Diese Variable konnte von der Richtlinie nicht festgelegt werden.
`steps.extractvariables.InvalidJSONPath`	500	Dieser Fehler tritt auf, wenn im `JSONPath`-Element der Richtlinie ein ungültiger JSON-Pfad verwendet wird. Wenn beispielsweise eine JSON-Nutzlast das Objekt `Name` nicht enthält, Sie aber `Name` als Pfad in der Richtlinie angeben, tritt dieser Fehler auf.
`steps.extractvariables.JsonPathParsingFailure`	500	Dieser Fehler tritt auf, wenn die Richtlinie einen JSON-Pfad nicht parsen und keine Daten aus der im Element `Source` angegebenen Flussvariable extrahieren kann. Dies geschieht normalerweise, wenn die im Element `Source` angegebene Flussvariable im aktuellen Ablauf nicht vorhanden ist.
`steps.extractvariables.SetVariableFailed`	500	Dieser Fehler tritt auf, wenn die Richtlinie den Wert nicht auf eine Variable setzen konnte. Der Fehler tritt in der Regel auf, wenn Sie Werte für mehrere Variablen zuweisen möchten, deren Namen mit den gleichen Begriffen in einem verschachtelten, durch Punkte getrennten Format beginnen.
`steps.extractvariables.SourceMessageNotAvailable`	500	Dieser Fehler tritt auf, wenn auf die Variable message, die im Element `Source` der Richtlinie angegeben ist, einer der folgenden Punkte zutrifft: außerhalb des Geltungsbereichs (nicht im spezifischen Ablauf verfügbar, in dem die Richtlinie ausgeführt wird) oder kann nicht gelöst werden (ist nicht definiert)
`steps.extractvariables.UnableToCast`	500	Dieser Fehler tritt auf, wenn die Richtlinie den extrahierten Wert nicht in eine Variable umwandeln konnte. Dies ist in der Regel der Fall, wenn Sie versuchen, den Wert eines Datentyps auf die Variable eines anderen Datentyps festzulegen.

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy bereitstellen, der diese Richtlinie enthält.

Fehlername	Ursache	Beheben
`NothingToExtract`	Wenn die Richtlinie keines der Elemente `URIPath`, `QueryParam`, `Header`, `FormParam`, `XMLPayload` oder `JSONPayload` enthält, schlägt die Bereitstellung des API-Proxys fehl, weil es nichts zu extrahieren gibt.
`NONEmptyPrefixMappedToEmptyURI`	Dieser Fehler tritt auf, wenn im `Namespace`-Element unter dem `XMLPayload`-Element ein Präfix definiert ist, aber kein URI.
`DuplicatePrefix`	Dieser Fehler tritt auf, wenn in der im Element `Namespace` unter dem Element `XMLPayload` dasselbe Element mehrmals definiert ist.
`NoXPathsToEvaluate`	Wenn die Richtlinie im Element `XMLPayload` das Element `XPath` nicht enthält, schlägt die Bereitstellung des API-Proxys mit diesem Fehler fehl. Wenn Sie Variablen aus einer XML-Nutzlast extrahieren möchten, muss ein untergeordnetes `XPath`-Element angegeben werden.
`EmptyXPathExpression`	Wenn die Richtlinie im Element `XMLPayload` einen leeren `XPath`-Ausdruck enthält, schlägt die Bereitstellung des API-Proxys fehl.
`NoJSONPathsToEvaluate`	Wenn die Richtlinie im Element `JSONPayload` das Element `JSONPath` nicht enthält, schlägt die Bereitstellung des API-Proxys mit diesem Fehler fehl.
`EmptyJSONPathExpression`	Wenn die Richtlinie im Element `XMLPayload` einen leeren `XPath`-Ausdruck enthält, schlägt die Bereitstellung des API-Proxys fehl.
`MissingName`	Wenn die Richtlinie das Attribut `name` in keinem der Richtlinienelemente wie `QueryParam`, `Header`, `FormParam` oder `Variable` enthält, wo dies erforderlich ist, dann schlägt die Bereitstellung des API-Proxys fehl.
`PatternWithoutVariable`	Wenn in der Richtlinie im Element `Pattern` keine Variable angegeben ist, schlägt die Bereitstellung des API-Proxys fehl. Das Element `Pattern` erfordert den Namen der Variablen, in der extrahierte Daten gespeichert werden.
`CannotBeConvertedToNodeset`	Wenn die Richtlinie einen Ausdruck `XPath` enthält, bei dem der Typ `Variable` als nodeset definiert ist, der Ausdruck jedoch nicht in ein Knotengruppe konvertiert werden kann, dann wird die Bereitstellung der API bereitgestellt. Proxy schlägt fehl.
`JSONPathCompilationFailed`	Die Richtlinie konnte keinen angegebenen JSON-Pfad kompilieren.
`InstantiationFailed`	Die Richtlinie konnte nicht instanziiert werden.
`XPathCompilationFailed`	Wenn das Präfix oder der Wert, der im Element `XPath` verwendet wird, zu keinem der angegebenen Namespaces in der Richtlinie gehört, schlägt die Bereitstellung des API-Proxys fehl.
`InvalidPattern`	Wenn die Definition des `Pattern`-Elements in einem der Elemente wie `URIPath`, `QueryParam`, `Header`, `FormParam`, `XMLPayload` oder `JSONPayload` in der Richtlinie ungültig ist, dann schlägt die Bereitstellung des API-Proxys fehl. Das `Pattern`-Element gilt als ungültig, wenn es keine Variable enthält. Weitere Informationen zum Musterabgleich finden Sie unter Informationen zum Abgleich und zur Variablenerstellung.

Fehlervariablen

Diese Variablen werden festgelegt, wenn diese Richtlinie zur Laufzeit einen Fehler auslöst. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name = "SourceMessageNotAvailable"`
`extractvariables.policy_name.failed`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`extractvariables.EV-ParseJsonResponse.failed = true`

Beispiel für eine Fehlerantwort

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

Beispiel für eine Fehlerregel

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

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Tritt auf, wenn Folgendes eintritt
`steps.jws.GenerationFailed`	401	Die Richtlinie konnte das JWS nicht generieren.
`steps.jws.InsufficientKeyLength`	401	Für Schlüssel mit weniger als 32 Byte für den HS256-Algorithmus
`steps.jws.InvalidClaim`	401	Bei einem fehlenden Anspruch oder nicht übereinstimmenden Ansprüchen oder einem fehlenden Header oder Header.
`steps.jws.InvalidCurve`	401	Die vom Schlüssel angegebene Kurve ist für den Elliptic-Curve-Algorithmus ungültig.
`steps.jws.InvalidJsonFormat`	401	Ungültige JSON-Datei im JWS-Header
`steps.jws.InvalidPayload`	401	Die JWS-Nutzlast ist ungültig.
`steps.jws.InvalidSignature`	401	`<DetachedContent>` wird weggelassen und das JWS hat eine separate Inhaltsnutzlast.
`steps.jws.KeyIdMissing`	401	Die Überprüfungsrichtlinie verwendet eine JWKS als Quelle für öffentliche Schlüssel. Die signierte JWS enthält jedoch keine `kid`-Property im Header.
`steps.jws.KeyParsingFailed`	401	Der öffentliche Schlüssel konnte anhand der angegebenen Schlüsselinformationen nicht geparst werden.
`steps.jws.MissingPayload`	401	Die JWS-Nutzlast fehlt.
`steps.jws.NoAlgorithmFoundInHeader`	401	Tritt auf, wenn der JWS den Algorithmusheader weglässt.
`steps.jws.SigningFailed`	401	In GenerateJWS, für Schlüssel, die kleiner als die Mindestgröße für den HS384- oder HS512-Algorithmus sind
`steps.jws.UnknownException`	401	Es ist eine unbekannte Ausnahme aufgetreten.
`steps.jws.WrongKeyType`	401	Falscher Schlüsseltyp angegeben. Wenn Sie beispielsweise einen RSA-Schlüssel für einen Elliptic Curve-Algorithmus oder einen Kurvenschlüssel für einen RSA-Algorithmus angeben.

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy mit dieser Richtlinie bereitstellen.

Fehlername Tritt auf, wenn Folgendes eintritt

InvalidAlgorithm Die einzigen gültigen Werte sind: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512.

Fehlername	Tritt auf, wenn Folgendes eintritt
`InvalidAlgorithm`	Die einzigen gültigen Werte sind: 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`	Andere mögliche Bereitstellungsfehler.

EmptyElementForKeyConfiguration

FailedToResolveVariable

InvalidConfigurationForActionAndAlgorithmFamily

InvalidConfigurationForVerify

InvalidEmptyElement

InvalidFamiliesForAlgorithm

InvalidKeyConfiguration

InvalidNameForAdditionalClaim

InvalidNameForAdditionalHeader

InvalidPublicKeyId

InvalidPublicKeyValue

InvalidSecretInConfig

InvalidTypeForAdditionalClaim

InvalidTypeForAdditionalHeader

InvalidValueForElement

InvalidValueOfArrayAttribute

InvalidVariableNameForSecret

MissingConfigurationElement

MissingElementForKeyConfiguration

MissingNameForAdditionalClaim

MissingNameForAdditionalHeader

Andere mögliche Bereitstellungsfehler.

Fehlervariablen

Diese Variablen werden bei Laufzeitfehlern festgelegt. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "TokenExpired"`
`JWS.failed`	Bei allen JWT-Richtlinien wird im Fall eines Fehlers dieselbe Variable festgelegt.	`jws.JWS-Policy.failed = true`

Beispiel für eine Fehlerantwort

Bei der Fehlerbehandlung besteht die Best Practice darin, den errorcode-Teil der Fehlerantwort zu beachten. Verlassen Sie sich nicht auf den Text in faultstring. Er kann sich ändern.

Beispiel für eine Fehlerregel

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

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Tritt auf, wenn Folgendes eintritt
`steps.jwt.AlgorithmInTokenNotPresentInConfiguration`	401	Tritt auf, wenn die Prüfungsrichtlinie mehrere Algorithmen nutzt.
`steps.jwt.AlgorithmMismatch`	401	Der in der Generierungsrichtlinie angegebene Algorithmus stimmte nicht mit dem in der Verifizierungsrichtlinie erwarteten Algorithmus überein. Die angegebenen Algorithmen müssen übereinstimmen.
`steps.jwt.FailedToDecode`	401	Die Richtlinie konnte das JWT nicht decodieren. Das JWT ist möglicherweise beschädigt.
`steps.jwt.GenerationFailed`	401	Die Richtlinie konnte das JWT nicht generieren.
`steps.jwt.InsufficientKeyLength`	401	Für einen Schlüssel mit weniger als 32 Byte beim HS256-Algorithmus, weniger als 48 Byte beim HS386 Algorithmus und weniger als 64 Byte beim HS512-Algorithmus.
`steps.jwt.InvalidClaim`	401	Bei einem fehlenden Anspruch oder nicht übereinstimmenden Ansprüchen oder einem fehlenden Header oder Header.
`steps.jwt.InvalidCurve`	401	Die vom Schlüssel angegebene Kurve ist für den Elliptic-Curve-Algorithmus ungültig.
`steps.jwt.InvalidJsonFormat`	401	Ungültiger JSON-Code im Header oder der Nutzlast gefunden.
`steps.jwt.InvalidToken`	401	Dieser Fehler tritt auf, wenn die JWT-Signaturprüfung fehlschlägt.
`steps.jwt.JwtAudienceMismatch`	401	Der Zielgruppenanspruch ist bei der Tokenprüfung fehlgeschlagen.
`steps.jwt.JwtIssuerMismatch`	401	Der Ausstelleranspruch ist bei der Tokenprüfung fehlgeschlagen.
`steps.jwt.JwtSubjectMismatch`	401	Der Betreffanspruch ist bei der Tokenprüfung fehlgeschlagen.
`steps.jwt.KeyIdMissing`	401	Die Verifizierungsrichtlinie verwendet einen JWKS als Quelle für öffentliche Schlüssel, das signierte JWT enthält jedoch kein `kid`-Attribut im Header.
`steps.jwt.KeyParsingFailed`	401	Der öffentliche Schlüssel konnte anhand der angegebenen Schlüsselinformationen nicht geparst werden.
`steps.jwt.NoAlgorithmFoundInHeader`	401	Tritt auf, wenn das JWT keinen Algorithmus-Header enthält.
`steps.jwt.NoMatchingPublicKey`	401	Die Verifizierungsrichtlinie verwendet einen JWKS als Quelle für öffentliche Schlüssel, aber `kid` im signierten JWT ist nicht in JWKS aufgeführt.
`steps.jwt.SigningFailed`	401	In GenerateJWT, für Schlüssel, die kleiner als die Mindestgröße für den HS384- oder HS512-Algorithmus sind
`steps.jwt.TokenExpired`	401	Die Richtlinie versucht, ein abgelaufenes Token zu bestätigen.
`steps.jwt.TokenNotYetValid`	401	Das Token ist noch nicht gültig.
`steps.jwt.UnhandledCriticalHeader`	401	Ein Header, der von der JWT-Richtlinie im Header `crit` gefunden wurde, ist nicht in `KnownHeaders` aufgeführt.
`steps.jwt.UnknownException`	401	Es ist eine unbekannte Ausnahme aufgetreten.
`steps.jwt.WrongKeyType`	401	Falscher Schlüsseltyp angegeben. Wenn Sie beispielsweise einen RSA-Schlüssel für einen Elliptic Curve-Algorithmus oder einen Kurvenschlüssel für einen RSA-Algorithmus angeben.

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy bereitstellen, der diese Richtlinie enthält.

Fehlername	Ursache	Problembehebung
`InvalidNameForAdditionalClaim`	Die Bereitstellung schlägt fehl, wenn die im untergeordneten Element `<Claim>` des Elements `<AdditionalClaims>` verwendete Anforderung einer der folgenden registrierten Namen ist: `kid`, `iss`, `sub`, `aud`, `iat`, `exp`, `nbf` oder `jti`.
`InvalidTypeForAdditionalClaim`	Wenn die im untergeordneten Element `<Claim>` des `<AdditionalClaims>`-Elements verwendete Anforderung nicht vom Typ `string`, `number`, `boolean` oder `map` ist, schlägt die Bereitstellung fehl.
`MissingNameForAdditionalClaim`	Wenn der Name der Anforderung nicht im untergeordneten Element `<Claim>` des Elements `<AdditionalClaims>` angegeben ist, schlägt die Bereitstellung fehl.
`InvalidNameForAdditionalHeader`	Dieser Fehler tritt auf, wenn der Name der im untergeordneten Element `<Claim>` des `<AdditionalClaims>`-Elements verwendeten Anforderung entweder `alg` oder `typ` ist.
`InvalidTypeForAdditionalHeader`	Wenn der im untergeordneten Element `<Claim>` des `<AdditionalClaims>`-Elements verwendete Anforderungstyp nicht vom Typ `string`, `number`, `boolean` oder `map` ist, schlägt die Bereitstellung fehl.
`InvalidValueOfArrayAttribute`	Dieser Fehler tritt auf, wenn der Wert des Array-Attributs im untergeordneten Element `<Claim>` des `<AdditionalClaims>`-Elements nicht auf `true` oder `false` festgelegt ist.
`InvalidConfigurationForActionAndAlgorithm`	Wenn das Element `<PrivateKey>` mit HS-Family-Algorithmen oder das `<SecretKey>`-Element mit RSA-Family-Algorithmen verwendet wird, schlägt die Bereitstellung fehl.
`InvalidValueForElement`	Wenn der im Element `<Algorithm>` angegebene Wert kein unterstützter Wert ist, schlägt die Bereitstellung fehl.
`MissingConfigurationElement`	Dieser Fehler tritt auf, wenn das Element `<PrivateKey>` nicht mit RSA-Familienalgorithmen oder das Element `<SecretKey>` nicht mit Algorithmen der HS-Familie verwendet wird.
`InvalidKeyConfiguration`	Wenn das untergeordnete Element `<Value>` nicht in den Elementen `<PrivateKey>` oder `<SecretKey>` definiert ist, schlägt die Bereitstellung fehl.
`EmptyElementForKeyConfiguration`	Wenn das ref-Attribut des untergeordneten Elements `<Value>` der Elemente `<PrivateKey>` oder `<SecretKey>` leer oder nicht angegeben ist, schlägt die Bereitstellung fehl.
`InvalidVariableNameForSecret`	Dieser Fehler tritt auf, wenn der im ref-Attribut des untergeordneten Elements `<Value>` der Elemente `<PrivateKey>` oder `<SecretKey>` angegebene Flussvariablenname nicht das private Präfix `(private.)` enthält.
`InvalidSecretInConfig`	Dieser Fehler tritt auf, wenn das untergeordnete Element `<Value>` der `<PrivateKey>`- oder `<SecretKey>`-Elemente nicht das private Präfix `(private.)` enthält.
`InvalidTimeFormat`	Wenn der im Element `<NotBefore>` angegebene Wert kein unterstütztes Format verwendet, schlägt die Bereitstellung fehl.

Fehlervariablen

Diese Variablen werden bei Laufzeitfehlern festgelegt. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "TokenExpired"`
`JWT.failed`	Bei allen JWT-Richtlinien wird im Fall eines Fehlers dieselbe Variable festgelegt.	`JWT.failed = true`

Beispiel für eine Fehlerantwort

JWT-Richtlinienfehlercodes

Bei der Fehlerbehandlung besteht die Best Practice darin, den errorcode-Teil der Fehlerantwort zu beachten. Verlassen Sie sich nicht auf den Text in faultstring. Er kann sich ändern.

Beispiel für eine Fehlerregel

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

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Ursache	Beheben
`steps.javacallout.ExecutionError`	500	Tritt auf, wenn der Java-Code während der Ausführung einer JavaCallout-Richtlinie eine Ausnahme auslöst oder Null zurückgibt.

Bereitstellungsfehler

Diese Fehler können bei der Bereitstellung des Proxy mit der Richtlinie auftreten.

Fehlername	Fehlerstring	HTTP-Status	Tritt auf, wenn Folgendes eintritt
`ResourceDoesNotExist`	`Resource with name [name] and type [type] does not exist`	–	Die im Element `<ResourceURL>` angegebene Datei ist nicht vorhanden.
`JavaCalloutInstantiationFailed`	`Failed to instantiate the JavaCallout Class [classname]`	–	Die im Element `<ClassName>` angegebene Klassendatei befindet sich nicht in der JAR-Datei.
`IncompatibleJavaVersion`	`Failed to load java class [classname] definition due to - [reason]`	–	Siehe Fehlerstring. Siehe auch Unterstützte Software und unterstützten Versionen.
`JavaClassNotFoundInJavaResource`	`Failed to find the ClassName in java resource [jar_name] - [class_name]`	-	Siehe Fehlerstring.
`JavaClassDefinitionNotFound`	`Failed to load java class [class_name] definition due to - [reason]`	–	Siehe Fehlerstring.
`NoAppropriateConstructor`	`No appropriate constructor found in JavaCallout class [class_name]`	–	Siehe Fehlerstring.
`NoResourceForURL`	`Could not locate a resource with URL [string]`	–	Siehe Fehlerstring.

Fehlervariablen

Diese Variablen werden festgelegt, wenn die Richtlinie einen Fehler auslöst. Weitere Informationen finden sich unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "ExecutionError"`
`javacallout.policy_name.failed`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`javacallout.JC-GetUserData.failed = true`

Beispiel für eine Fehlerantwort

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

Beispiel für eine Fehlerregel

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

JavaScript-Richtlinie

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.javascript.ScriptExecutionFailed`	500	The JavaScript policy can throw many different types of ScriptExecutionFailed errors. Commonly seen types of errors include RangeError, ReferenceError, SyntaxError, TypeError, and URIError.
`steps.javascript.ScriptExecutionFailedLineNumber`	500	An error occurred in the JavaScript code. See the fault string for details.	N/A
`steps.javascript.ScriptSecurityError`	500	A security error occurred when the JavaScript executed. See the fault string for details.	N/A

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 JavaScript policy is invalid, then the deployment of the API proxy fails.
`InvalidResourceUrlReference`	If the `<ResourceURL>` or the `<IncludeURL>` elements refer to a JavaScript 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.
`WrongResourceType`	This error occurs during deployment if the `<ResourceURL>` or the `<IncludeURL>` elements of the JavaScript policy refer to any resource type other than jsc (JavaScript file).
`NoResourceURLOrSource`	The deployment of the JavaScript policy can fail with this error if the `<ResourceURL>` element is not declared or if the resource URL is not defined within this element. `<ResourceURL>` element is a mandatory element. Or, The `<IncludeURL>` element is declared but the resource URL is not defined within this element. The `<IncludeURL>` element is optional but if declared, the resource URL must be specified within the `<IncludeURL>` element.

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"`
`javascript.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`javascript.JavaScript-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: Javascript runtime error: "ReferenceError: "status" is not defined. (setresponse.js:6)\"",
    "detail": {
      "errorcode": "steps.javascript.ScriptExecutionFailed"
    }
  }
}

Example fault rule

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

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
`steps.jsonthreatprotection.ExecutionFailed`	500	The JSONThreatProtection policy can throw many different types of ExecutionFailed errors. Most of these errors occur when a specific threshold set in the policy is exceeded. These types of errors include: object entry name length, object entry count, array element count, container depth, string string value length. This error also occurs when the payload contains an invalid JSON object.
`steps.jsonthreatprotection.SourceUnavailable`	500	This error occurs if the message variable specified in the `<Source>` element is either: Out of scope (not available in the specific flow where the policy is being executed) Is not one of the valid values `request`, `response`, or `message`
`steps.jsonthreatprotection.NonMessageVariable`	500	This error occurs if the `<Source>` element is set to a variable which is not of type message.

Deployment errors

None.

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 "SourceUnavailable"`
`jsonattack.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`jsonattack.JTP-SecureRequest.failed = true`

Example error response

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

Example fault rule

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

Die JSONThreatProtection-Richtlinientypen definieren folgende Fehlercodes:

JSONtoXML-Richtlinie

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Ursache
`steps.jsontoxml.ExecutionFailed`	500	Die Nutzlast der JSON-Eingabe ist leer oder die an JSON-zu-XML-Richtlinie übergebene JSON-Eingabe ist ungültig oder fehlerhaft.
`steps.jsontoxml.InCompatibleTypes`	500	Dieser Fehler tritt auf, wenn der Typ der im `<Source>`-Element definierten Variable und das `<OutputVariable>`-Element nicht identisch sind. Der Typ der im Element `<Source>`-Element enthaltenen Variablen muss mit dem Typ der im `<OutputVariable>`Element enthaltenden Variable übereinstimmen. Gültige Typen sind `message` und `string`.
`steps.jsontoxml.InvalidSourceType`	500	Dieser Fehler tritt auf, wenn der Variablentyp, der zum Definieren des `<Source>`-Elements verwendet wird, ungültig ist. Die gültigen Variablentypen sind `message` und `string`.
`steps.jsontoxml.OutputVariableIsNotAvailable`	500	Dieser Fehler tritt auf, wenn die im `<Source>`-Element der JSON-zu-XML-Richtlinie angegebene Variable den Typ "String" hat und das Element `<OutputVariable>` nicht definiert ist. Das Element `<OutputVariable>` ist obligatorisch, wenn die im Element `<Source>` definierte Variable vom Typ "String" ist.
`steps.jsontoxml.SourceUnavailable`	500	Dieser Fehler tritt auf, wenn für die im `<Source>`-Element der JSON-zu-XML-Richtlinie angegebene Variable message eine der folgenden Aussagen gilt: außerhalb des Geltungsbereichs (nicht in dem spezifischen Ablauf verfügbar, in dem die Richtlinie ausgeführt wird) oder Kann nicht aufgelöst werden (nicht definiert)

Bereitstellungsfehler

–

Fehlervariablen

Diese Variablen werden bei Laufzeitfehlern festgelegt. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "SourceUnavailable"`
`jsontoxml.policy_name.failed`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`jsontoxml.JSON-to-XML-1.failed = true`

Beispiel für eine Fehlerantwort

{
  "fault": {
    "faultstring": "JSONToXML[JSON-to-XML-1]: Source xyz is not available",
    "detail": {
      "errorcode": "steps.json2xml.SourceUnavailable"
    }
  }
}

Beispiel für eine Fehlerregel

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

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

Für diese Richtlinie werden die folgenden Fehlercodes verwendet:

Fehlercode	die Botschaft und
`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-Richtlinie

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Ursache
`steps.messagelogging.StepDefinitionExecutionFailed`	500	Siehe Fehlerstring.

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy bereitstellen, der diese Richtlinie enthält.

Fehlername	Ursache	Beheben
`InvalidProtocol`	Die Bereitstellung der `<Protocol>`MessageLogging-Richtlinie kann mit diesem Fehler fehlschlagen, wenn das im -Element angegebene Protokoll nicht gültig ist. Gültige Protokolle sind TCP und UDP. Zum Senden von Syslog-Nachrichten über TLS/SSL wird nur TCP unterstützt.
`InvalidPort`	Die Bereitstellung der MessageLogging-Richtlinie kann mit diesem Fehler fehlschlagen, wenn die Portnummer nicht im Element `<Port>` angegeben oder ungültig ist. Die Portnummer muss eine Ganzzahl größer als null sein.

Fehlervariablen

Diese Variablen werden bei Laufzeitfehlern festgelegt. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "StepDefinitionExecutionFailed"`
`messagelogging.policy_name.failed`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`messagelogging.ML-LogMessages.failed = true`

Beispiel für eine Fehlerantwort

{  
   "fault":{  
      "detail":{  
         "errorcode":"steps.messagelogging.StepDefinitionExecutionFailed"
      },
      "faultstring":"Execution failed"
   }
}

Beispiel für eine Fehlerregel

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

OASValidation-Richtlinie

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Ursache
`steps.oasvalidation.Failed`	500	Der Text der Anfragenachricht kann nicht mit der bereitgestellten OpenAPI-Spezifikation validiert werden.
`steps.oasvalidation.SourceMessageNotAvailable`	500	Die im Element `<Source>` der Richtlinie angegebene Variable liegt entweder außerhalb des Gültigkeitsbereichs oder kann nicht aufgelöst werden.
`steps.oasvalidation.NotMessageVariable`	500	Für das `<Source>`-Element ist eine Variable festgelegt, die nicht vom Typ message ist.

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy mit dieser Richtlinie bereitstellen.

Fehlername	Ursache
`ResourceDoesNotExist`	Die OpenAPI-Spezifikation, auf die im Element `<OASResource>` verwiesen wird, ist nicht vorhanden.
`ResourceCompileFailed`	Die in der Bereitstellung enthaltene OpenAPI-Spezifikation enthält Fehler, die verhindern, dass sie kompiliert werden. Dies weist im Allgemeinen darauf hin, dass die Spezifikation keine korrekt formatierte OpenAPI-Spezifikation 3.0 darstellt.
`BadResourceURL`	Die im Element `<OASResource>` angegebene OpenAPI-Spezifikation kann nicht verarbeitet werden. Dieser Fehler kann auftreten, wenn die Datei keine JSON- oder YAML-Datei ist oder die Datei-URL nicht korrekt angegeben wurde.

Fehlervariablen

Diese Variablen werden festgelegt, wenn diese Richtlinie zur Laufzeit einen Fehler auslöst. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "ResourceDoesNotExist"`
`oasvalidation.policy_name.failed`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`oasvalidation.myoaspolicy.failed = true`

PopulateCache-Richtlinie

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Tritt auf, wenn Folgendes eintritt
`policies.populatecache.EntryCannotBeCached`	500	Ein Eintrag kann nicht im Cache gespeichert werden. Das zwischengespeicherte Nachrichtenobjekt ist keine Instanz eines die serialisierbar ist.

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy bereitstellen, der diese Richtlinie enthält.

Fehlername	Ursache	Beheben
`InvalidCacheResourceReference`	Dieser Fehler tritt auf, wenn das `<CacheResource>`-Element in der fillCache-Richtlinie auf einen Namen, der in der Umgebung, in der der API-Proxy bereitgestellt wird, nicht vorhanden ist.
`CacheNotFound`	Der im Element `<CacheResource>` angegebene Cache ist nicht vorhanden.

Fehlervariablen

Diese Variablen werden festgelegt, wenn die Richtlinie einen Fehler auslöst. Weitere Informationen finden sich unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name = "EntryCannotBeCached"`
`populatecache.policy_name.failed`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`populatecache.POP-CACHE-1.failed = true`

Beispiel für eine Fehlerantwort

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

Beispiel für eine Fehlerregel

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

In diesem Abschnitt werden die Fehlermeldungen und Ablaufvariablen beschrieben, die festgelegt werden, wenn diese Richtlinie einen Fehler auslöst. Dieses Informationen sind wichtig, wenn Sie Fehlerregeln für einen Proxy entwickeln. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen und Fehler beheben.

Fehlercode-Präfix

–

Laufzeitfehler

Diese Richtlinie gibt keine Laufzeitfehler aus.

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy bereitstellen, der diese Richtlinie enthält.

Fehlername	Ursache	Problembehebung
`InvalidCacheResourceReference`	Dieser Fehler tritt auf, wenn für das `<CacheResource>`-Element ein Name festgelegt ist, der in der Umgebung, in der der API-Proxy bereitgestellt wird, nicht vorhanden ist.
`InvalidTimeout`	Wenn das `<CacheLookupTimeoutInSeconds>`-Element auf eine negative Zahl eingestellt ist, schlägt die Bereitstellung des API-Proxys fehl.
`CacheNotFound`	Dieser Fehler tritt auf, wenn der in der Fehlermeldung erwähnte Cache nicht auf einer bestimmten Message Processor-Komponente erstellt wurde.

Fehlervariablen

–

Beispiel für eine Fehlerantwort

–

InvalidateCache-Richtlinie

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

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
`InvalidTimeout`	If the `<CacheLookupTimeoutInSeconds>` element of the ResponseCache policy is set to a negative number, then the deployment of the API proxy fails.
`InvalidCacheResourceReference`	This error occurs if the `<CacheResource>` element in a ResponseCache policy is set to a name that does not exist in the environment where the API proxy is being deployed.
`ResponseCacheStepAttachmentNotAllowedReq`	This error occurs if the same ResponseCache policy is attached to multiple request paths within any flows of an API proxy.
`ResponseCacheStepAttachmentNotAllowedResp`	This error occurs if the same ResponseCache policy is attached to multiple response paths within any flows of an API proxy.
`InvalidMessagePatternForErrorCode`	This error occurs if either the `<SkipCacheLookup>` or the `<SkipCachePopulation>` element in a ResponseCache policy contains an invalid condition.
`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

OAuthV2-Richtlinie

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

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten. Die unten aufgeführten Fehlernamen sind die Strings, die der Variable fault.name zugewiesen sind, wenn ein Fehler auftritt. Weitere Informationen finden Sie unten im Abschnitt "Fehlervariablen".

Fehlercode	HTTP-Status	Ursache
`steps.oauth.v2.access_token_expired`	500	Das an die Richtlinie gesendete Zugriffstoken ist abgelaufen.
`steps.oauth.v2.authorization_code_expired`	500	Der an die Richtlinie gesendete Autorisierungscode ist abgelaufen.
`steps.oauth.v2.invalid_access_token`	500	Das an die Richtlinie gesendete Zugriffstoken ist ungültig.
`steps.oauth.v2.invalid_client-invalid_client_id`	500	Die an die Richtlinie gesendete Client-ID ist ungültig.
`steps.oauth.v2.invalid_refresh_token`	500	Das an die Richtlinie gesendete Aktualisierungstoken ist ungültig.
`steps.oauth.v2.invalid_request-authorization_code_invalid`	500	Der an die Richtlinie gesendete Autorisierungscode ist ungültig.
`steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound`	401	Weitere Informationen zur Fehlerbehebung bei diesem Fehler finden Sie in diesem Apigee Community-Post.
`steps.oauth.v2.refresh_token_expired`	500	Das an die Richtlinie gesendete Aktualisierungstoken ist abgelaufen.

Bereitstellungsfehler

Informationen zu Bereitstellungsfehlern finden Sie in der Benutzeroberfläche, die in der Benutzeroberfläche angezeigt wird.

Fehlervariablen

Diese Variablen werden festgelegt, wenn diese Richtlinie zur Laufzeit einen Fehler auslöst.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "IPDeniedAccess"`
`oauthV2.policy_name.failed`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`oauthV2.GetTokenInfo.failed = true`
`oauthV2.policy_name.fault.name`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`oauthV2.GetToKenInfo.fault.name = invalid_client-invalid_client_id`
`oauthV2.policy_name.fault.cause`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`oauthV2.GetTokenInfo.cause = ClientID is Invalid`

Beispiel für eine Fehlerantwort

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

Beispiel für eine Fehlerregel

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

SetOAuth v2-Informationsrichtlinie

In diesem Abschnitt werden die zurückgegebenen Fehlercodes und Fehlermeldungen beschrieben, die von Edge festgelegt werden, wenn die Richtlinie einen Fehler auslöst. Diese Informationen sind wichtig, wenn Sie Fehlerregeln zur Verarbeitung von Fehlern entwickeln. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen und Fehler beheben.

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Ursache
`steps.oauth.v2.access_token_expired`	500	Das an die Richtlinie gesendete Zugriffstoken ist abgelaufen.
`steps.oauth.v2.invalid_access_token`	500	Das an die Richtlinie gesendete Zugriffstoken ist ungültig.
`steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound`	401	Weitere Informationen zur Fehlerbehebung bei diesem Fehler finden Sie in diesem Apigee Community-Post.

Bereitstellungsfehler

Informationen zu Bereitstellungsfehlern finden Sie in der Benutzeroberfläche, die in der Benutzeroberfläche angezeigt wird.

Fehlervariablen

Diese Variablen werden festgelegt, wenn diese Richtlinie zur Laufzeit einen Fehler auslöst.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name = "invalid_access_token"`
`oauthV2.policy_name.failed`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`oauthV2.SetTokenInfo.failed = true`
`oauthV2.policy_name.fault.name`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`oauthV2.SetTokenInfo.fault.name = invalid_access_token`
`oauthv2.policy_name.fault.cause`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`oauthV2.SetTokenInfo.cause = Invalid Access Token`

Beispiel für eine Fehlerantwort

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

Beispiel für eine Fehlerregel

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

DeleteOAuthV2Info-Richtlinie

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Ursache
`steps.oauth.v2.invalid_access_token`	401	Das an die Richtlinie gesendete Zugriffstoken ist ungültig.
`steps.oauth.v2.invalid_request-authorization_code_invalid`	401	Der an die Richtlinie gesendete Autorisierungscode ist ungültig.
`steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound`	401	Weitere Informationen zur Fehlerbehebung bei diesem Fehler finden Sie in diesem Apigee Community-Post.

Bereitstellungsfehler

Informationen zu Bereitstellungsfehlern finden Sie in der Benutzeroberfläche, die in der Benutzeroberfläche angezeigt wird.

Fehlervariablen

Diese Variablen werden festgelegt, wenn diese Richtlinie zur Laufzeit einen Fehler auslöst.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name = "invalid_access_token"`
`oauthV2.policy_name.failed`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`oauthV2.DeleteTokenInfo.failed = true`
`oauthV2.policy_name.fault.name`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`oauthV2.DeleteTokenInfo.fault.name = invalid_access_token`
`oauthv2.policy_name.fault.cause`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`oauthV2.DeleteTokenInfo.cause = Invalid Access Token`

Beispiel für eine Fehlerantwort

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

Beispiel für eine Fehlerregel

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

OAuthv1.0a-Richtlinie

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

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

DeleteOAuthV1Info-Richtlinie

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

Dieser Abschnitt beschreibt die zurückgegebenen Fehlercodes und Fehlermeldungen sowie die Fehlervariablen die von Edge festgelegt werden, wenn diese Richtlinie einen Fehler auslöst. Diese Informationen sind wichtig, wenn Sie Fehlerregeln zur Verarbeitung von Fehlern entwickeln. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen und Fehler beheben.

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Ursache	Beheben
`steps.script.ScriptEvaluationFailed`	500	Die PythonScript-Richtlinie kann verschiedene Arten von ScriptExecutionFailed-Fehlern auslösen. Häufig auftretende Fehler sind NameError und ZeroDivisionError.

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy bereitstellen, der diese Richtlinie enthält.

Fehlername	Ursache	Beheben
`InvalidResourceUrlFormat`	Wenn das Format der Ressourcen-URL im `<ResourceURL>`-Element oder im `<IncludeURL>`-Element der PythonScript-Richtlinie ungültig ist, schlägt die Bereitstellung des API-Proxys fehl.
`InvalidResourceUrlReference`	Wenn `<ResourceURL>` oder `<IncludeURL>` auf eine PythonScript-Datei verweist, die nicht vorhanden ist, schlägt die Bereitstellung des API-Proxys fehl. Die referenzierte Quelldatei muss entweder in der API-Proxy, der Umgebung oder auf Organisationsebene vorhanden sein.

Fehlervariablen

Diese Variablen werden festgelegt, wenn diese Richtlinie zur Laufzeit einen Fehler auslöst. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "ScriptExecutionFailed"`
`pythonscript.policy_name.failed`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`pythonscript.PythonScript-1.failed = true`

Beispiel für eine Fehlerantwort

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

Beispiel für eine Fehlerregel

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

Kontingentrichtlinie

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Ursache	Beheben
`policies.ratelimit.FailedToResolveQuotaIntervalReference`	500	Tritt auf, wenn das `<Interval>`-Element nicht in der Kontingentrichtlinie definiert ist. Dieses Element ist obligatorisch und wird verwendet, um das Zeitintervall anzugeben, das für das Kontingent gilt. Das Zeitintervall kann Minuten, Stunden, Tage, Wochen oder Monate sein, wie mit dem Element `<TimeUnit>` definiert.
`policies.ratelimit.FailedToResolveQuotaIntervalTimeUnitReference`	500	Tritt auf, wenn das `<TimeUnit>`-Element nicht in der Kontingentrichtlinie definiert ist. Dieses Element ist obligatorisch und wird verwendet, um die Zeiteinheit anzugeben, die für das Kontingent gilt. Das Zeitintervall kann in Minuten, Stunden, Tagen, Wochen oder Monaten angegeben werden.
`policies.ratelimit.InvalidMessageWeight`	500	Tritt auf, wenn der Wert des `<MessageWeight>`-Elements, das über eine Ablaufvariable angegeben wird, ungültig ist (ein ganzzahliger Wert).
`policies.ratelimit.QuotaViolation`	500	Das Kontingentlimit wurde überschritten.	–

Bereitstellungsfehler

Fehlername	Ursache	Beheben
`InvalidQuotaInterval`	Wenn das im `<Interval>`-Element angegebene Kontingentintervall keine Ganzzahl ist, schlägt die Bereitstellung des API-Proxys fehl. Wenn das angegebene Kontingentintervall beispielsweise 0,1 im `<Interval>`-Element lautet, schlägt die Bereitstellung des API-Proxys fehl.
`InvalidQuotaTimeUnit`	Wenn die im `<TimeUnit>`-Element angegebene Zeiteinheit nicht unterstützt wird, schlägt die Bereitstellung des API-Proxys fehl. Die unterstützten Zeiteinheiten sind `minute`, `hour`, `day`, `week` und `month`.
`InvalidQuotaType`	Wenn der Typ des Kontingents, das im `<Quota>`-Attribut des `type`-Attribut angegeben ist, ungültig ist, dann schlägt die Bereitstellung des API-Proxys fehl. Unterstützte Kontingenttypen sind `default`, `calendar`, `flexi` und `rollingwindow`.
`InvalidStartTime`	Wenn das im `<StartTime>`-Element angegebene Zeitformat ungültig ist, schlägt die Bereitstellung des API-Proxys fehl. Das gültige Format ist `yyyy-MM-dd HH:mm:ss`, also das Datums- und Uhrzeitformat ISO 8601. Wenn beispielsweise die im `<StartTime>`-Element angegebene Zeit `7-16-2017 12:00:00` lautet, schlägt die Bereitstellung des API-Proxys fehl.
`StartTimeNotSupported`	Wenn das `<StartTime>`-Element angegeben ist, dessen Kontingenttyp nicht `calendar` ist, schlägt die Bereitstellung des API-Proxys fehl. Das `<StartTime>`-Element wird nur für den `calendar`-Kontingenttyp unterstützt. Wenn beispielsweise für das `type`-Attribut im `<Quota>`-Element der Wert `flexi` oder `rolling window` festgelegt ist, schlägt die Bereitstellung des API-Proxys fehl.
`InvalidTimeUnitForDistributedQuota`	Ist das `<Distributed>`-Element auf `true` und das `<TimeUnit>`-Element auf `second` gesetzt, so schlägt die Bereitstellung des API-Proxys fehl. Die Zeiteinheit `second` ist für verteilte Kontingente unzulässig.
`InvalidSynchronizeIntervalForAsyncConfiguration`	Ist der für das Element `<SyncIntervalInSeconds>` im Element `<AsynchronousConfiguration>` in einer Kontingentrichtlinie angegebene Wert kleiner als null, so schlägt die Bereitstellung des API-Proxys fehl.
`InvalidAsynchronizeConfigurationForSynchronousQuota`	Ist in einer Kontingentrichtlinie, in der eine asynchrone Konfiguration mithilfe des Elements `<AsynchronousConfiguration>` vorhanden ist, der Wert des Elements `<AsynchronousConfiguration>` auf `true` gesetzt, so schlägt die Bereitstellung des API-Proxys fehl.

Fehlervariablen

Diese Variablen werden festgelegt, wenn die Richtlinie einen Fehler auslöst. Weitere Informationen finden sich unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "QuotaViolation"`
`ratelimit.policy_name.failed`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`ratelimit.QT-QuotaPolicy.failed = true`

Beispiel für eine Fehlerantwort

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

Beispiel für eine Fehlerregel

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

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
`policies.resetquota.InvalidRLPolicy`	500	The Quota policy specified in the `<Quota>` element of the Reset Quota policy is not defined in the API proxy and thus is not available during the flow. The `<Quota>` element is mandatory and identifies the target Quota policy whose counter should be updated through the Reset Quota policy.
`policies.resetquota.FailedToResolveAllowCountRef`	N/A	The reference to the variable containing the allow count in the `<Allow>` element of the policy cannot be resolved to a value. This element is mandatory and specifies the amount to decrease the quota counter.
`policies.resetquota.FailedToResolveRLPolicy`	500	The variable referenced by the `ref` attribute in the `<Quota>` element cannot be resolved.

Deployment errors

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

Error name	Cause	Fix
`InvalidCount`	If the count value specified in the `<Allow>` element of the Reset Quota Policy is not an integer, then the deployment of the API proxy fails.

RaiseFault-Richtlinie

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
`steps.raisefault.RaiseFault`	500	See fault string.

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 = "RaiseFault"`
`raisefault.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`raisefault.RF-ThrowError.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.raisefault.RaiseFault"
      },
      "faultstring":"Raising fault. Fault name: [name]"
   }
}

RegularExpressionProtection-Richtlinie

This section describes the error codes and messages returned and fault variables set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. If you want to capture an error and raise your own custom error, set the continueOnError="true" attribute on the policy root element. To learn more, see What you need to know about policy errors and Handling faults.

Errors returned from Edge policies follow a consistent format as described in the Error code reference.

Runtime errors

These errors can occur when the policy executes.

Error Code	Message

ExecutionFailed	Failed to execute the RegularExpressionProtection StepDefinition {0}. Reason: {1}
InstantiationFailed	Failed to instantiate the RegularExpressionProtection StepDefinition {0}
NonMessageVariable	Variable {0} does not resolve to a Message
SourceMessageNotAvailable	{0} message is not available for RegularExpressionProtection StepDefinition {1}
ThreatDetected	Regular Expression Threat Detected in {0}: regex: {1} input: {2}
VariableResolutionFailed	Failed to resolve variable {0}

Deployment errors

Error Code	Message	Fix

CannotBeConvertedToNodeset	RegularExpressionProtection {0}: Result of xpath {1} cannot be converted to nodeset. Context {2}
DuplicatePrefix	RegularExpressionProtection {0}: Duplicate prefix {1}
EmptyJSONPathExpression	RegularExpressionProtection {0}: Empty JSONPath expression
EmptyXPathExpression	RegularExpressionProtection {0}: Empty XPath expression
InvalidRegularExpression	RegularExpressionProtection {0}: Invalid Regular Expression {1}, Context {2}
JSONPathCompilationFailed	RegularExpressionProtection {0}: Failed to compile jsonpath {1}. Context {2}
NONEmptyPrefixMappedToEmptyURI	RegularExpressionProtection {0}: Non-empty prefix {1} cannot be mapped to empty uri
NoPatternsToEnforce	RegularExpressionProtection {0}: No patterns to enforce in {1}
NothingToEnforce	RegularExpressionProtection {0}: at least one of URIPath, QueryParam, Header, FormParam, XMLPayload, JSONPayload is mandatory
XPathCompilationFailed	RegularExpressionProtection {0}: Failed to compile xpath {1}. Context {2}

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 table above.	`fault.name Matches "ThreatDetected"`
`regularexpressionprotection.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`regularexpressionprotection.Regular-Expressions-Protection-1.failed = true`

SOAPMessageValidation-Richtlinie

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode HTTP-Status Ursache Problembehebung

steps.messagevalidation.SourceMessageNotAvailable

500

Dieser Fehler tritt bei einer Variablen auf, die im Element <Source> der Richtlinie angegeben ist:

Der Wert liegt außerhalb des Bereichs (ist nicht in dem spezifischen Ablauf verfügbar, in dem die Richtlinie ausgeführt wird)
Der Wert nicht aufgelöst werden kann (nicht definiert ist)

steps.messagevalidation.NonMessageVariable

500

Dieser Fehler tritt auf, wenn für das Element <Source> in der SOAPMessageValidation-Richtlinie eine Variable festgelegt ist, die nicht vom Typ message ist.

Nachrichtentypvariablen stellen ganze HTTP-Anfragen und -Antworten dar. Die integrierten Edge-Flussvariablen request, response und message sind vom Typ „Nachricht“. Weitere Informationen zu Nachrichtenvariablen finden Sie in der Variablenreferenz.

steps.messagevalidation.Failed 500 Dieser Fehler tritt auf, wenn die SOAPMessageValidation-Richtlinie die Eingabe-Nachrichten-Nutzlast nicht gegen das XSD-Schema oder die WSDL-Definition validiert. Sie wird auch angezeigt, wenn die Nutzlastnachricht fehlerhaft formatierte JSON- oder XML-Daten enthält.

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy bereitstellen, der diese Richtlinie enthält.

Fehlername	Ursache	Korrigieren
`InvalidResourceType`	Das Element `<ResourceURL>` in der SOAPMessageValidation-Richtlinie ist auf einen Ressourcentyp festgelegt, der von der Richtlinie nicht unterstützt wird.
`ResourceCompileFailed`	Das Ressourcenskript, auf das im `<ResourceURL>`-Element der SOAPMessageValidation-Richtlinie verwiesen wird, enthält einen Fehler, der die Kompilierung verhindert.
`RootElementNameUnspecified`	Das Element `<Element>` in der SOAPMessageValidation-Richtlinie enthält nicht den Namen des Stammelements.
`InvalidRootElementName`	Das Element `<Element>` in der SOAPMessageValidation-Richtlinie enthält einen Stammelementnamen, der nicht den XML-Regeln für gültige Elementnamen entspricht.

SAMLAssertion-Richtlinie

Dieser Abschnitt beschreibt die Fehlercodes und Fehlermeldungen, die zurückgegeben werden. und Fehlervariablen, die von Edge festgelegt werden, wenn diese Richtlinie einen Fehler auslöst. Diese Informationen sind wichtig, wenn Sie Fehlerregeln zur Verarbeitung von Fehlern entwickeln. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen und Fehler beheben.

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy bereitstellen, der diese Richtlinie enthält.

Fehlername	Ursache	Beheben
`SourceNotConfigured`	Mindestens eines der folgenden Elemente der Richtlinie "SAML-Assertion validieren" ist nicht definiert oder leer: `<Source>`, `<XPath>`, `<Namespaces>`, `<Namespace>`.
`TrustStoreNotConfigured`	Wenn das Element `<TrustStore>` leer oder nicht in der ValidateSAMLAssertion-Richtlinie angegeben ist, schlägt die Bereitstellung des API-Proxys fehl. Ein gültiger Trust Store ist erforderlich.
`NullKeyStoreAlias`	Wenn das untergeordnete Element `<Alias>` leer oder nicht im Element `<Keystore>` der SAML-Assertion-Richtlinie angegeben ist, schlägt die Bereitstellung des API-Proxys fehl. Ein gültiger Keystore-Alias ist erforderlich.
`NullKeyStore`	Wenn das untergeordnete Element `<Name>` leer oder im Element `<Keystore>` der GenerateSAMLAssertion-Richtlinie nicht angegeben ist, schlägt die Bereitstellung des API-Proxys fehl. Ein gültiger Keystore-Name ist erforderlich.
`NullIssuer`	Wenn das Element `<Issuer>` leer oder nicht in der Richtlinie "SAML-Assertion generieren" angegeben ist, schlägt die Bereitstellung des API-Proxys fehl. Bitte geben Sie einen gültigen `<Issuer>`-Wert ein.

Fehlervariablen

Diese Variablen werden bei Laufzeitfehlern festgelegt. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name = "InvalidMediaTpe"`
`GenerateSAMLAssertion.failed`	Bei einer validierten SAML-Assertion-Richtlinienkonfiguration lautet das Fehlerpräfix `ValidateSAMLAssertion`.	`GenerateSAMLAssertion.failed = true`

Beispiel für eine Fehlerantwort

{
  "fault": {
    "faultstring": "GenerateSAMLAssertion[GenSAMLAssert]: Invalid media type",
    "detail": {
      "errorcode": "steps.saml.generate.InvalidMediaTpe"
    }
  }
}

Beispiel für eine Fehlerregel

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

ServiceCallout-Richtlinie

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.servicecallout.ExecutionFailed

500

This error can occur when:

the policy is asked to handle input that is malformed or otherwise invalid.
the backend target service returns an error status (by default, 4xx or 5xx).

steps.servicecallout.RequestVariableNotMessageType 500 The Request variable specified in the policy is not of type Message. For example, if it's a string or other non-message type, you'll see this error.

steps.servicecallout.RequestVariableNotRequestMessageType 500 The Request variable specified in the policy is not of type Request Message. For example, if it's a Response type, you'll see this error.

Deployment errors

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

Error name	Cause	Fix
`URLMissing`	The `<URL>` element inside `<HTTPTargetConnection>` is missing or empty.
`ConnectionInfoMissing`	This error happens if the policy does not have an `<HTTPTargetConnection>` or `<LocalTargetConnection>` element.
`InvalidTimeoutValue`	This error happens if the `<Timeout>` value is negative or 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 = "RequestVariableNotMessageType"`
`servicecallout.policy_name.failed`	`policy_name` is the user-specified name of the policy that threw the fault.	`servicecallout.SC-GetUserData.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.servicecallout.RequestVariableNotMessageType"
      },
      "faultstring":"ServiceCallout[ServiceCalloutGetMockResponse]: 
            request variable data_str value is not of type Message"
   }
}

Example fault rule

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

SpikeArrest-Richtlinie

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Ursache
`policies.ratelimit.FailedToResolveSpikeArrestRate`	`500`	Dieser Fehler tritt auf, wenn der Verweis auf die Variable mit der Preiseinstellung im Element `<Rate>` kann nicht in einen Wert innerhalb des Spike Arrest aufgelöst werden . Dieses Element ist obligatorisch und wird verwendet, um die Spike Arrestrate in Format `intpm` oder `intps`.
`policies.ratelimit.InvalidMessageWeight`	`500`	Dieser Fehler tritt auf, wenn der für das Element `<MessageWeight>` angegebene Wert über eine Ablaufvariable ungültig ist (ein nicht ganzzahliger Wert).
`policies.ratelimit.SpikeArrestViolation`	`429`	Die Ratenbegrenzung wurde überschritten. <ph type="x-smartling-placeholder"> </ph> Hinweis: Für die Private Cloud wird der standardmäßige HTTP-Statuscode `500` zurückgegeben. Legen Sie dieses Attribut mit der API fest, um den an `429` zurückgegebenen Statuscode zu ändern Aufruf, der unter Beispiel für eine Fehlerregel beschrieben wird

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy mit dieser Richtlinie bereitstellen.

Fehlername	Ursache	Korrigieren
`InvalidAllowedRate`	Wenn die Spike Arrest-Rate im Element `<Rate>` der Spike Arrest-Richtlinie keine Ganzzahl ist oder die Rate weder `ps` noch `pm` als Suffix enthält, schlägt die Bereitstellung des API-Proxys fehl.

Fehlervariablen

Diese Variablen werden bei Laufzeitfehlern festgelegt. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "SpikeArrestViolation"`
`ratelimit.policy_name.failed`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`ratelimit.SA-SpikeArrestPolicy.failed = true`

Beispiel für eine Fehlerantwort

Im Folgenden sehen Sie ein Beispiel für eine Fehlerantwort:

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

Beispiel für eine Fehlerregel

Unten sehen Sie ein Beispiel für eine Fehlerregel zum Verarbeiten eines SpikeArrestViolation-Fehlers:

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

Laufzeitfehler

–

Bereitstellungsfehler

Fehlername	Ursache	Korrigieren
`UnsupportedDatatype`	Wird der Typ der Variablen, die durch das Attribut „ref“ im `<Statistic>`-Element der Statistics Collector-Richtlinie festgelegt wurde, nicht unterstützt, so schlägt die Bereitstellung des API-Proxys fehl. Unterstützte Datentypen sind `string`, `integer`, `float`, `long`, `double` und `boolean`.
`InvalidName`	Wenn der Name, der für den Verweis auf die angegebene, im `<Statistic>`-Element der Statistics Collector-Richtlinie definierte Variable verwendet wird, mit einer systemdefinierten Variable in Konflikt steht, so schlägt die Bereitstellung des API-Proxys fehl. Zu den bekannten systemdefinierten Variablen zählen `organization` und `environment`.
`DatatypeMissing`	Fehlt der Typ der Variablen, die durch das Attribut `ref` im `<Statistic>`-Element der Statistics Collector-Richtlinie angegeben wurde, schlägt die Bereitstellung des API-Proxys fehl.

Fehlervariablen

Keine.

VerifyAPIKey-Richtlinie

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Ursache
`keymanagement.service.CompanyStatusNotActive`	401	Das Unternehmen, das mit der Entwickler-App verknüpft ist, die den verwendeten API-Schlüssel besitzt, hat den Status „Inaktiv“. Wenn der Status eines Unternehmens auf „Inaktiv“ gesetzt ist, können Sie nicht auf die mit diesem Unternehmen verknüpften Entwickler oder Apps zugreifen. Ein Organisationsadministrator kann den Status eines Unternehmens mithilfe der Management API ändern. Weitere Informationen finden Sie unter Status eines Unternehmens festlegen.
`keymanagement.service.DeveloperStatusNotActive`	401	Der Entwickler, der die den verwendeten API-Schlüssel besitzende Entwickler-App erstellt hat, hat den Status "Inaktiv". Wird der Status eines App-Entwicklers auf "Inaktiv" gesetzt, werden alle von diesem Entwickler erstellten Entwickler-Apps deaktiviert. Ein Administrator mit entsprechenden Berechtigungen (z. B. ein Organisationsadministrator) kann den Status eines Entwicklers auf folgende Weise ändern: Management API: Entwicklerstatus festlegen Verwaltungs-UI: Unter App-Entwickler registrieren finden Sie eine Anleitung zum Deaktivieren (und Aktivieren) von Entwicklern.
`keymanagement.service.invalid_client-app_not_approved`	401	Die mit dem API-Schlüssel verknüpfte Entwickler-App wird widerrufen. Eine aufgehobene Anwendung kann nicht auf API-Produkte zugreifen und keine von Apigee Edge verwaltete API aufrufen. Ein Organisationsadministrator kann den Status einer Entwickleranwendung mithilfe der Management API ändern. Weitere Informationen finden Sie unter Entwickler-App genehmigen oder widerrufen.
`oauth.v2.FailedToResolveAPIKey`	401	Die Richtlinie erwartet, den API-Schlüssel in einer im <APIKey>-Element der Richtlinie angegebenen Variablen zu finden. Dieser Fehler tritt auf, wenn die erwartete Variable nicht existiert (die Aufgabe kann nicht aufgelöst werden).
`oauth.v2.InvalidApiKey`	401	Ein API-Schlüssel wurde von Edge empfangen, ist aber ungültig. Wenn Edge den Schlüssel in seiner Datenbank sucht, muss er exakt mit dem übereinstimmen, der in der Anfrage gesendet wurde. Wenn die API funktioniert hat, sorgen Sie dafür, dass der Schlüssel nicht neu generiert wurde. Wenn der Schlüssel neu generiert wurde, wird diese Fehlermeldung angezeigt, wenn Sie versuchen, den alten Schlüssel zu verwenden. Weitere Informationen finden Sie unter Apps registrieren und API-Schlüssel verwalten.
`oauth.v2.InvalidApiKeyForGivenResource`	401	Ein API-Schlüssel wurde von Edge empfangen und ist gültig; er stimmt jedoch mit keinem genehmigten Schlüssel in der Entwickler-App überein, die über ein Produkt mit Ihrem API-Proxy verknüpft ist.

Hinweis:Derzeit meldet Edge den Fehler ApiKeyNotApproved nicht genau. Wurde ein Schlüssel nicht genehmigt (sein Status ist "abgelehnt" oder "ausstehend"), so wird stattdessen der Fehler "FailedToResolveAPIKey" ausgegeben. Weitere Informationen und eine mögliche Problemumgehung finden Sie in diesem Beitrag in der Apigee Community.

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy mit dieser Richtlinie bereitstellen.

Fehlername	Ursache
`SpecifyValueOrRefApiKey`	Für das Element `<APIKey>` wurde kein Wert oder Schlüssel angegeben.

Fehlervariablen

Diese Variablen werden bei Laufzeitfehlern festgelegt. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "FailedToResolveAPIKey"`
`oauthV2.policy_name.failed`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`oauthV2.VK-VerifyAPIKey.failed = true`

Beispiele für Fehlerantworten

Hinweis: Bei der Fehlerbehandlung besteht die Best Practice darin, den errorcode-Teil der Fehlerantwort zu beachten. Verlassen Sie sich nicht auf den Text in faultstring. Er kann sich ändern.

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

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

Beispiel für eine Fehlerregel

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

VerifyJWS-Richtlinie

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Tritt auf, wenn Folgendes eintritt
`steps.jws.AlgorithmInTokenNotPresentInConfiguration`	401	Tritt auf, wenn die Prüfungsrichtlinie mehrere Algorithmen nutzt.
`steps.jws.AlgorithmMismatch`	401	Der im Header der Richtlinie „Generate“ angegebene Algorithmus stimmte nicht mit dem in der Richtlinie „Verify“ erwarteten Wert überein. Die angegebenen Algorithmen müssen übereinstimmen.
`steps.jws.ContentIsNotDetached`	401	`<DetachedContent>` wird angegeben, wenn das JWS keine getrennte Inhaltsnutzlast enthält.
`steps.jws.FailedToDecode`	401	Die JWS konnte aufgrund der Richtlinie nicht entschlüsselt werden. Die JWS ist möglicherweise beschädigt.
`steps.jws.InsufficientKeyLength`	401	Für Schlüssel mit weniger als 32 Byte für den HS256-Algorithmus
`steps.jws.InvalidClaim`	401	Bei einem fehlenden Anspruch oder nicht übereinstimmenden Ansprüchen oder einem fehlenden Header oder Header.
`steps.jws.InvalidCurve`	401	Die vom Schlüssel angegebene Kurve ist für den Elliptic-Curve-Algorithmus ungültig.
`steps.jws.InvalidJsonFormat`	401	Ungültige JSON-Datei im JWS-Header
`steps.jws.InvalidJws`	401	Dieser Fehler tritt auf, wenn die JWS-Signaturprüfung fehlschlägt.
`steps.jws.InvalidPayload`	401	Die JWS-Nutzlast ist ungültig.
`steps.jws.InvalidSignature`	401	`<DetachedContent>` wird weggelassen und das JWS hat eine separate Inhaltsnutzlast.
`steps.jws.KeyIdMissing`	401	Die Überprüfungsrichtlinie verwendet eine JWKS als Quelle für öffentliche Schlüssel. Die signierte JWS enthält jedoch keine `kid`-Property im Header.
`steps.jws.KeyParsingFailed`	401	Der öffentliche Schlüssel konnte anhand der angegebenen Schlüsselinformationen nicht geparst werden.
`steps.jws.MissingPayload`	401	Die JWS-Nutzlast fehlt.
`steps.jws.NoAlgorithmFoundInHeader`	401	Tritt auf, wenn der JWS den Algorithmusheader weglässt.
`steps.jws.NoMatchingPublicKey`	401	Die Verifizierungsrichtlinie verwendet einen JWKS als Quelle für öffentliche Schlüssel, aber `kid` im signierten JWS ist nicht in JWKS aufgeführt.
`steps.jws.UnhandledCriticalHeader`	401	Ein Header, der von der JWS-Richtlinie im Header `crit` gefunden wurde, ist nicht in `KnownHeaders` aufgeführt.
`steps.jws.UnknownException`	401	Es ist eine unbekannte Ausnahme aufgetreten.
`steps.jws.WrongKeyType`	401	Falscher Schlüsseltyp angegeben. Wenn Sie beispielsweise einen RSA-Schlüssel für einen Elliptic Curve-Algorithmus oder einen Kurvenschlüssel für einen RSA-Algorithmus angeben.

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy mit dieser Richtlinie bereitstellen.

Fehlername Tritt auf, wenn Folgendes eintritt

InvalidAlgorithm Die einzigen gültigen Werte sind: 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

Andere mögliche Bereitstellungsfehler.

Fehlervariablen

Diese Variablen werden bei Laufzeitfehlern festgelegt. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "TokenExpired"`
`JWS.failed`	Bei allen JWT-Richtlinien wird im Fall eines Fehlers dieselbe Variable festgelegt.	`jws.JWS-Policy.failed = true`

Beispiel für eine Fehlerantwort

Bei der Fehlerbehandlung besteht die Best Practice darin, den errorcode-Teil der Fehlerantwort zu beachten. Verlassen Sie sich nicht auf den Text in faultstring. Er kann sich ändern.

Beispiel für eine Fehlerregel

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

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Tritt auf, wenn Folgendes eintritt
`steps.jwt.AlgorithmInTokenNotPresentInConfiguration`	401	Tritt auf, wenn die Prüfungsrichtlinie mehrere Algorithmen nutzt.
`steps.jwt.AlgorithmMismatch`	401	Der in der Generierungsrichtlinie angegebene Algorithmus stimmte nicht mit dem in der Verifizierungsrichtlinie erwarteten Algorithmus überein. Die angegebenen Algorithmen müssen übereinstimmen.
`steps.jwt.FailedToDecode`	401	Die Richtlinie konnte das JWT nicht decodieren. Das JWT ist möglicherweise beschädigt.
`steps.jwt.GenerationFailed`	401	Die Richtlinie konnte das JWT nicht generieren.
`steps.jwt.InsufficientKeyLength`	401	Für einen Schlüssel mit weniger als 32 Byte beim HS256-Algorithmus, weniger als 48 Byte beim HS386 Algorithmus und weniger als 64 Byte beim HS512-Algorithmus.
`steps.jwt.InvalidClaim`	401	Bei einem fehlenden Anspruch oder nicht übereinstimmenden Ansprüchen oder einem fehlenden Header oder Header.
`steps.jwt.InvalidCurve`	401	Die vom Schlüssel angegebene Kurve ist für den Elliptic-Curve-Algorithmus ungültig.
`steps.jwt.InvalidJsonFormat`	401	Ungültiger JSON-Code im Header oder der Nutzlast gefunden.
`steps.jwt.InvalidToken`	401	Dieser Fehler tritt auf, wenn die JWT-Signaturprüfung fehlschlägt.
`steps.jwt.JwtAudienceMismatch`	401	Der Zielgruppenanspruch ist bei der Tokenprüfung fehlgeschlagen.
`steps.jwt.JwtIssuerMismatch`	401	Der Ausstelleranspruch ist bei der Tokenprüfung fehlgeschlagen.
`steps.jwt.JwtSubjectMismatch`	401	Der Betreffanspruch ist bei der Tokenprüfung fehlgeschlagen.
`steps.jwt.KeyIdMissing`	401	Die Verifizierungsrichtlinie verwendet einen JWKS als Quelle für öffentliche Schlüssel, das signierte JWT enthält jedoch kein `kid`-Attribut im Header.
`steps.jwt.KeyParsingFailed`	401	Der öffentliche Schlüssel konnte anhand der angegebenen Schlüsselinformationen nicht geparst werden.
`steps.jwt.NoAlgorithmFoundInHeader`	401	Tritt auf, wenn das JWT keinen Algorithmus-Header enthält.
`steps.jwt.NoMatchingPublicKey`	401	Die Verifizierungsrichtlinie verwendet einen JWKS als Quelle für öffentliche Schlüssel, aber `kid` im signierten JWT ist nicht in JWKS aufgeführt.
`steps.jwt.SigningFailed`	401	In GenerateJWT, für Schlüssel, die kleiner als die Mindestgröße für den HS384- oder HS512-Algorithmus sind
`steps.jwt.TokenExpired`	401	Die Richtlinie versucht, ein abgelaufenes Token zu bestätigen.
`steps.jwt.TokenNotYetValid`	401	Das Token ist noch nicht gültig.
`steps.jwt.UnhandledCriticalHeader`	401	Ein Header, der von der JWT-Richtlinie im Header `crit` gefunden wurde, ist nicht in `KnownHeaders` aufgeführt.
`steps.jwt.UnknownException`	401	Es ist eine unbekannte Ausnahme aufgetreten.
`steps.jwt.WrongKeyType`	401	Falscher Schlüsseltyp angegeben. Wenn Sie beispielsweise einen RSA-Schlüssel für einen Elliptic Curve-Algorithmus oder einen Kurvenschlüssel für einen RSA-Algorithmus angeben.

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy bereitstellen, der diese Richtlinie enthält.

Fehlername	Ursache	Problembehebung
`InvalidNameForAdditionalClaim`	Die Bereitstellung schlägt fehl, wenn die im untergeordneten Element `<Claim>` des Elements `<AdditionalClaims>` verwendete Anforderung einer der folgenden registrierten Namen ist: `kid`, `iss`, `sub`, `aud`, `iat`, `exp`, `nbf` oder `jti`.
`InvalidTypeForAdditionalClaim`	Wenn die im untergeordneten Element `<Claim>` des `<AdditionalClaims>`-Elements verwendete Anforderung nicht vom Typ `string`, `number`, `boolean` oder `map` ist, schlägt die Bereitstellung fehl.
`MissingNameForAdditionalClaim`	Wenn der Name der Anforderung nicht im untergeordneten Element `<Claim>` des Elements `<AdditionalClaims>` angegeben ist, schlägt die Bereitstellung fehl.
`InvalidNameForAdditionalHeader`	Dieser Fehler tritt auf, wenn der Name der im untergeordneten Element `<Claim>` des `<AdditionalClaims>`-Elements verwendeten Anforderung entweder `alg` oder `typ` ist.
`InvalidTypeForAdditionalHeader`	Wenn der im untergeordneten Element `<Claim>` des `<AdditionalClaims>`-Elements verwendete Anforderungstyp nicht vom Typ `string`, `number`, `boolean` oder `map` ist, schlägt die Bereitstellung fehl.
`InvalidValueOfArrayAttribute`	Dieser Fehler tritt auf, wenn der Wert des Array-Attributs im untergeordneten Element `<Claim>` des `<AdditionalClaims>`-Elements nicht auf `true` oder `false` festgelegt ist.
`InvalidValueForElement`	Wenn der im Element `<Algorithm>` angegebene Wert kein unterstützter Wert ist, schlägt die Bereitstellung fehl.
`MissingConfigurationElement`	Dieser Fehler tritt auf, wenn das Element `<PrivateKey>` nicht mit RSA-Familienalgorithmen oder das Element `<SecretKey>` nicht mit Algorithmen der HS-Familie verwendet wird.
`InvalidKeyConfiguration`	Wenn das untergeordnete Element `<Value>` nicht in den Elementen `<PrivateKey>` oder `<SecretKey>` definiert ist, schlägt die Bereitstellung fehl.
`EmptyElementForKeyConfiguration`	Wenn das ref-Attribut des untergeordneten Elements `<Value>` der Elemente `<PrivateKey>` oder `<SecretKey>` leer oder nicht angegeben ist, schlägt die Bereitstellung fehl.
`InvalidConfigurationForVerify`	Dieser Fehler tritt auf, wenn das Element `<Id>` im Element `<SecretKey>` definiert ist.
`InvalidEmptyElement`	Dieser Fehler tritt auf, wenn das `<Source>`-Element der Verify JWT-Richtlinie leer ist. Falls vorhanden, muss sie mit einem Edge-Flow-Variablennamen definiert werden.
`InvalidPublicKeyValue`	Wenn der im untergeordneten Element `<JWKS>` des Elements `<PublicKey>` verwendete Wert kein gültiges in RFC 7517 angegebenes Format hat, schlägt die Bereitstellung fehl.
`InvalidConfigurationForActionAndAlgorithm`	Wenn das Element `<PrivateKey>` mit HS-Family-Algorithmen oder das `<SecretKey>`-Element mit RSA-Family-Algorithmen verwendet wird, schlägt die Bereitstellung fehl.

Fehlervariablen

Diese Variablen werden bei Laufzeitfehlern festgelegt. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "TokenExpired"`
`JWT.failed`	Bei allen JWT-Richtlinien wird im Fall eines Fehlers dieselbe Variable festgelegt.	`JWT.failed = true`

Beispiel für eine Fehlerantwort

JWT-Richtlinienfehlercodes

Bei der Fehlerbehandlung besteht die Best Practice darin, den errorcode-Teil der Fehlerantwort zu beachten. Verlassen Sie sich nicht auf den Text in faultstring. Er kann sich ändern.

Beispiel für eine Fehlerregel

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

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Ursache
`steps.xmlthreatprotection.ExecutionFailed`	500	Die XMLThreatProtection-Richtlinie kann viele verschiedene Arten von ExecutionFailed-Fehlern auslösen. Die meisten dieser Fehler treten auf, wenn ein bestimmter Schwellenwert in der Richtlinie überschritten wird. Zu diesen Arten von Fehlern gehören: Länge des Elementnamens, Anzahl der untergeordneten Elemente, Knotentiefe, Anzahl der Attribute, Länge des Attributnamens und viele weitere. Die vollständige Liste finden Sie unter XML-Richtlinie zum Schutz vor Bedrohungen – Fehlerbehebung.
`steps.xmlthreatprotection.InvalidXMLPayload`	500	Dieser Fehler tritt auf, wenn die Nutzlast der Eingabenachricht, die durch das Element `<Source>` der XMLThreatProtection-Richtlinie angegeben wurde, kein gültiges XML-Dokument ist.
`steps.xmlthreatprotection.SourceUnavailable`	500	Dieser Fehler tritt auf, wenn für die im Element `<Source>` angegebene Variable message eine der folgenden Aussagen gilt: Der Wert liegt außerhalb des Bereichs (ist nicht in dem spezifischen Ablauf verfügbar, in dem die Richtlinie ausgeführt wird) Sie hat keinen der gültigen Werte `request`, `response` oder `message`.
`steps.xmlthreatprotection.NonMessageVariable`	500	Dieser Fehler tritt auf, wenn das Element `<Source>` auf eine Variable mit einem anderen Typ als message gesetzt ist.

Hinweise:

Der Fehlername "ExecutionFailed" ist der Standardfehlername und wird unabhängig vom Typ des erkannten Fehlers zurückgegeben. Sie können diese Standardeinstellung jedoch durch Festlegen eines Attributs auf Organisationsebene ändern. Wenn dieses Attribut festgelegt wird, spiegelt der Fehlername den tatsächlichen Fehler wider. Beispiel: "TextExceeded" oder "AttrValueExceeded". Weitere Informationen finden Sie unter Nutzungshinweise.
Der HTTP-Status 500 ist die Standardeinstellung. Der HTTP-Status kann jedoch durch Festlegen eines Attributs auf Organisationsebene in 400 für Anfrageflussfehler geändert werden. Weitere Informationen finden Sie unter Nutzungshinweise.

Bereitstellungsfehler

–

Fehlervariablen

Diese Variablen werden bei Laufzeitfehlern festgelegt. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name Matches "SourceUnavailable"`
`xmlattack.policy_name.failed`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`xmlattack.XPT-SecureRequest.failed = true`

Beispiel für eine Fehlerantwort

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

Beispiel für eine Fehlerregel

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

Laufzeitfehler

Diese Fehler können bei Ausführung der Richtlinie auftreten.

Fehlercode	HTTP-Status	Ursache
`steps.xmltojson.ExecutionFailed`	500	Dieser Fehler tritt auf, wenn die Eingabenutzlast (XML) leer ist oder die Eingabe-XML ungültig oder fehlerhaft ist.
`steps.xmltojson.InCompatibleType`	500	Dieser Fehler tritt auf, wenn der Typ der im Element `<Source>` definierten Variable und das Element `<OutputVariable>` nicht identisch sind. Der Typ der im Element `<Source>` enthaltenen Variablen muss mit dem Typ der im Element `<OutputVariable>` enthaltenden Variable übereinstimmen.
`steps.xmltojson.InvalidSourceType`	500	Dieser Fehler tritt auf, wenn der Typ der Variablen zum Definieren des Elements `<Source>` ungültig ist. Gültige Variablentypen sind "message" und "string".
`steps.xmltojson.OutputVariableIsNotAvailable`	500	Dieser Fehler tritt auf, wenn die im `<Source>`-Element der XML-zu-JSON-Richtlinie angegebene Variable den Typ "String" aufweist und das Element `<OutputVariable>` nicht definiert ist. Das Element `<OutputVariable>` ist obligatorisch, wenn die im Element `<Source>` definierte Variable vom Typ "String" ist.
`steps.xmltojson.SourceUnavailable`	500	Dieser Fehler tritt auf, wenn die im Element `<Source>` der XML-zu-JSON-Richtlinie angegebene Variable message entweder: außerhalb des Geltungsbereichs (nicht in dem spezifischen Ablauf verfügbar, in dem die Richtlinie ausgeführt wird) oder Kann nicht aufgelöst werden (nicht definiert)

Bereitstellungsfehler

Diese Fehler können auftreten, wenn Sie einen Proxy bereitstellen, der diese Richtlinie enthält.

Fehlername	Ursache	Beheben
`EitherOptionOrFormat`	Ist eines der Elemente `<Options>` oder `<Format>` in der "XML-to-JSON"-Richtlinie nicht deklariert, schlägt die Bereitstellung des API-Proxys fehl.
`UnknownFormat`	Wenn für das Element `<Format>` in der "XML-to-JSON"-Richtlinie ein unbekanntes Format definiert ist, schlägt die Bereitstellung des API-Proxys fehl. Vordefinierte Formate sind: `xml.com`, `yahoo`, `google` und `badgerFish`.

Fehlervariablen

Diese Variablen werden bei Laufzeitfehlern festgelegt. Weitere Informationen finden Sie unter Was Sie über Richtlinienfehler wissen müssen.

Variablen	Wo	Beispiel
`fault.name="fault_name"`	`fault_name` ist der Name des Fehlers, der in der obigen Tabelle Laufzeitfehler aufgeführt ist. Der Fehlername ist der letzte Teil des Fehlercodes.	`fault.name = "SourceUnavailable"`
`xmltojson.policy_name.failed`	`policy_name` ist der benutzerdefinierte Name der Richtlinie, die den Fehler ausgelöst hat.	`xmltojson.XMLtoJSON-1.failed = true`

Beispiel für eine Fehlerantwort

{
  "fault": {
    "faultstring": "XMLToJSON[XMLtoJSON-1]: Source xyz is not available",
    "detail": {
      "errorcode": "steps.xml2json.SourceUnavailable"
    }
  }
}

Beispiel für eine Fehlerregel

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

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.