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

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

InvalidTimeout

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

Развертывание прокси-сервера 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>

InvalidCacheResourceReference

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

Развертывание прокси-сервера 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 перейдите в раздел APIs > Environment Configuration (API > Конфигурация среды) и проверьте, существует ли кеш на вкладке Caches (Кеши) в определенной среде. Если кеша нет, то в этом и заключается причина ошибки.

    Например, на скриншоте ниже видно, что кеш с названием 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.

Информацию о том, как создать кеш, можно найти в разделе Создание и редактирование кеша среды.

ResponseCacheStepAttachmentNotAllowedReq

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

Развертывание прокси-сервера 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.

Например, если в запросе Preflow конечных точек прокси и целевой конечной точки прикреплены одни и те же правила 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 из одного из двух потоков запросов.

ResponseCacheStepAttachmentNotAllowedResp

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

Развертывание прокси-сервера 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 прикреплено к Preflow ответа как конечной точки прокси, так и целевой конечной точки, возникает эта ошибка.

диагностика;

  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 из одного из двух путей ответа.

InvalidMessagePatternForErrorCode

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

Развертывание прокси-сервера 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>

CacheNotFound

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

При развертывании прокси-сервера 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

Причина

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

Разрешение

Если вы используете частное облако, выполните следующие инструкции:

  1. Перечислите развертывания прокси-сервера API и определите, какие Message Processor выдают ошибку 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-адрес Message Processor по UUID.

  3. Войдите в нужный Message Processor и перезапустите его с помощью следующей команды:

    apigee-service edge-message-processor restart

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