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

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

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, в которой в элементе <CacheResource> указан недействительный кэш (определенный на шаге №1).

    Например, следующая политика указывает значение <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-прокси.

Для получения информации о создании кэша обратитесь к разделу «Создание и редактирование кэша среды» .

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-прокси.

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

Диагноз

  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

Причина

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

Разрешение

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

  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 .