ポリシーエラー リファレンス

Access Control ポリシー

このセクションでは、このポリシーでエラーが発生したときに返される障害コードとエラー メッセージ、Edge によって設定される障害変数について説明します。これは、障害を処理するルールを作成する際に重要な情報となります。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

ポリシーの実行時に次のエラーが発生することがあります。

デプロイエラー

このポリシーを含むプロキシのデプロイで、次のエラーが発生することがあります。

障害変数

ランタイム エラーが発生すると、次の変数が設定されます。詳しくは、ポリシーエラーに固有の変数をご覧ください。

障害レスポンスの例

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

障害ルールの例

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

Access Entity ポリシー

関連情報については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

なし

デプロイエラー

Assign Message ポリシー

このセクションでは、このポリシーによってエラーが発生したときに返される障害コードとエラー メッセージ、Edge によって設定される障害変数について説明します。この情報は、障害に対処するための障害ルールを作成するうえで重要です。詳しくは、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

実行時のエラー

これらのエラーは、ポリシーの実行時に発生する可能性があります。

デプロイエラー

これらのエラーは、このポリシーを含むプロキシをデプロイするときに発生する可能性があります。

障害変数

以下の変数は、実行時にこのポリシーによりエラーが発生したときに設定されます。詳しくは、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

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

障害ルールの例

    <faultrule name="VariableOfNonMsgType"></faultrule><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>
    

Basic Authentication ポリシー

このセクションでは、このポリシーでエラーをトリガーしたときに返される障害コードおよびエラー メッセージと、Edge によって設定される障害変数について説明します。これは、エラーを処理する障害ルールを開発するために知っておくべき重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

これらのエラーは、ポリシーの実行時に発生することがあります。

デプロイエラー

このポリシーを含むプロキシをデプロイすると、次のエラーが発生することがあります。

障害変数

これらの変数は、実行時エラーが発生したときに設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

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

障害ルールの例

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

Concurrent Rate Limit ポリシー

このセクションでは、このポリシーによってエラーが発生したときに返される障害コードとエラー メッセージ、Edge によって設定される障害変数について説明します。これは、エラーに対処する障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

ポリシーの実行時に、以下のエラーが発生することがあります。

デプロイエラー

障害変数

以下の変数は、このポリシーによりエラーが発生したときに設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

レート制限を超えた場合、ポリシーは HTTP ステータス 503 のみをクライアントに返します。

障害ルールの例

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

Decode JWS ポリシー

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.

Deployment errors

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

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error response

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.

Example fault rule

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

Decode JWT ポリシー

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.

Deployment errors

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

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error response

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.

Example fault rule

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

Extract Variables ポリシー

このセクションでは、このポリシーによってエラーが発生したときに返される障害コードとエラー メッセージ、Edge によって設定される障害変数について説明します。これは、障害に対処する障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

ポリシーの実行時に、以下のエラーが発生することがあります。

デプロイエラー

このポリシーを含むプロキシをデプロイすると、次のエラーが発生することがあります。

障害変数

以下の変数は、このポリシーにより実行時にエラーが発生したときに設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

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

障害ルールの例

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

Generate JWS ポリシー

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.

Deployment errors

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

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error response

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.

Example fault rule

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

Generate JWT ポリシー

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.

Deployment errors

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

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error response

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.

Example fault rule

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

Java Callout ポリシー

このセクションでは、このポリシーによってエラーが発生したときに返される障害コードとエラー メッセージ、Edge によって設定される障害変数について説明します。これは、障害に対処する障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

以下のエラーは、ポリシー実行時に発生する可能性があるものです。

デプロイエラー

以下のエラーは、ポリシーを含んだプロキシがデプロイされた場合に発生する可能性があります。

障害変数

以下の変数は、このポリシーからエラーが発生したときに設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

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

障害ルールの例

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

JavaScript ポリシー

このセクションでは、このポリシーでエラーをトリガーしたときに返される障害コードとエラー メッセージ、そして Edge によって設定される障害変数について説明します。これは、障害に対処する障害ルールを作成する上で重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

ポリシーの実行時に、以下のエラーが発生することがあります。

デプロイエラー

このポリシーを含むプロキシをデプロイすると、次のエラーが発生することがあります。

障害変数

このポリシーがランタイム時にエラーのトリガーとなった場合は、次の変数が設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

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

障害ルールの例

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

JSON Threat Protection ポリシー

このセクションでは、このポリシーによってエラーが発生したときに返される障害コードとエラー メッセージ、Edge によって設定される障害変数について説明します。これは、障害に対処する障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

ポリシーの実行時に、以下のエラーが発生することがあります。

デプロイエラー

なし。

障害変数

以下の変数は、このポリシーによりエラーが発生したときに設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

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

障害ルールの例

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

JSONThreatProtection ポリシータイプでは、次のエラーコードを定義します。

JSON to XML ポリシー

このセクションでは、このポリシーがトリガーとなってエラーが発生したときに、返される障害コードとエラー メッセージ、Edge によって設定される障害変数について説明します。これは、障害に対処する障害ルールを作成する上で重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

これらのエラーは、ポリシーの実行時に発生することがあります。

デプロイエラー

なし

障害変数

これらの変数は、ランタイム エラーが発生したときに設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

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

障害ルールの例

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

Key Value Map Operations ポリシー

このセクションでは、このポリシーがトリガーとなってエラーが発生したときに返される障害コードとエラー メッセージ、そして Edge によって設定される障害変数について説明します。これは、障害に対処する障害ルールを作成する上で重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

ポリシーの実行時に、以下のエラーが発生することがあります。

デプロイエラー

このポリシーを含むプロキシをデプロイすると、次のエラーが発生することがあります。

LDAP ポリシー

このポリシーでは、以下のエラーコードを使います。

Message Logging ポリシー

このセクションでは、このポリシーがトリガーとなってエラーが発生したときに、返される障害コードとエラー メッセージ、Edge によって設定される障害変数について説明します。これは障害に対処する障害ルールを作成する上で重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

ポリシーの実行時に、以下のエラーが発生することがあります。

デプロイエラー

このポリシーを含むプロキシをデプロイするときに、以下のエラーが発生することがあります。

障害変数

以下の変数は、ランタイム エラーが発生したときに設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

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

障害ルールの例

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

OASValidation ポリシー

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.

Deployment errors

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

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.

Populate Cache ポリシー

このセクションでは、このポリシーがトリガーとなってエラーが発生したときに、返される障害コードとエラー メッセージ、Edge によって設定される障害変数について説明します。これは障害に対処する障害ルールを作成する上で重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

ポリシーの実行時に、以下のエラーが発生することがあります。

デプロイエラー

このポリシーを含むプロキシをデプロイするときに、以下のエラーが発生することがあります。

障害変数

以下の変数は、このポリシーがトリガーとなってエラーが発生したときに設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

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

障害ルールの例

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

Lookup Cache ポリシー

このセクションでは、このポリシーでエラーが発生したときに設定されるエラー メッセージとフロー変数について説明します。これは、プロキシの障害ルールを作成する際に重要な情報となります。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

エラーコードのプレフィックス

なし

ランタイム エラー

このポリシーでランタイム エラーは発生しません。

デプロイエラー

このエラーは、このポリシーを含むプロキシをデプロイするときに発生する可能性があります。

障害変数

なし

エラー レスポンスの例

なし

Invalidate Cache ポリシー

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.

Fault variables

N/A

Example error response

N/A

Response Cache ポリシー

このセクションでは、このポリシーがトリガーとなってエラーが発生すると設定される、エラー メッセージとフロー変数について説明します。これは、プロキシの障害ルールを作成する上で重要な情報です。詳しくは、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

エラーコードの接頭辞

なし

ランタイム エラー

このポリシーはランタイム エラーをスローしません。

デプロイエラー

このポリシーを含むプロキシをデプロイすると、次のエラーが発生することがあります。

障害変数

なし

エラー レスポンスの例

なし

OAuthV2 ポリシー

このセクションでは、このポリシーがトリガーとなってエラーが発生したときに返される障害コードとエラー メッセージ、そして Edge によって設定される障害変数について説明します。これは、障害に対処する障害ルールを作成する上で重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

ポリシーの実行時に、以下のエラーが発生することがあります。

デプロイエラー

このポリシーを含むプロキシをデプロイすると、次のエラーが発生することがあります。

障害変数

このポリシーがランタイム時にエラーのトリガーとなった場合は、次の変数が設定されます。

エラー レスポンスの例

<GenerateResponse> 要素が true に設定されている場合、以下の応答がクライアントに返されます。

<GenerateResponse> が true に設定されている場合、トークンとコードを生成するオペレーションで次の形式のエラーが返されます。完全な一覧については、OAuth HTTP エラー レスポンス リファレンスをご覧ください。

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

<GenerateResponse> が true に設定されている場合、確認オペレーションや検証オペレーションで次の形式のエラーが返されます。完全な一覧については、OAuth HTTP エラー レスポンス リファレンスをご覧ください。

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

障害ルールの例

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

Get OAuthV2 Info ポリシー

このセクションでは、このポリシーによってエラーが発生したときに返される障害コードとエラー メッセージ、Edge によって設定される障害変数について説明します。これは、障害に対処する障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

以下のエラーは、ポリシー実行時に発生する可能性があるものです。下記のエラー名は、エラー発生時に fault.name 変数に設定される文字列です。詳細については、下記の Fault 変数のセクションをご覧ください。

デプロイエラー

デプロイエラーについては、UI に表示されたメッセージをご覧ください。

障害変数

以下の変数は、このポリシーにより実行時にエラーが発生したときに設定されます。

エラー レスポンスの例

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

障害ルールの例

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

Set OAuthV2 Info ポリシー

このセクションでは、このポリシーによってエラーが発生したときに返される障害コードとエラー メッセージ、Edge によって設定される障害変数について説明します。これは、障害に対処する障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

ポリシーの実行時に、以下のエラーが発生することがあります。

デプロイエラー

デプロイエラーについては、UI に表示されたメッセージをご覧ください。

障害変数

以下の変数は、このポリシーにより実行時にエラーが発生したときに設定されます。

エラー レスポンスの例

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

障害ルールの例

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

Delete OAuthV2 Info ポリシー

このセクションでは、このポリシーでエラーが発生したときに返される障害コードとエラー メッセージ、Edge によって設定される障害変数について説明します。これは、障害を処理するルールを作成する際に重要な情報となります。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

このエラーは、ポリシーの実行時に発生する可能性があります。

デプロイエラー

デプロイエラーについては、UI に表示されたメッセージをご覧ください。

障害変数

以下の変数は、このポリシーでランタイム エラーが発生したときに設定されます。

エラー レスポンスの例

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

障害ルールの例

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

OAuth v1.0a ポリシー

OAuthV1 のポリシータイプは、以下のエラーコードを定義します。

OAuth 関連の HTTP エラーコードについては、OAuth HTTP エラー レスポンス リファレンスをご覧ください。

Get OAuthV1 Info ポリシー

Get OAuth v1.0a Info ポリシーに指定されたエラーコードはありません。

Delete OAuthV1 Info ポリシー

成功すると、ポリシーは 200 ステータスを返します。

失敗すると、ポリシーは 404 と次のような出力を返します。出力は削除対象（アクセス トークン、リクエスト トークン、検証コード）によって異なります。

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

    

Python Script ポリシー

Python Script ポリシーに指定されているエラーコードはありません。

Quota ポリシー

このセクションでは、このポリシーがトリガーとなってエラーが発生したときに返される障害コードとエラー メッセージ、そして Edge によって設定される障害変数について説明します。これは、障害に対処する障害ルールを作成する上で重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

ポリシーの実行時に、以下のエラーが発生することがあります。

デプロイエラー

障害変数

このポリシーがトリガーとなってエラーが発生した場合は、次の変数が設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

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

障害ルールの例

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

Reset Quota ポリシー

Reset Quota ポリシータイプは、以下のエラーコードを定義します。エラー処理の手順については、障害の処理をご覧ください。

Raise Fault ポリシー

このセクションでは、このポリシーによってエラーが発生したときに返される障害コードとエラー メッセージ、Edge によって設定される障害変数について説明します。これは、障害に対処する障害ルールを作成するうえで重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

ポリシーの実行時に、以下のエラーが発生することがあります。

デプロイエラー

なし。

障害変数

以下の変数は、ランタイム エラーが発生したときに設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

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

障害ルールの例

    <FaultRule name="RaiseFault">
        <Step>
            <Name>RF-ThrowError</Name>
            <Condition>(fault.name Matches "RaiseFault") </Condition>
        </Step>
    </FaultRule>
    

Regular Expression Protection ポリシー

RegularExpressionProtection ポリシータイプは、以下のエラーコードを定義します。エラーをキャプチャして独自のカスタムエラーを発生させる場合は、ポリシールート要素の continueOnError="true" 属性を設定します。詳細については障害の処理をご覧ください。

SOAP Message Validation ポリシー

このポリシーは、エラー レスポンスで次のエラーコードとエラー メッセージを返します。エラー処理の手順については、エラー処理をご覧ください。

InvalidResourceType MessageValidation {0}: Invalid Resource Type {1}.
    It should be xsd or wsdl. Context {2}

ResourceCompileFailed MessageValidation {0}: Failed to compile resource
    {1}. Context {2}

RootElementNameUnspecified MessageValidation {0}: RootElement name is
    not specified

InvalidRootElementName MessageValidation {0}: RootElement name {1} is
    invalid

NonMessageVariable Variable {0} does not resolve to a Message

SourceMessageNotAvailable {0} message is not available for
    MessageValidation: {1}

Resource "{0}" has no element definitions

MessageValidation {0} failed with reason: "{1}"

SAML Assertion ポリシー

SAML Assertion ポリシーに固有のエラーコードはありません。

Service Callout ポリシー

このセクションでは、このポリシーでエラーをトリガーしたときに返される障害コードおよびエラー メッセージと、Edge によって設定される障害変数について説明します。この情報は、障害に対処するための障害ルールを作成するうえで重要です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

これらのエラーは、ポリシーの実行時に発生することがあります。

デプロイエラー

このポリシーを含むプロキシをデプロイすると、次のエラーが発生することがあります。

障害変数

これらの変数は、実行時エラーが発生したときに設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

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

障害ルールの例

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

Spike Arrest ポリシー

このセクションでは、このポリシーがトリガーとなってエラーが発生したときに返される障害コードとエラー メッセージ、そして Edge によって設定される障害変数について説明します。これは、障害に対処する障害ルールを作成する上で重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

ポリシーの実行時に、以下のエラーが発生することがあります。

デプロイエラー

このポリシーを含むプロキシをデプロイすると、次のエラーが発生することがあります。

障害変数

以下の変数は、ランタイム エラーが発生したときに設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

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

障害ルールの例

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

Statistics Collector ポリシー

このセクションでは、このポリシーがトリガーとなってエラーが発生すると設定される、エラー メッセージとフロー変数について説明します。これは、プロキシの障害ルールを作成する上で重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

なし

デプロイエラー

障害変数

なし

Verify API Key ポリシー

このセクションでは、このポリシーでエラーが発生したときに返される障害コードとエラー メッセージ、Edge によって設定される障害変数について説明します。これは、障害を処理するルールを作成する際に重要な情報となります。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

ポリシーの実行時に次のエラーが発生することがあります。

デプロイエラー

このポリシーを含むプロキシのデプロイで、次のエラーが発生することがあります。

障害変数

ランタイム エラーが発生すると、次の変数が設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

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

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

障害ルールの例

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

Verify JWS ポリシー

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.

Deployment errors

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

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error response

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.

Example fault rule

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

Verify JWT ポリシー

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.

Deployment errors

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

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error response

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.

Example fault rule

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

XML Threat Protection ポリシー

このセクションでは、このポリシーでエラーが発生したときに返される障害コードとエラー メッセージ、Edge によって設定される障害変数について説明します。これは、障害を処理するルールを作成する際に重要な情報となります。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

ポリシーの実行時に次のエラーが発生することがあります。

* 注:

• デフォルトのエラー名は ExecutionFailed です。検出されたエラーの種類に関係なく、このエラーが返されます。ただし、組織レベルのプロパティを設定すると、このデフォルト名を変更できます。このプロパティを設定すると、実際のエラーを反映した名前が使用されます。たとえば、TextExceeded や AttrValueExceeded などが使用されます。詳しくは、「使用上の注意」をご覧ください。
• 500 HTTP ステータスがデフォルトですが、組織レベルのプロパティを設定すると、リクエスト フローエラーの HTTP ステータスを 400 に変更できます。詳しくは、「使用上の注意」をご覧ください。

デプロイエラー

なし

障害変数

ランタイム エラーが発生すると、次の変数が設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

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

障害ルールの例

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

XML to JSON ポリシー

このセクションでは、このポリシーがトリガーとなってエラーが発生したときに、返される障害コードとエラー メッセージ、Edge によって設定される障害変数について説明します。これは、障害に対処する障害ルールを作成する上で重要な情報です。詳細については、ポリシーエラーについて知っておくべきことと障害の処理をご覧ください。

ランタイム エラー

これらのエラーは、ポリシーの実行時に発生することがあります。

デプロイエラー

これらのエラーは、このポリシーを含むプロキシをデプロイするときに発生することがあります。

障害変数

これらの変数は、ランタイム エラーが発生したときに設定されます。詳細については、ポリシーエラーについて知っておくべきことをご覧ください。

エラー レスポンスの例

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

障害ルールの例

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

XSL Transform ポリシー

XSLT ポリシータイプは、以下のエラーコードを定義します（数字は実行時に挿入される値のプレースホルダを表します）。