Résolution des erreurs de déploiement de la règle de recherche du cache

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X.
en savoir plus

InvalidTimeout

Message d'erreur

Le déploiement du proxy d'API via l'interface utilisateur Edge ou l'API de gestion Edge é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.

Exemple de capture d'écran d'erreur

Cause

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

Par exemple, si l'élément <CacheLookupTimeoutInSeconds> a une valeur -1, le déploiement du proxy d'API échoue.

Diagnostic

  1. Identifiez la valeur non valide spécifiée pour l'élément <CacheLookupTimeoutInSeconds> dans la règle LookupCache. 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 LookupCache dans le proxy d'API spécifique où l'erreur s'est produite. Il peut y avoir une ou plusieurs règles LookupCache dans lesquelles l'élément <CacheLookupTimeoutInSeconds> est spécifié. Identifiez la règle LookUpCache dans laquelle la valeur non valide (identifiée à l'étape 1 ci-dessus) est spécifiée pour l'élément <CacheLookupTimeoutInSeconds>.

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

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <LookupCache async="false" continueOnError="false" enabled="true" name="LookupCache-Token">
        <DisplayName>LookupCache-Token</DisplayName>
        <Properties/>
        <CacheKey>
            <Prefix/>
            <KeyFragment ref="request.queryparam.client_id"/>
        </CacheKey>
        <CacheLookupTimeoutInSeconds>-1</CacheLookupTimeoutInSeconds>
        <Scope>Exclusive</Scope>
        <ExpirySettings>
            <TimeoutInSec>3600</TimeoutInSec>
        </ExpirySettings>
        <AssignTo>usertoken</AssignTo>
    </LookupCache>
    
  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.

Résolution

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

Pour corriger l'exemple de règle LookupCache présenté ci-dessus, vous pouvez remplacer l'élément <CacheLookupTimeoutInSeconds> par 30.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<LookupCache async="false" continueOnError="false" enabled="true" name="LookupCache-Token">
    <DisplayName>LookupCache-Token</DisplayName>
    <Properties/>
    <CacheKey>
        <Prefix/>
        <KeyFragment ref="request.queryparam.client_id"/>
    </CacheKey>
    <CacheResource>tokencache</CacheResource>
    <CacheLookupTimeoutInSeconds>30</CacheLookupTimeoutInSeconds>
    <Scope>Exclusive</Scope>
    <ExpirySettings>
        <TimeoutInSec>3600</TimeoutInSec>
    </ExpirySettings>
    <AssignTo>usertoken</AssignTo>
</LookupCache>

InvalidCacheResourceReference

Message d'erreur

Le déploiement du proxy d'API via l'interface utilisateur Edge ou l'API de gestion Edge échoue avec le message d'erreur suivant:

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

Exemple de message d'erreur

Error Deploying Revision 2 to test
Invalid cache resource reference tokencache in Step definition LookupCache-Token. Context Revision:2;APIProxy:TestCache;Organization:kkalckstein-eval;Environment:test

Exemple de capture d'écran d'erreur

Cause

Cette erreur se produit si l'élément <CacheResource> est défini sur un nom qui n'existe pas dans l'environnement dans lequel le proxy d'API est déployé.

Diagnostic

  1. Identifiez le cache non valide utilisé dans l'élément <CacheResource> de la règle LookupCache ainsi que 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 tokencache et le nom de l'environnement est test.

    Invalid cache resource reference tokencache in Step definition LookupCache-Token. Context Revision:2;APIProxy:TestCache;Organization:kkalckstein-eval;Environment:test
    
  2. Examinez toutes les règles LookupCache dans le proxy d'API spécifique où l'erreur s'est produite. Identifiez la règle LookupCache 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 tokencache, qui correspond au message d'erreur :

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <LookupCache async="false" continueOnError="false" enabled="true" name="LookupCache-Token">
        <DisplayName>LookupCache-Token</DisplayName>
        <Properties/>
        <CacheKey>
            <Prefix/>
            <KeyFragment ref="request.queryparam.client_id"/>
        </CacheKey>
        <CacheResource>tokencache</CacheResource>
        <CacheLookupTimeoutInSeconds/>
        <Scope>Exclusive</Scope>
        <ExpirySettings>
            <TimeoutInSec>3600</TimeoutInSec>
        </ExpirySettings>
        <AssignTo>usertoken</AssignTo>
    </LookupCache>
    
  3. Vérifiez si le cache (déterminé à l'étape 1) a été défini dans l'environnement spécifique (identifié à l'étape 1).

    Dans l'interface utilisateur Edge, accédez à ADMIN > Environnement > test et vérifiez si le cache existe dans l'onglet Caches de Configuration de l'environnement. 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é tokencache n'existe pas.

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

    Invalid cache resource reference tokencache in Step definition LookupCache-Token. Context Revision:2;APIProxy:TestCache;Organization:kkalckstein-eval;Environment:test
    
    

Ré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.

Consultez la section Créer et modifier un cache d'environnement pour savoir comment créer le cache.

CacheNotFound

Message d'erreur

Le déploiement du proxy d'API via l'interface utilisateur Edge ou l'API de gestion Edge génère un message d'erreur de ce type 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 : configCache, not found in organization : kkalckstein-eval__test

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.

Résolution

Si vous utilisez un cloud privé, veuillez suivre les instructions ci-dessous:

  1. Listez les déploiements de proxy d'API et déterminez quels processeurs de messages présentent l'erreur steps.cache.CacheNotFound.

    curl -u $USERID:$USERPASSWORD http://:8080/v1/organizations//environments//apis//revisions//deployments

    Exemple de résultat

    {
      "aPIProxy" : "TestCache",
      "environment" : [ {
        "configuration" : {
          "basePath" : "/",
          "configVersion" : "SHA-512:45d3f39783414d3859bf2dec4135d8f5f9960ee6b2d361db2799c82693a8e3f8b95dbbb37c547eb3c0a3819d8ca51727f390502bcaefdf1f113263521a9023b6",
          "steps" : [ ]
        },
        "name" : "prod",
        "server" : [ {
          "pod" : {
            "name" : "pod1",
            "region" : "us-central1"
          },
          "status" : "deployed",
          "type" : [ "message-processor" ],
          "uUID" : "f2e5e34a-5630-43a9-8fef-48a5b9da76d1"
        }, {
          "pod" : {
            "name" : "pod1",
            "region" : "us-central1"
          },
          "status" : "deployed",
          "type" : [ "message-processor" ],
          "uUID" : "879a6538-a5e0-4503-b142-9cb2b4e0623d"
        }, {
        "error" : "Cache : configCache, not found in organization : kkalckstein-eval__test",
        "errorCode" : "steps.cache.CacheNotFound",
        "status" : "error",
        "type" : [ "message-processor" ],
         "uUID" : "a8f9ce0b-c32d-48a9-b26c-9c75d8bf467d"
    },
    ...
        "state" : "deployed"
      } ],
      "name" : "2",
      "organization" : "kkalckstein-eval"
      ...
    
  2. Notez le ou les UUID du processeur de messages dans lequel vous observez l'erreur steps.cache.CacheNotFound. Identifiez le nom d'hôte/l'adresse IP du processeur de messages associé à l'UUID.

  3. Connectez-vous au processeur de messages spécifique et redémarrez-le à l'aide de la commande suivante:

    apigee-service edge-message-processor restart

Si vous êtes un utilisateur du cloud public ou si le problème persiste pour le cloud privé, contactez l'assistance Apigee pour obtenir de l'aide.