Action d'API personnalisée

Utilisez la carte Action d'API personnalisée pour effectuer une requête API personnalisée et authentifiée auprès de l'API REST AWS S3. Consultez Aperçu de l'API Rest Amazon S3.

La carte Action API personnalisée ne prend en charge que les réponses au format XML provenant de l'API. Par exemple, la carte ne peut pas télécharger le contenu d'un objet de compartiment tant que cet objet n'est pas au format XML. La réponse API est analysée au format XML et renvoyée vers le flux en tant qu'objet JSON dans la sortie Corps. Si la réponse API n'est pas au format XML, la sortie Corps est nulle.

Options

Champ Définition Type Obligatoire

Type de requête

Voici les méthodes de requête HTTP prises en charge, ou verbes HTTP, dans un appel API personnalisé (voir Méthodes de requête HTTP).

  • GET : Récupère des données d'un serveur web en fonction des paramètres. Cette méthode demande une représentation de la ressource spécifiée. Si une requête aboutit, un message de réponse 200 (OK) est renvoyé avec le contenu demandé.

  • POST : envoie des données à un serveur Web en fonction des paramètres (par exemple, le chargement d'un fichier). Plusieurs requêtes POST peuvent produire un résultat différent de celui d'une seule requête POST. Soyez prudent pour éviter d'envoyer plusieurs requêtes POST par inadvertance. Si une requête aboutit, un message de réponse 200 (OK) est renvoyé.

  • PUT : envoie des données à stocker à un emplacement spécifique sur un serveur Web en fonction des paramètres (par exemple, le chargement d'un fichier). Contrairement aux requêtes POST, les requêtes PUT sont idempotentes. Pour les requêtes réussies, le résultat d'une seule requête PUT est le même que plusieurs requêtes PUT identiques. Si une requête réussit, un message de réponse 200 (OK), 201 (Created) ou 204 (No Content) est retourné.

  • PATCH : Applique des modifications partielles à une ressource sur un serveur web en fonction des paramètres. PATCH n'est pas idempotente. Plusieurs requêtes PATCH pourraient avoir des conséquences non souhaitées. Si une requête PATCH réussit, un message de réponse 200 (OK) ou 204 (No Content) est renvoyé.

  • DELETE : supprime la ressource spécifiée (si elle existe) du serveur Web en fonction des paramètres. Si une requête DELETE aboutit, un message de réponse 200 (OK) est renvoyé.

  • HEAD : demande les en-têtes qui seraient renvoyés si l'URL de la requête HEAD était demandée, au lieu d'utiliser la méthode HTTP GET. Par exemple, si une URL est supposée générer un téléchargement volumineux, une requête HEAD pourrait lire son en-tête Content-Length pour vérifier la taille du fichier sans effectuer le téléchargement réel.

 Liste déroulante TRUE

Région

Sélectionnez la région de votre compartiment Amazon S3.

 Liste déroulante TRUE

Entrée

Champ Définition Type Obligatoire

Requête

Compartiment

Nom du compartiment à référencer dans la requête, par exemple :

GET /?list-type=2 HTTP/1.1

Host: <Bucket>.s3.amazonaws.com

Texte FALSE

URL liée

L'adresse (URL) du serveur Web que vous essayez d'appeler. Définir l'URL relative comme suit : /{insert_remaining_URL}. Utilisez une barre oblique au début de l'URL liée.

Vous pouvez spécifier les paramètres de la requête dans l'URL liée en utilisant « ? » ou spécifier les paramètres de la requête comme une paire de clés de l'objet dans l'entrée de requête.

Par exemple, pour un point de terminaison de l'API AWS S3 http://aws.s3.<region>.amazonaws.com/listobjects, l'URL relative est /listobjects.

 Texte TRUE

Requête

Indiquez tout paramètre de requête supplémentaire à inclure dans le format d'objet (paires clé-valeur).

 Objet FALSE

Corps

Spécifiez un corps de requête au format JSON.

 Objet FALSE

En-têtes

Spécifiez les en-têtes requises en plus de authorization ou content-type, car ce connecteur les gère déjà.

 Objet FALSE

Sortie

Champ Définition Type

Réponse

Code de statut

Résultat de l'opération. Le connecteur retourne un code de statut HTTP qui indique si l'action effectuée par la carte a réussi ou échoué. Par exemple :

  • Un code de statut 201 Created indique un succès où une nouvelle ressource a été créée.
  • Une erreur 403 Forbidden indique que la requête HTTP n'a pas été traitée parce que les permissions nécessaires étaient manquantes.

Pour une liste complète des codes de statut possibles, voir Codes de statut HTTP.

 Nombre

En-têtes

Contexte détaillé du code de statut, sans lien avec le corps de la sortie. Les en-têtes de réponse dépendent de l'option de requête HTTP sélectionnée. Tous les en-têtes ne sont pas des en-têtes de réponse. Ceci est semblable à {"Content-type":"application/json"}.

 Objet

Corps

Données retournées par votre requête HTTP sélectionnée.

Par exemple, les données d'une requête GET.

 Objet