Dépannage des erreurs de déploiement de la règle de réponse du cache ResponseCache

Vous consultez la documentation d'Apigee X.
Consultez la documentation d'Apigee Edge.

InvalidTimeout

Message d'erreur

Le déploiement du proxy d'API par le biais de l'interface utilisateur ou l'API Apigee échoue avec le message d'erreur suivant :

Error Saving Revision revision_number
CacheLookupTimeoutInSeconds value value should be greater than zero.

Exemple de message d'erreur

Error Saving Revision 2
CacheLookupTimeoutInSeconds -1 value should be greater than zero.

Capture d'écran du message d'erreur

Erreur lors de l'enregistrement de la révision 2.

Cause

Si l'élément <CacheLookupTimeoutInSeconds> d'une règle ResponseCache est défini sur un nombre négatif, le déploiement du proxy d'API échoue.

Par exemple, si <CacheLookupTimeoutInSeconds> équivaut à -1, le déploiement du proxy d'API échoue.

Diagnostic

  1. Identifiez la valeur non valide utilisée pour l'élément <CacheLookupTimeoutInSeconds> dans la règle ResponseCache. Vous trouverez cette information dans le message d'erreur. Par exemple, dans l'erreur suivante, la valeur non valide utilisée pour l'élément <CacheLookupTimeoutInSeconds> est -1 :

    CacheLookupTimeoutInSeconds -1 value should be greater than zero.
    
  2. Examinez toutes les règles ResponseCache dans le proxy d'API spécifique où l'échec a eu lieu. Une ou plusieurs règles ResponseCache peuvent être spécifiées dans l'élément <CacheLookupTimeoutInSeconds>.

    Par exemple, la configuration de règle suivante définit <CacheLookupTimeoutInSeconds> sur -1, qui correspond au contenu du message d'erreur :

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ResponseCache async="false" continueOnError="false" enabled="true" name="Response-Cache-1">
        <DisplayName>Response Cache-1</DisplayName>
        <Properties/>
        <CacheKey>
            <Prefix/>
            <KeyFragment ref="request.uri" type="string"/>
        </CacheKey>
        <Scope>Exclusive</Scope>
        <ExpirySettings>
            <ExpiryDate/>
            <TimeOfDay/>
            <TimeoutInSec ref="">3600</TimeoutInSec>
        </ExpirySettings>
        <CacheLookupTimeoutInSeconds>-1</CacheLookupTimeoutInSeconds>
    </ResponseCache>
    
  3. Si la valeur de <CacheLookupTimeoutInSeconds> est spécifiée sous forme d'un entier négatif, alors il s'agit de la cause de l'erreur.

Solution

Vérifiez que la valeur de l'élément <CacheLookupTimeoutInSeconds> de la règle ResponseCache est toujours spécifiée sous la forme d'un entier non négatif.

Pour corriger l'exemple de règle ResponseCache présenté ci-dessus, vous pouvez modifier la valeur <CacheLookupTimeoutInSeconds> element en 30.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResponseCache async="false" continueOnError="false" enabled="true" name="Response-Cache-1">
    <DisplayName>Response Cache-1</DisplayName>
    <Properties/>
    <CacheKey>
        <Prefix/>
        <KeyFragment ref="request.uri" type="string"/>
    </CacheKey>
    <Scope>Exclusive</Scope>
    <ExpirySettings>
        <ExpiryDate/>
        <TimeOfDay/>
        <TimeoutInSec ref="">3600</TimeoutInSec>
    </ExpirySettings>
    <CacheLookupTimeoutInSeconds>30</CacheLookupTimeoutInSeconds>
</ResponseCache>

InvalidCacheResourceReference

Message d'erreur

Le déploiement du proxy d'API par le biais de l'interface utilisateur ou l'API Apigee échoue avec le message d'erreur suivant :

Error Deploying Revision revision_number to environment
Invalid cache resource reference cache_resource in Step definition response_cache_policy_name. Context Revision:revision_number;APIProxy:ResponseCache;Organization:organization;Environment:environment

Exemple de message d'erreur

Error Deploying Revision 2 to prod
Invalid cache resource reference itemscache in Step definition ItemsResponseCache. Context Revision:2;APIProxy:StoresInventory;Organization:kkalckstein-eval;Environment:prod

Capture d'écran du message d'erreur

Erreur lors du déploiement de la révision 1 sur &quot;prod&quot;.

Cause

Cette erreur se produit si l'élément <CacheResource> d'une règle ResponseCache est défini sur un nom qui n'existe pas dans l'environnement où le proxy d'API est déployé.

Diagnostic

  1. Identifiez le cache non valide utilisé dans l'élément <CacheResource> de la règle ResponseCache et l'environnement où l'erreur s'est produite. Ces deux éléments se trouvent dans le message d'erreur. Par exemple, dans l'erreur suivante, le nom du cache non valide est itemscache et le nom de l'environnement est prod.

    Invalid cache resource reference itemscache in Step definition ItemsResponseCache. Context Revision:2;APIProxy:StoresInventory;Organization:kkalckstein-eval;Environment:prod
    
  2. Examinez toutes les règles ResponseCache dans le proxy d'API spécifique où l'échec a eu lieu. Identifiez la règle ResponseCache spécifique dans laquelle le cache non valide (identifié à l'étape 1) est spécifié dans l'élément <CacheResource>.

    Par exemple, la règle suivante spécifie la valeur de <CacheResource> en tant que itemscache, qui correspond au contenu du message d'erreur :

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ResponseCache async="false" continueOnError="false" enabled="true" name="ItemsResponseCache">
      <DisplayName>ItemsResponseCache</DisplayName>
      <Properties/>
      <CacheKey>
          <Prefix/>
          <KeyFragment ref="request.uri" type="string"/>
      </CacheKey>
      <CacheResource>itemscache</CacheResource>
      <Scope>Exclusive</Scope>
      <ExpirySettings>
          <ExpiryDate/>
          <TimeOfDay/>
          <TimeoutInSec ref="">3600</TimeoutInSec>
      </ExpirySettings>
      <SkipCacheLookup/>
      <SkipCachePopulation/>
    </ResponseCache>
    
  3. Vérifiez si le cache (déterminé à l'étape 2) a été défini dans l'environnement spécifique (identifié à l'étape 1).

    Dans l'interface utilisateur Apigee, accédez à API > Configuration de l'environnement et vérifiez si le cache existe dans l'onglet Caches de l'environnement spécifique. Si le cache n'existe pas, il s'agit de la cause de l'erreur.

    Par exemple, dans la capture d'écran ci-dessous, notez que le cache nommé itemscache n'existe pas.

    Onglet &quot;Caches&quot; de la page &quot;Configuration de l&#39;environnement&quot;.

    Étant donné que le cache itemscache n'est pas défini dans l'environnement prod, vous obtenez l'erreur suivante :

    Invalid cache resource reference does_not_exist in Step definition Response-Cache-1. Context Revision:2;APIProxy:ResponseCache;Organization:kkalckstein-eval;Environment:prod
    

Solution

Vérifiez que le nom de cache spécifié dans l'élément <CacheResource> a été créé dans l'environnement dans lequel vous souhaitez déployer le proxy d'API.

ResponseCacheStepAttachmentNotAllowedReq

Message d'erreur

Le déploiement du proxy d'API par le biais de l'interface utilisateur ou l'API Apigee échoue avec le message d'erreur suivant :

Error Deploying Revision revision_number to environment
Response cache step definition response_cache_policy_name can not be attached more than once in the request path.

Exemple de message d'erreur

Error Deploying Revision 2 to test
Response cache step definition Response-Cache-1 can not be attached more than once in the request path.

Capture d'écran du message d'erreur

Erreur lors du déploiement de la révision 2 sur &quot;test&quot;.

Cause

Cette erreur se produit si la même règle ResponseCache est associée à plusieurs chemins de requête dans tous les flux d'un proxy d'API.

Par exemple, cette erreur se produit si vous avez associé la même règle ResponseCache au Preflow de requête des points de terminaison du proxy et des points de terminaison cibles.

Diagnostic

  1. Identifiez le nom de la règle ResponseCache associée plusieurs fois. Vous trouverez cette information dans le message d'erreur. Par exemple, dans l'erreur suivante, le nom de la règle ResponseCache est Response‐Cache‐1.

    Error Deploying Revision 2 to test
    Response cache step definition Response-Cache-1 can not be attached more than once in the request path.
    
  2. Examinez tous les flux de requêtes dans les points de terminaison du proxy et les points de terminaison cibles du proxy d'API où l'erreur s'est produite. Si la même règle ResponseCache est associée dans deux flux de requêtes ou plus, il s'agit de la cause de l'erreur.

    Dans l'exemple suivant, la même règle ResponseCache Response-Cache-1 est configurée dans le chemin de requête du point de terminaison du proxy par défaut PreFlow et du point de terminaison cible par défaut PreFlow :

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ProxyEndpoint name="default">
        <Description/>
        <FaultRules/>
        <PreFlow name="PreFlow">
            <Request>
                <Step>
                    <Name>Response-Cache-1</Name>
                </Step>
            </Request>
        ...
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <TargetEndpoint name="default">
        <Description/>
        <FaultRules/>
        <PreFlow name="PreFlow">
            <Request/>
            <Response/>
        </PreFlow>
        <PostFlow name="PostFlow">
            <Request>
                <Step>
                    <Name>Response-Cache-1</Name>
                </Step>
            </Request>
        ...
    

    Conseil : Dans l'interface utilisateur, cliquez sur un flux sous Point de terminaison du proxy dans le navigateur et sur un flux sous Point de terminaison cible.

Solution

Vérifiez qu'une règle ResponseCache est associée à un seul chemin de requête pour tous les flux du proxy d'API.

Pour corriger l'exemple présenté ci-dessus, supprimez la règle ResponseCache Response-Cache-1 de l'un des deux flux de requêtes.

ResponseCacheStepAttachmentNotAllowedResp

Message d'erreur

Le déploiement du proxy d'API par le biais de l'interface utilisateur ou l'API Apigee échoue avec le message d'erreur suivant :

Error Deploying Revision revision_number to environment
Response cache step definition response_cache_policy_name can not be attached more than once in the response path.

Exemple de message d'erreur

Error Deploying Revision 2 to test
Response cache step definition Response-Cache-1 can not be attached more than once in the response path.

Capture d'écran du message d'erreur

Erreur lors du déploiement de la révision 2 sur &quot;test&quot;.

Cause

Cette erreur se produit si la même règle ResponseCache est associée à plusieurs chemins de réponse dans les flux d'un proxy d'API.

Par exemple, cette erreur se produit si vous avez associé la même règle ResponseCache au Preflow de réponse des points de terminaison du proxy et des points de terminaison cibles.

Diagnostic

  1. Identifiez le nom de la règle ResponseCache associée plusieurs fois. Vous trouverez cette information dans le message d'erreur. Par exemple, dans l'erreur suivante, le nom de la règle ResponseCache est Response-Cache-1.

    Error Deploying Revision 2 to test
    Response cache step definition Response-Cache-1 can not be attached more than once in the response path.
    
  2. Examinez tous les flux de requêtes dans les points de terminaison du proxy et les points de terminaison cibles du proxy d'API où l'erreur s'est produite. Si la même règle ResponseCache est associée dans deux flux de réponse ou plus, il s'agit de la cause de l'erreur.

    Dans l'exemple suivant, la même règle ResponseCache Response-Cache-1 est configurée dans le chemin de réponse du point de terminaison du proxy par défaut PreFlow et du point de terminaison cible par défaut PreFlow :

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ProxyEndpoint name="default">
        <Description/>
        <FaultRules/>
        <PreFlow name="PreFlow">
            <Request>
                <Step>
                    <Name>Response-Cache</Name>
                </Step>
            </Request>
            <Response>
                <Step>
                    <Name>Response-Cache-1</Name>
                </Step>
            </Response>
        </PreFlow>
        ...
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <TargetEndpoint name="default">
        <Description/>
        <FaultRules/>
        <PreFlow name="PreFlow">
            <Request/>
            <Response/>
        </PreFlow>
        <PostFlow name="PostFlow">
            <Request/>
            <Response>
                <Step>
                    <Name>Response-Cache-1</Name>
                </Step>
            </Response>
        </PostFlow>
        ...
    

Solution

Vérifiez qu'une règle ResponseCache est associée à un seul chemin de réponse pour tous les flux du proxy d'API.

Pour corriger l'exemple présenté ci-dessus, supprimez la règle ResponseCache Response-Cache-1 de l'un des deux chemins de réponse.

InvalidMessagePatternForErrorCode

Message d'erreur

Le déploiement du proxy d'API par le biais de l'interface utilisateur ou l'API Apigee échoue avec l'un des messages d'erreur suivants :

Error Deploying Revision revision_number to environment
Invalid message pattern found for error code steps.cache.InvalidSkipCacheLookUpCondition.

OU

Error Deploying Revision revision_number to environment
Invalid message pattern found for error code steps.cache.InvalidSkipCachePopulationCondition.

Exemple de message d'erreur

Error Deploying Revision 2 to prod
Invalid message pattern found for error code steps.cache.InvalidSkipCacheLookUpCondition.

OU

Error Deploying Revision 2 to prod
Invalid message pattern found for error code steps.cache.InvalidSkipCachePopulationCondition.

Capture d'écran du message d'erreur

Erreur lors du déploiement de la révision 1 sur &quot;prod&quot; – LookUp.

OU

Erreur lors du déploiement de la révision 1 sur &quot;prod&quot; – Population.

Cause

Cette erreur se produit si l'élément <SkipCacheLookup> ou <SkipCachePopulation> d'une règle ResponseCache comprend une condition non valide.

Diagnostic

  1. Examinez toutes les règles ResponseCache dans le proxy d'API où l'erreur s'est produite et vérifiez si des règles ont des conditions spécifiées pour <SkipCacheLookup> et/ou les éléments <SkipCachePopulation>.

  2. Vérifiez si la condition spécifiée pour l'élément <SkipCacheLookup> et/ou l'élément <SkipCachePopulation> est non valide. Si c'est le cas, alors il s'agit de la cause de l'erreur.

    Dans l'exemple suivant, l'élément <SkipCachePopulation> utilise l'opérateur JavaScript === pour rechercher la même valeur et le même type non valides.

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ResponseCache async="false" continueOnError="false" enabled="true" name="Response-Cache-1">
        <DisplayName>Response Cache-1</DisplayName>
        <Properties/>
        <CacheKey>
            <Prefix/>
            <KeyFragment ref="request.uri" type="string"/>
        </CacheKey>
        <Scope>Exclusive</Scope>
        <ExpirySettings>
            <ExpiryDate/>
            <TimeOfDay/>
            <TimeoutInSec ref="">3600</TimeoutInSec>
        </ExpirySettings>
        <CacheLookupTimeoutInSeconds>2</CacheLookupTimeoutInSeconds>
        <SkipCacheLookup>request.header.bypass-cache === "true"</SkipCacheLookup>
    </ResponseCache>
    

    Étant donné que l'opérateur === est non valide, l'erreur suivante s'affiche :

    Invalid message pattern found for error code steps.cache.InvalidSkipCacheLookUpCondition.
    

Solution

Vérifiez que la condition spécifiée pour les éléments <SkipCacheLookup> et/ou <SkipCachePopulation> est toujours valide.

Pour corriger l'exemple de la règle ResponseCache présenté ci-dessus, vous pouvez modifier <SkipCacheLookup> pour utiliser l'opérateur = :

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResponseCache async="false" continueOnError="false" enabled="true" name="Response-Cache-1">
    <DisplayName>Response Cache-1</DisplayName>
    <Properties/>
    <CacheKey>
        <Prefix/>
        <KeyFragment ref="request.uri" type="string"/>
    </CacheKey>
    <Scope>Exclusive</Scope>
    <ExpirySettings>
        <ExpiryDate/>
        <TimeOfDay/>
        <TimeoutInSec ref="">3600</TimeoutInSec>
    </ExpirySettings>
    <CacheLookupTimeoutInSeconds>2</CacheLookupTimeoutInSeconds>
    <SkipCacheLookup>request.header.bypass-cache = "true"</SkipCacheLookup>
</ResponseCache>

CacheNotFound

Message d'erreur

Le déploiement du proxy d'API par le biais de l'interface utilisateur ou l'API Apigee génère un message d'erreur comme celui-ci, et l'état de déploiement du proxy d'API est marqué comme partiellement déployé :

Error: Cache : cache_resource, not found in organization : organization__environment.

Exemple de message d'erreur

Error Cache : Response-Cache-1, not found in organization : kkalckstein-eval__prod

Cause

Cette erreur se produit si le cache spécifique mentionné dans le message d'erreur n'a pas été créé sur un composant du processeur de message spécifique.

Solution

Contactez l'assistance Apigee pour obtenir de l'aide.