Устранение ошибок при развертывании политики кэша ответов

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X.
информация

Инвалидтаймаут

Сообщение об ошибке

Развертывание прокси-сервера API через пользовательский интерфейс Edge или API управления Edge завершается сбоем с этим сообщением об ошибке:

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

Пример сообщения об ошибке

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

Пример снимка экрана с ошибкой

Причина

Если для элемента <CacheLookupTimeoutInSeconds> политики ResponseCache установлено отрицательное число, развертывание прокси-сервера API завершается неудачно.

Например, если <CacheLookupTimeoutInSeconds> имеет значение -1 , развертывание прокси-сервера API завершается неудачей.

Диагностика

  1. Определите недопустимое значение, используемое для элемента <CacheLookupTimeoutInSeconds> в политике ResponseCache. Эту информацию можно найти в сообщении об ошибке. Например, в следующей ошибке недопустимое значение, используемое для элемента <CacheLookupTimeoutInSeconds> ​​равно -1 :

    CacheLookupTimeoutInSeconds -1 value should be greater than zero.
    
  2. Проверьте все политики ResponseCache в конкретном прокси-сервере API, где произошел сбой. Может существовать одна или несколько политик ResponseCache, в которых указан элемент <CacheLookupTimeoutInSeconds> .

    Например, следующая конфигурация политики устанавливает для <CacheLookupTimeoutInSeconds> значение -1 , что соответствует тому, что указано в сообщении об ошибке:

    <?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. Если <CacheLookupTimeoutInSeconds> указано как отрицательное целое число, это и есть причина ошибки.

Разрешение

Убедитесь, что значение элемента <CacheLookupTimeoutInSeconds> политики ResponseCache всегда указано как неотрицательное целое число.

Чтобы исправить пример политики ResponseCache, показанный выше, вы можете изменить <CacheLookupTimeoutInSeconds> element на 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>

Инвалидкачересаурцеференсе

Сообщение об ошибке

Развертывание прокси-сервера API через пользовательский интерфейс Edge или API управления Edge завершается неудачно с этим сообщением об ошибке:

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

Пример сообщения об ошибке

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

Пример снимка экрана с ошибкой

Причина

Эта ошибка возникает, если элементу <CacheResource> в политике ResponseCache присвоено имя, не существующее в среде, где развертывается прокси-сервер API.

Диагностика

  1. Определите недопустимый кэш, используемый в элементе <CacheResource> политики кэша ответов, и среду, в которой произошла ошибка. Оба эти элемента можно найти в сообщении об ошибке. Например, в следующей ошибке имя недопустимого кэша — itemscache , а имя среды — prod .

    Invalid cache resource reference itemscache in Step definition ItemsResponseCache. Context Revision:2;APIProxy:StoresInventory;Organization:kkalckstein-eval;Environment:prod
    
  2. Проверьте все политики ResponseCache в конкретном прокси-сервере API, где произошел сбой. Определите конкретную политику ResponseCache, в которой недопустимый кеш (определенный на шаге 1) указан в элементе <CacheResource> .

    Например, следующая политика определяет значение <CacheResource> как itemscache , что соответствует значению в сообщении об ошибке:

    <?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. Убедитесь, что кэш (определенный на шаге № 2) определен в конкретной среде (определенной на шаге № 1).

    В пользовательском интерфейсе Edge перейдите в раздел «API» > «Конфигурация среды» и проверьте, существует ли кеш на вкладке «Кэши» в конкретной среде. Если кэша нет, то это и есть причина ошибки.

    Например, обратите внимание на скриншот ниже, что кэш с именем itemscache не существует.

    Поскольку кэш с именем itemscache не определен в среде prod , вы получаете сообщение об ошибке:

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

Разрешение

Убедитесь, что имя кэша, указанное в элементе <CacheResource> , создано в среде, в которой вы хотите развернуть прокси-сервер API.

Дополнительную информацию о том, как создать кэш, см. в разделе Создание и редактирование кэша среды .

Респонсенкечестепаттачментноталловедрек

Сообщение об ошибке

Развертывание прокси-сервера API через пользовательский интерфейс Edge или API управления Edge завершается сбоем с этим сообщением об ошибке:

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.

Пример сообщения об ошибке

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

Пример снимка экрана с ошибкой

Причина

Эта ошибка возникает, если одна и та же политика ResponseCache прикреплена к нескольким путям запросов в любых потоках прокси-сервера API.

Например, если у вас есть одна и та же политика ResponseCache, прикрепленная к предварительному потоку запроса как на прокси-сервере, так и на целевой конечной точке, возникает эта ошибка.

Диагностика

  1. Определите имя политики ResponseCache, которая прикреплена более одного раза. Эту информацию можно найти в сообщении об ошибке. Например, в следующей ошибке имя политики ResponseCache — 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. Проверьте все потоки запросов в прокси-сервере и целевых конечных точках прокси-сервера API, где произошла ошибка. Если одна и та же политика ResponseCache прикреплена к двум или более потокам запросов, это и есть причина ошибки.

    В следующем примере одна и та же политика ResponseCache Response-Cache-1 настроена в пути запроса конечной точки прокси-сервера по умолчанию PreFlow и целевой конечной точки по умолчанию 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>
        ...
    

Разрешение

Убедитесь, что политика ResponseCache прикреплена только к одному пути запроса во всех потоках прокси-сервера API.

Чтобы исправить показанный выше пример, удалите политику ResponseCache Response-Cache-1 из одного из двух потоков запросов.

Респонсенкечестепаттачментноталловедресп

Сообщение об ошибке

Развертывание прокси-сервера API через пользовательский интерфейс Edge или API управления Edge завершается сбоем с этим сообщением об ошибке:

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.

Пример сообщения об ошибке

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

Пример снимка экрана с ошибкой

Причина

Эта ошибка возникает, если одна и та же политика ResponseCache прикреплена к нескольким путям ответа в любых потоках прокси-сервера API.

Например, если у вас есть одна и та же политика ResponseCache, прикрепленная к предварительному потоку ответа как на прокси-сервере, так и на целевой конечной точке, возникает эта ошибка.

Диагностика

  1. Определите имя политики ResponseCache, которая прикреплена более одного раза. Эту информацию можно найти в сообщении об ошибке. Например, в следующей ошибке имя политики ResponseCache — 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. Проверьте все потоки запросов в прокси-сервере и целевых конечных точках прокси-сервера API, где произошла ошибка. Если одна и та же политика ResponseCache прикреплена к двум или более потокам ответов, это и есть причина ошибки.

    В следующем примере одна и та же политика ResponseCache Response-Cache-1 настроена в пути ответа конечной точки прокси-сервера по умолчанию PreFlow и целевой конечной точки по умолчанию 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>
        ...
    

Разрешение

Убедитесь, что политика ResponseCache прикреплена только к одному пути ответа во всех потоках прокси-сервера API.

Чтобы исправить приведенный выше пример, удалите политику ResponseCache Response-Cache-1 из одного из двух путей ответа.

Инвалидмессажепаттернфорерроркоде

Сообщение об ошибке

Развертывание прокси-сервера API через пользовательский интерфейс Edge или API управления Edge завершается сбоем с любым из следующих сообщений об ошибке:

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

ИЛИ

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

Пример сообщения об ошибке

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

ИЛИ

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

Пример снимка экрана ошибки

ИЛИ

Причина

Эта ошибка возникает, если элемент <SkipCacheLookup> или <SkipCachePopulation> в политике ResponseCache содержит недопустимое условие.

Диагностика

  1. Изучите все политики ResponseCache в прокси-сервере API, где произошла ошибка, и проверьте, есть ли какие-либо политики, в которых указаны условия для элементов <SkipCacheLookup> и/или <SkipCachePopulation> .

  2. Проверьте, не является ли условие, указанное для элемента <SkipCacheLookup> и/или <SkipCachePopulation> , недопустимым. Если да, то это причина ошибки.

    В следующем примере элемент <SkipCachePopulation> использует оператор JavaScript === для проверки недопустимого равного значения и равного типа.

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

    Поскольку оператор === недействителен, вы получаете ошибку:

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

Разрешение

Убедитесь, что условие, указанное для элементов <SkipCacheLookup> и/или <SkipCachePopulation> , всегда допустимо.

Чтобы исправить пример политики ResponseCache , показанный выше, вы можете изменить <SkipCacheLookup> , чтобы использовать оператор = :

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

Кэш не найден

Сообщение об ошибке

Развертывание прокси-сервера API через пользовательский интерфейс Edge или API управления Edge приводит к появлению такого сообщения об ошибке, а состояние развертывания прокси-сервера API помечается как частично развернутое:

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

Пример сообщения об ошибке

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

Причина

Эта ошибка возникает, если конкретный кэш, упомянутый в сообщении об ошибке, не был создан в определенном компоненте процессора сообщений.

Разрешение

Если вы являетесь пользователем частного облака , следуйте инструкциям ниже:

  1. Перечислите развертывания прокси-сервера API и определите, какие процессоры сообщений имеют ошибку steps.cache.CacheNotFound .

    Пример вывода

    curl -u $USERID:$USERPASSWORD http://<management-server-host>:8080/v1/organizations/<org-name>/environments/<env-name>/apis/<apiproxy-name>/revisions/<revision-number>/deployments
    {
      "aPIProxy" : "ResponseCache",
      "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 : Response-Cache-1, not found in organization : kkalckstein-eval__prod",
        "errorCode" : "steps.cache.CacheNotFound",
        "status" : "error",
        "type" : [ "message-processor" ],
         "uUID" : "a8f9ce0b-c32d-48a9-b26c-9c75d8bf467d"
    },
    ...
        "state" : "deployed"
      } ],
      "name" : "2",
      "organization" : "kkalckstein-eval"
    
  2. Запишите UUID(ы) процессора сообщений, в котором вы наблюдаете ошибку steps.cache.CacheNotFound . Определите имя хоста/IP-адрес процессора сообщений по UUID.

  3. Войдите в определенный процессор сообщений и перезапустите его, используя следующую команду:

    apigee-service edge-message-processor restart

Если вы являетесь пользователем общедоступного облака или проблема с частным облаком не устранена, обратитесь за помощью в службу поддержки Apigee .