Résolution des erreurs de déploiement de la règle HTTPModifier

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

InvalidIndex

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 in deployment for environment [environment]
The revision is deployed, but traffic cannot flow.
AssignMessage[policy_name]: index must be greater than zero in [attribute].[index]

Exemple de message d'erreur

Error in deployment for environment test.
The revision is deployed, but traffic cannot flow.
HTTPModifier[GenerateStudentsRequest]: index must be greater than zero in id.0

Cause

Si l'index spécifié dans les éléments <Copy> et/ou <Remove> de la règle HTTPModifier est 0 ou un nombre négatif, le déploiement du proxy d'API échoue.

Par exemple, si vous transmettez plusieurs paramètres de requête portant le même nom, vous pouvez y accéder en tant que variables de flux indexées. Si vous souhaitez transmettre les ID de trois élèves en tant que paramètres de requête, vous pouvez le faire comme suit :

https://$EXTERNAL_IP/$PROXY_BASEPATH?school_name=NPS&id=1&id=2&id=3

Supposons ensuite que vous essayiez d'accéder à ces paramètres de requête avec les numéros d'index 0, 1 et 2 dans la règle HTTPModifier comme suit :

id.0
id.1 and
id.2

Dans ce cas, le déploiement du proxy échoue, car l'index doit commencer par 1. Cela signifie que vous pouvez accéder au premier paramètre de requête "id=1" en tant que "id.1". Pour accéder au deuxième paramètre de requête "id=2", vous devez utiliser l'index 2 i.e, "id.2". De même, pour accéder au troisième paramètre de requête "id=3", vous pouvez utiliser "id.3".

Pour en savoir plus, consultez la documentation de l'élément Copy de la règle AssignMessage.

Diagnostic

  1. Identifiez la règle HTTPModifier où l'erreur s'est produite, le nom de l'attribut et l'index non valide. Vous trouverez tous ces éléments dans le message d'erreur. Par exemple, dans l'erreur suivante, le nom de la règle est GeneratingGeocodingRequest, le nom de l'attribut est id et l'index est 0 :

    HTTPModifier[GenerateStudentsRequest]: index must be greater than zero in id.0
    
  2. Vérifiez que le nom de l'attribut et l'index utilisés dans la fichier XML de la règle HTTPModifier défaillante correspondent au nom de l'attribut et à l'index identifiés dans le message d'erreur (étape 1 ci-dessus). Par exemple, la règle suivante spécifie l'attribut id et l'index en tant que 0, qui correspond au contenu du message d'erreur :

    <AssignMessage name="GenerateStudentsRequest">
      <AssignTo createNew="true" type="request">StudentsInfoRequest</AssignTo>
      <Copy source="request">
          <QueryParams>
              <QueryParam name="school_name"/>
              <QueryParam name="id.0"/>
              <QueryParam name="id.1"/>
              <QueryParam name="id.2"/>
          </QueryParams>
      </Copy>
    </AssignMessage>
  3. Si la valeur de l'index est de 0 ou est négatif, il s'agit de la cause de l'erreur.

    Dans l'exemple de règle AssigneMessage présenté ci-dessus, vous essayez d'accéder à la première valeur du paramètre de requête "id" à l'aide de l'index 0. Par conséquent, le déploiement du proxy d'API échoue avec l'erreur suivante :

    AssignMessage[GenerateStudentsRequest]: index must be greater than zero in id.0
    

Solution

Dans la règle HTTPModifier, lorsque vous accédez à plusieurs en-têtes, paramètres de requête ou autres paramètres partageant le même nom, assurez-vous que l'index est toujours supérieur à zéro. Par exemple :

<AssignMessage name="GenerateStudentsRequest">
    <AssignTo createNew="true" type="request">StudentsInfoRequest</AssignTo>
    <Copy source="request">
        <QueryParams>
            <QueryParam name="school_name"/>
            <QueryParam name="id.1"/>
            <QueryParam name="id.2"/>
            <QueryParam name="id.3"/>
        </QueryParams>
    </Copy>
</AssignMessage>