415 Types de support non pris en charge - Encodage non pris en charge

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

Problème constaté

En réponse à des appels d'API, l'application cliente obtient un code d'état HTTP 415 Unsupported Media Type avec le code d'erreur protocol.http.UnsupportedEncoding .

Message d'erreur

L'application cliente reçoit le code de réponse suivant:

HTTP/1.1 415 Unsupported Media Type

En outre, un message d'erreur semblable à celui présenté ci-dessous peut s'afficher:

{
   "fault":{
      "faultstring":"Unsupported Encoding \"UTF-8\"",
      "detail":{
         "errorcode":"protocol.http.UnsupportedEncoding"
      }
   }
}

Causes possibles

Cette erreur se produit si la valeur de l'en-tête Content-Encoding spécifiée dans la requête HTTP envoyée par le client à Apigee ou dans la réponse HTTP envoyée par le serveur backend à Apigee ne contient pas l'encodage accepté par Apigee, conformément à la spécification RFC 7231, section 6.5.13: 415 Unsupported Media Type.

Causes possibles de cette erreur:

Cause	Description	Instructions de dépannage applicables
Encodage non compatible utilisé dans la requête	L'en-tête de requête Content-Encoding contient un encodage qui n'est pas pris en charge par Apigee Edge.	Utilisateurs Edge Public and Private Cloud
Encodage non compatible utilisé dans la réponse	L'en-tête de réponse du serveur backend Content-Encoding contient un encodage qui n'est pas pris en charge par Apigee Edge.	Utilisateurs Edge Public and Private Cloud

Étapes de diagnostic courantes

Pour diagnostiquer l'erreur, vous pouvez utiliser l'une des méthodes suivantes:

Cause: encodage non accepté dans la requête

Diagnostic

1. Déterminez le code d'erreur et la source de l'erreur de l'erreur observée à l'aide de l'API Monitoring ou des journaux d'accès NGINX, comme expliqué dans la section Étapes de diagnostic courantes.
2. Si le code d'erreur est protocol.http.UnsupportedEncoding et que la source d'erreur a la valeur apigee ou MP, cela signifie que la requête envoyée par l'application cliente contient un encodage non compatible dans l'en-tête de requête Content-Encoding.
3. Vous pouvez déterminer la valeur de l'encodage non accepté transmis dans la requête HTTP à l'aide de l'une des méthodes suivantes:

   Message d'erreur

   Utilisation du message d'erreur:

   1. Si vous avez accès au message d'erreur complet reçu d'Apigee Edge, reportez-vous au faultstring. faultstring contient la valeur du codage de fin non compatible.

      Exemple de message d'erreur:

      "faultstring":"Unsupported Encoding \"UTF-8\""
      

   2. Dans le message d'erreur ci-dessus, notez que la valeur de l'encodage non compatible est “UTF-8”, comme indiqué dans faultstring.

      Étant donné que “UTF-8” n'est pas un encodage compatible dans Apigee Edge, cette requête échoue et renvoie l'erreur 415 Unsupported Media Type avec le code d'erreur suivant : protocol.http.UnsupportedEncoding.

   Demande réelle

   Avec la requête réelle:

   1. Si vous n'avez pas accès à la requête réelle envoyée par l'application cliente, passez à la section Résolution.
   2. Si vous avez accès à la requête réelle envoyée par l'application cliente, procédez comme suit :
      1. Déterminer la valeur transmise à l'en-tête de requête Content-Encoding.
      2. Si la valeur transmise à l'en-tête de requête Content-Encoding n'est pas l'une des valeurs listées dans Encodage compatible, c'est la cause de cette erreur.

         Exemple de requête:

         curl -v "https://HOSTALIAS/v1/testgzip" -H "Content-Encoding: UTF-8" -X POST -d @request_payload.gz
         

         L'exemple de requête ci-dessus envoie la valeur "UTF-8" à l'en-tête Content- Encoding, qui n'est pas un encodage compatible dans Apigee Edge. Par conséquent, cette requête échoue avec une erreur 415 Unsupported Media Type avec le code d'erreur suivant : protocol.http.UnsupportedEncoding.

Résolution

1. Reportez-vous à la liste des encodages acceptés par Apigee dans Encodage compatible.
2. Assurez-vous que l'application cliente envoie toujours les éléments suivants :
   • Seul l'encodage compatible comme valeur de l'en-tête Content-Encoding dans la requête
   • La charge utile de la requête au format compatible avec Apigee Edge et correspond au format spécifié dans l'en-tête Content-Encoding.

3. Dans l'exemple ci-dessus, la charge utile de la requête comporte une extension gz, qui indique que le contenu doit être gzip. Vous pouvez résoudre le problème en envoyant l'en-tête de requête en tant que Content-Encoding: gzip et la charge utile de la requête au format gzip:

   curl -v "https://HOSTALIAS/v1/testgzip" -H "Content-Encoding: gzip" -X POST -d @request_payload.gz
   

Cause: encodage non accepté dans la réponse

Diagnostic

1. Déterminez le code d'erreur et la source de l'erreur de l'erreur observée à l'aide de la surveillance d'API, de l'outil Trace ou des journaux d'accès NGINX, comme expliqué dans la section Étapes de diagnostic courantes.
2. Si la valeur de Fault Source est target, cela signifie que la réponse envoyée par le serveur backend contient un encodage non compatible dans l'en-tête Content-Encoding.
3. Vous pouvez déterminer la valeur de l'encodage non accepté transmis dans la réponse HTTP du serveur backend à l'aide de l'une des méthodes suivantes:

   Message d'erreur

   Utilisation du message d'erreur:

   1. Si vous avez accès au message d'erreur complet reçu d'Apigee Edge, reportez-vous au faultstring. faultstring contient la valeur de l'encodage non compatible.

      Exemple de message d'erreur:

      "faultstring":"Unsupported Encoding \"UTF-8\""
      

   2. Dans le message d'erreur ci-dessus, notez que la valeur de l'encodage non compatible est “UTF-8”, comme indiqué dans faultstring.

      Étant donné que “UTF-8” n'est pas un encodage compatible dans Apigee Edge, cette requête échoue avec une erreur 415 Unsupported Media Type avec le code d'erreur : protocol.http.UnsupportedEncoding.

   Outil de traçage

   Utiliser Trace:

   1. Si vous ne disposez pas de la trace de la requête ayant échoué, accédez à Résolution.
   2. Si vous avez capturé une trace de l'échec, vous pouvez déterminer l'encodage non compatible transmis par le serveur backend dans l'en-tête de réponse Content-Encoding, comme expliqué dans l'outil de traçage.

Résolution

1. Reportez-vous à la liste des encodages acceptés par Apigee dans Encodage compatible.
2. Assurez-vous que le serveur backend envoie toujours les éléments suivants :
   • Seul l'encodage compatible comme valeur de l'en-tête Content-Encoding de la requête
   • La charge utile de réponse au format compatible avec Apigee Edge et correspond au format spécifié dans l'en-tête Content-Encoding

Encodage compatible

Le tableau suivant répertorie le format d'encodage accepté par Apigee Edge:

En-tête	Encodage	Description
Content-Encoding	gzip	Le format Unix gzip
	deflate	Ce format utilise une structure zlib avec un algorithme de compression "Deflate".

Spécification

Apigee renvoie la réponse d'erreur 415 Unsupported Media Type conformément à la spécification RFC suivante:

Spécification
RFC 7231, section 6.5.13: 415 Unsupported Media Type

Points clés à noter

Veuillez noter les points suivants :

• Si Apigee renvoie l'erreur 415 en raison d'un encodage non accepté transmis dans l'en-tête Content-Encoding lors de la requête API :
  • Vous ne pourrez pas capturer la trace de ces requêtes.

  • Vous ne pourrez pas modifier le format ni le contenu de la réponse d'erreur envoyée par Apigee Edge à l'aide de stratégies telles que AugmentFault et AffectMessage.

  En effet, cette erreur se produit à une phase précoce du processeur de messages avant qu'une stratégie puisse être exécutée.

• Si l'erreur 415 est renvoyée par Apigee en raison d'un encodage non accepté transmis dans l'en-tête de réponse à partir de votre serveur backend, elle doit être corrigée sur le serveur backend pour éviter cette erreur. Si nécessaire, veuillez vous adresser à votre équipe backend pour résoudre ce problème.

Si vous avez encore besoin de l'aide de l'assistance Apigee Edge, consultez la section Vous devez recueillir des informations de diagnostic.

Vous devez collecter des informations de diagnostic

Si vous avez toujours besoin d'aide de l'assistance Apigee, rassemblez les informations de diagnostic suivantes, puis contactez l'assistance Apigee Edge:

Si vous êtes un utilisateur de cloud public, fournissez les informations suivantes:

• Le nom de l'organisation.
• Nom de l'environnement
• Nom du proxy d'API
• Complétez la commande curl permettant de reproduire l'erreur 415.
• Fichier de suivi des requêtes API

Si vous êtes un utilisateur du Private Cloud, fournissez les informations suivantes:

• Message d'erreur complet observé pour les requêtes ayant échoué
• Nom de l'environnement
• Groupe de proxys d'API
• Fichier de suivi des requêtes API

• Journaux d'accès NGINX /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log

  Où:ORG, ENV et PORT# sont remplacés par des valeurs réelles.

• Journaux système du processeur de messages /opt/apigee/var/log/edge-message- processor/logs/system.log