riseFault की नीति

आपको Apigee Edge दस्तावेज़ दिख रहा है.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इस पेज पर जाएं Apigee X दस्तावेज़. जानकारी

क्या

किसी गड़बड़ी की स्थिति में पसंद के मुताबिक मैसेज जनरेट करता है. riseFault का इस्तेमाल करके किसी खास स्थिति के आने पर, अनुरोध करने वाले ऐप्लिकेशन को गड़बड़ी वाला रिस्पॉन्स मिलता है.

गड़बड़ियों को ठीक करने के बारे में सामान्य जानकारी के लिए, गड़बड़ियां ठीक करना देखें.

सैंपल

<RaiseFault name="404">
 <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
 <FaultResponse>
   <Set>
     <StatusCode>404</StatusCode>
     <ReasonPhrase>The resource requested was not found</ReasonPhrase>
   </Set>
 </FaultResponse>
</RaiseFault>

<RaiseFault name="ExceptionHandler">
 <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
 <FaultResponse>
   <Set>
     <Payload contentType="text/xml">
       <root>Please contact support@company.com</root>
     </Payload>
     <StatusCode>{response.status.code}</StatusCode>
     <ReasonPhrase>Server error</ReasonPhrase>
   </Set>
   <Add>
     <Headers>
       <Header name="FaultHeader">{fault.name}</Header>
     </Headers>
   </Add>
 </FaultResponse>
</RaiseFault>

RaiseFault की नीति के बारे में जानकारी

Apigee Edge की मदद से, RaiseFault टाइप की नीति का इस्तेमाल करके, अपवाद के तौर पर सेट किए गए कस्टम इवेंट को मैनेज किया जा सकता है. RaiseFault की नीति, assignMessage की नीति, आपको किसी गड़बड़ी की स्थिति के जवाब में, ज़रूरत के हिसाब से गड़बड़ी का रिस्पॉन्स जनरेट करने की सुविधा देता है.

अनुरोध करने वाले ऐप्लिकेशन को गड़बड़ी का जो रिस्पॉन्स मिलता है उसके बारे में बताने के लिए, RaiseFault की नीति का इस्तेमाल करें जब गड़बड़ी की कोई खास स्थिति पैदा हो. गड़बड़ी के रिस्पॉन्स में एचटीटीपी हेडर, क्वेरी शामिल हो सकती है पैरामीटर और मैसेज पेलोड. गड़बड़ी के मुताबिक कस्टम रिस्पॉन्स, ऐप्लिकेशन डेवलपर के लिए ज़्यादा काम का हो सकता है और ऐप्लिकेशन के असली उपयोगकर्ताओं की तुलना, सामान्य गड़बड़ी के मैसेज या एचटीटीपी रिस्पॉन्स कोड से की जाती है.

लागू किए जाने के बाद, RaiseFault नीति, कंट्रोल को मौजूदा फ़्लो से गड़बड़ी पर ट्रांसफ़र कर देती है फ़्लो की मदद से, अनुरोध करने वाले क्लाइंट ऐप्लिकेशन को गड़बड़ी का सही रिस्पॉन्स भेजा जाता है. जब मैसेज फ़्लो, गड़बड़ी के फ़्लो में स्विच हो जाता है. साथ ही, नीति को और प्रोसेस नहीं किया जाएगा. बाकी सभी इसमें प्रोसेस की प्रोसेस के चरणों को बायपास किया जाता है. इसके बाद, गलती से मिले रिस्पॉन्स को सीधे अनुरोध वाले पेज पर भेज दिया जाता है है.

ProxyEndpoint या TargetEndpoint में RaiseFault का इस्तेमाल किया जा सकता है. आम तौर पर, आपको शर्त को शिकायत करने से जुड़ी नीति. RaiseFault के लागू होने के बाद, Apigee सामान्य तरीके से काम करेगा प्रोसेसिंग में गड़बड़ी अगर कोई गड़बड़ी नियम तय नहीं किया गया है या कोई गड़बड़ी नियम तय नहीं किया गया है, तो यह प्रोसेस बंद कर देता है विकल्प मौजूद है.

एलिमेंट का रेफ़रंस

एलिमेंट का रेफ़रंस, RaiseFault की नीति में शामिल एलिमेंट और एट्रिब्यूट के बारे में बताता है.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<RaiseFault async="false" continueOnError="false" enabled="true" name="Raise-Fault-1">
    <DisplayName>RaiseFault 1</DisplayName>
    <FaultResponse>
        <AssignVariable>
          <Name/>
          <Value/>
        </AssignVariable>
        <Add>
            <Headers/>
        </Add>
        <Copy source="request">
            <Headers/>
            <StatusCode/>
            <ReasonPhrase/>
        </Copy>
        <Remove>
            <Headers/>
        </Remove>
        <Set>
            <Headers/>
            <Payload/>
            <ReasonPhrase/>
            <StatusCode/>
        </Set>
    </FaultResponse>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</RaiseFault>

<RaiseFault> एट्रिब्यूट

<RaiseFault async="false" continueOnError="false" enabled="true" name="Raise-Fault-1">

The following table describes attributes that are common to all policy parent elements:

<DisplayName> element

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, natural-language name.

<DisplayName>Policy Display Name</DisplayName>

&lt;IgnoreUnresolvedVariables&gt; एलिमेंट

(ज़रूरी नहीं) फ़्लो में वैरिएबल की ऐसी किसी भी गड़बड़ी को अनदेखा करता है जिसे ठीक नहीं किया गया है. मान्य वैल्यू: सही/गलत. डिफ़ॉल्ट true.

&lt;FaultResponse&gt; एलिमेंट

(ज़रूरी नहीं) यह अनुरोध करने वाले क्लाइंट को भेजे गए जवाब के मैसेज के बारे में बताता है. FaultResponse का इस्तेमाल वही सेटिंग जो assignMessage नीति की हैं (प्राइवेट क्लाउड के लिए Apigee Edge में उपलब्ध नहीं).

&lt;FaultResponse&gt;&lt;AssignVariable&gt; एलिमेंट

यह फ़ंक्शन किसी डेस्टिनेशन फ़्लो वैरिएबल के लिए वैल्यू असाइन करता है. अगर फ़्लो वैरिएबल मौजूद नहीं है, तो AssignVariable इसे बनाता है.

उदाहरण के लिए, myFaultVar नाम का वैरिएबल सेट करने के लिए, इस कोड का इस्तेमाल करें के लिए:

<FaultResponse>
  <AssignVariable>
    <Name>myFaultVar</Name>
    <Value>42</Value>
  </AssignVariable>
  ...
</FaultResponse>

इसके बाद, उस वैरिएबल को बाद में RaiseFault नीति में जाकर मैसेज टेंप्लेट में देखा जा सकता है. साथ ही, FaultRule से जुड़ी नीति, वैरिएबल को ऐक्सेस कर सकती है. उदाहरण के लिए, निम्न PendingMessage नीति, RaiseFault में सेट किए गए वैरिएबल का इस्तेमाल हेडर को सेट करने के लिए करती है गड़बड़ी का जवाब:

<AssignMessage enabled="true" name="Assign-Message-1">
  <Add>
    <Headers>
      <Header name="newvar">{myFaultVar}</Header>
    </Headers>
  </Add>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
  <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

riseFault नीति में मौजूद <AssignVariable> में उसी सिंटैक्स का इस्तेमाल किया गया है जो AssignmentMessage नीति में <AssignVariable> एलिमेंट. ध्यान दें कि इस सुविधा के लिए फ़िलहाल, प्राइवेट क्लाउड के लिए Apigee Edge में उपलब्ध नहीं है.

&lt;FaultResponse&gt;&lt;Add&gt;/&lt;Headers&gt; एलिमेंट

गड़बड़ी के मैसेज में एचटीटीपी हेडर जोड़ता है. ध्यान दें कि खाली हेडर <Add><Headers/></Add> कोई हेडर नहीं जोड़ता. यह उदाहरण के तौर पर, request.user.agent फ़्लो वैरिएबल की वैल्यू को हेडर.

<Add>
    <Headers>
        <Header name="user-agent">{request.user.agent}</Header>
    </Headers>
</Add>

&lt;FaultResponse&gt;&lt;Copy&gt; एलिमेंट

इसके ज़रिए बताए गए मैसेज से जानकारी कॉपी करता है source एट्रिब्यूट की वैल्यू को है.

    <Copy source="request">
        <Headers/>
        <StatusCode/>
        <ReasonPhrase/>
    </Copy>

विशेषताएं

 <Copy source="response">

&lt;FaultResponse&gt;&lt;Copy&gt;/&lt;Headers&gt; एलिमेंट

बताए गए एचटीटीपी हेडर को सोर्स से गड़बड़ी के मैसेज में कॉपी करता है. सभी हेडर कॉपी करने के लिए, <Copy><Headers/></Copy>. तय करें

<Copy source='request'>
    <Headers>      
        <Header name="headerName"/>
    </Headers> 
</Copy>

अगर एक ही नाम वाले कई हेडर हैं, तो नीचे दिया गया सिंटैक्स इस्तेमाल करें:

<Copy source='request'>
    <Headers>
      <Header name="h1"/>
      <Header name="h2"/>
      <Header name="h3.2"/>
    </Headers>
</Copy>

इस उदाहरण में "h1", "h2", और "h3" की दूसरी वैल्यू कॉपी की गई है. अगर "h3" है में केवल एक है मान है, तो इसकी कॉपी नहीं की जाती है.

&lt;FaultResponse&gt;&lt;Copy&gt;/&lt;StatusCode&gt; एलिमेंट

सोर्स एट्रिब्यूट के दिए गए ऑब्जेक्ट से गड़बड़ी में कॉपी करने के लिए एचटीटीपी स्टेटस कोड दिखाई देगा.

<Copy source='response'>
    <StatusCode>404</StatusCode>      
</Copy>

&lt;FaultResponse&gt;&lt;Copy&gt;/&lt;ReasonPhrase&gt; एलिमेंट

गड़बड़ी के सोर्स एट्रिब्यूट के ज़रिए बताए गए ऑब्जेक्ट से कॉपी करने की वजह दिखाई देगा.

<Copy source='response'>     
    <ReasonPhrase>The resource requested was not found.</ReasonPhrase>     
</Copy>

&lt;FaultResponse&gt;&lt;Remove&gt;/&lt;Headers&gt; एलिमेंट

गड़बड़ी के मैसेज से बताए गए एचटीटीपी हेडर हटाता है. सभी हेडर हटाने के लिए, <Remove><Headers/></Remove>. इस उदाहरण में, user-agent हेडर को भी शामिल किया गया है.

<Remove>     
    <Headers>      
        <Header name="user-agent"/>     
    </Headers> 
</Remove>

अगर एक ही नाम वाले कई हेडर हैं, तो नीचे दिया गया सिंटैक्स इस्तेमाल करें:

<Remove>
    <Headers>
      <Header name="h1"/>
      <Header name="h2"/>
      <Header name="h3.2"/>
    </Headers>
</Remove>

यह उदाहरण "h1", "h2", और "h3" की दूसरी वैल्यू को हटा देता है. अगर "h3" है में केवल एक है मान है, तो इसे निकाला नहीं जाता है.

&lt;FaultResponse&gt;&lt;Set&gt; एलिमेंट

गड़बड़ी के मैसेज में जानकारी सेट करता है.

    <Set>
        <Headers/>
        <Payload> </Payload>
        <StatusCode/>
        <ReasonPhrase/>
    </Set>

&lt;FaultResponse&gt;/&lt;Set&gt;/&lt;Headers&gt; एलिमेंट

गड़बड़ी के मैसेज में एचटीटीपी हेडर सेट या ओवरराइट करता है. ध्यान दें कि खाली हेडर <Set><Headers/></Set> कोई हेडर सेट नहीं करता. यह उदाहरण सेट करता है user-agent हेडर को मैसेज वैरिएबल के साथ <AssignTo> एलिमेंट.

<Set>
    <Headers>
        <Header name="user-agent">{request.header.user-agent}</Header>     
    </Headers>
</Set>

&lt;FaultResponse&gt;/&lt;Set&gt;/&lt;Payload&gt; एलिमेंट

गड़बड़ी के मैसेज का पेलोड सेट करता है.

<Set>
    <Payload contentType="text/plain">test1234</Payload>
</Set>

JSON पेलोड सेट करें:

<Set>
    <Payload contentType="application/json">
        {"name":"foo", "type":"bar"}
    </Payload>
</Set>

JSON पेलोड में, variablePrefix और डेलिमिटर वर्णों वाले variableSuffix एट्रिब्यूट, जैसा कि यहां दिखाया गया है उदाहरण के लिए.

<Set>
    <Payload contentType="application/json" variablePrefix="@" variableSuffix="#">
        {"name":"foo", "type":"@variable_name#"}
    </Payload>
</Set>

या क्लाउड रिलीज़ 16.08.17 के बाद से, वैरिएबल डालने के लिए कर्ली ब्रैकेट भी इस्तेमाल किए जा सकते हैं:

<Set>
    <Payload contentType="application/json">
        {"name":"foo", "type":"{variable_name}"}
    </Payload>
</Set>

एक्सएमएल में मिक्स पेलोड सेट करें:

<Set>
    <Payload contentType="text/xml">
        <root>
          <e1>sunday</e1>
          <e2>funday</e2>
          <e3>{var1}</e3>
    </Payload>
</Set>

विशेषताएं

 
<Payload contentType="content_type" variablePrefix="char" variableSuffix="char">

&lt;FaultResponse&gt;/&lt;Set&gt;/&lt;StatusCode&gt; एलिमेंट

यह जवाब का स्टेटस कोड सेट करता है.

<Set source='request'>
    <StatusCode>404</StatusCode>
</Set>

&lt;FaultResponse&gt;/&lt;Set&gt;/&lt;ReasonPhrase&gt; एलिमेंट

जवाब की वजह बताने वाला वाक्यांश सेट करता है.

<Set source='request'>     
    <ReasonPhrase>The resource requested was not found.</ReasonPhrase>
</Set>

&lt;ShortFaultReason&gt; एलिमेंट

जवाब में एक छोटी सी गड़बड़ी की वजह भी बताई जाती है:

<ShortFaultReason>true|false</ShortFaultReason>

डिफ़ॉल्ट रूप से, नीति के रिस्पॉन्स में गड़बड़ी की वजह यह है:

"fault":{"faultstring":"Raising fault. Fault name : Raise-Fault-1","detail":{"errorcode":"errorCode"}}}

मैसेज को पढ़ने लायक बनाने के लिए, <ShortFaultReason> एलिमेंट को सेट करें 'सही' के तौर पर faultstring को छोटा करके सिर्फ़ नीति का नाम लिखें:

"fault":{"faultstring":"Raise-Fault-1","detail":{"errorcode":"errorCode"}}}

मान्य वैल्यू: सही/गलत(डिफ़ॉल्ट).

फ़्लो वैरिएबल

फ़्लो वैरिएबल, एचटीटीपी के आधार पर रनटाइम के दौरान नीतियों और फ़्लो के डाइनैमिक व्यवहार को चालू करते हैं हेडर, मैसेज कॉन्टेंट या फ़्लो कॉन्टेक्स्ट. पहले से तय फ़्लो वैरिएबल उपलब्ध हैं RaiseFault नीति लागू होने के बाद. फ़्लो वैरिएबल के बारे में ज़्यादा जानकारी के लिए, वैरिएबल रेफ़रंस देखें.

riseFault के इस्तेमाल का उदाहरण

नीचे दिए गए उदाहरण में, किसी शर्त का इस्तेमाल इनबाउंड अनुरोध पर, zipcode नाम के साथ queryparam. अगर आपने अगर queryparam मौजूद नहीं है, तो फ़्लो RaiseFault के ज़रिए गड़बड़ी बढ़ाएगा:

<Flow name="flow-1">
  <Request>
    <Step>
        <Name>RF-Error-MissingQueryParam</Name>
        <Condition>request.queryparam.zipcode = null</Condition>
    </Step>
   ...
   </Request>
   ...
   <Condition>(proxy.pathsuffix MatchesPath "/locations") and (request.verb = "GET")</Condition>
</Flow>

<RaiseFault name='RF-Error-MissingQueryParam'>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <FaultResponse>
    <Set>
      <Payload contentType='application/json'>{
  "error" : {
    "code" : 400.02,
    "message" : "invalid request. Pass a zipcode queryparam."
  }
}
</Payload>
      <StatusCode>400</StatusCode>
      <ReasonPhrase>Bad Request</ReasonPhrase>
    </Set>
  </FaultResponse>
</RaiseFault>

गड़बड़ी का रेफ़रंस

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

None.

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

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

स्कीमा

हर तरह की नीति को एक्सएमएल स्कीमा (.xsd) से तय किया जाता है. रेफ़रंस के लिए, नीति के स्कीमा GitHub पर उपलब्ध हैं.

मिलते-जुलते विषय

गड़बड़ियां ठीक करना देखें