Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Faire des demandes d'API
Les requêtes pour le Groupes de ressources AWS sont des requêtes HTTP ou HTTPS qui utilisent un verbe HTTP tel que GET ouPOST.
Points de terminaison Resource Groups
Un point de terminaison est une URL qui sert de point d'entrée à un service Web. Vous pouvez sélectionner un point de Région AWS terminaison approprié lorsque vous faites vos demandes afin de réduire le temps de latence. Pour plus d'informations sur les points de terminaison utilisés par Resource Groups, consultez Groupes de ressources AWSle Référence générale d'Amazon Web Services.
Paramètres Query (Requête)
Chaque demande de requête doit inclure des paramètres communs pour gérer l'authentification et la sélection d'une action. Pour plus d'informations, consultez la section Paramètres communs dans la référence de l'Groupes de ressources AWS API.
Certaines opérations d'API nécessitent des listes de paramètres. Ces listes sont spécifiées à l'aide de la notation suivante :
param.member.n
Les valeurs de n sont des nombres entiers commençant à 1. Toutes les listes de paramètres doivent respecter cette notation, y compris les listes qui ne contiennent qu'un seul paramètre. Une liste de paramètres de requête ressemble à l'exemple suivant.
&attribute.member.1=this &attribute.member.2=that
Identifiants de demande
Dans chaque réponse d'une API de AWS requête, il y a un ResponseMetadata élément qui contient un RequestId élément. Cette chaîne est un identifiant unique attribué pour fournir AWS des informations de suivi. Bien qu'il RequestId soit inclus dans chaque réponse, il n'est pas répertorié sur les pages de documentation de l'API individuelles afin d'améliorer la lisibilité et de réduire la redondance.
Authentification par API de requête
Vous pouvez envoyer des requêtes via HTTP ou HTTPS. Quel que soit le protocole que vous utilisez, vous devez inclure une signature dans chaque demande de requête. Pour plus d'informations sur la création et l'inclusion d'une signature, consultez la section Signature des demandes d' AWS API dans le Référence générale d'Amazon Web Services.
Bibliothèques disponibles
AWS fournit des bibliothèques, des exemples de code, des didacticiels et d'autres ressources aux développeurs de logiciels qui préfèrent créer des applications à l'aide d'API spécifiques au langage plutôt que des outils de ligne de commande et de l'API de requête. Ces bibliothèques fournissent des fonctions de base (non incluses dans les API), telles que l'authentification des demandes, les nouvelles tentatives et la gestion des erreurs, afin de faciliter le démarrage. Les bibliothèques et les ressources de Resource Groups sont disponibles pour les langages et plateformes suivants :
Pour plus d'informations sur les bibliothèques et les exemples de code dans tous les langages, voir Exemples de code et bibliothèques.
Effectuer des demandes d'API à l'aide de la méthode POST
Si vous n'utilisez aucun des AWS SDK, vous pouvez effectuer des requêtes Resource Groups via HTTP à l'aide de la méthode POST request. La POST méthode nécessite que vous spécifiiez l'opération dans l'en-tête de la demande et que vous fournissiez les données de l'opération au format JSON dans le corps de la demande.
| Nom de l’en-tête | Valeur d’en-tête |
|---|---|
Host |
Le Groupes de ressources AWS point final. Par exemple : |
X-Amz-Date |
Vous devez fournir l'horodatage dans l'en-tête HTTP Date ou dans l'en-tête AWS x-amz-date. Certaines bibliothèques clientes HTTP ne vous permettent pas de définir l'en-tête Date. Lorsqu'un en-tête x-amz-date est présent, le système ignore tout en-tête Date lors de l'authentification de la demande. L'en-tête x-amz-date doit être spécifié au format de base ISO 8601. Par exemple : |
Authorization |
Ensemble de paramètres d'autorisation AWS utilisé pour garantir la validité et l'authenticité de la demande. Pour plus d'informations sur la création de cet en-tête, voir Processus de signature de la version 4 de Signature dans le Référence générale d'Amazon Web Services. |
X-Amz-Target |
Spécifie l'espace de noms et la version de Resource Groups, ainsi que l'opération que vous souhaitez effectuer.
NotePour les Resource Groups, utilisez toujours la version Par exemple, pour appeler l'
|
Content-Type |
Spécifie le format d'entrée. Utilisez la valeur suivante.
|
Accept |
Spécifie le format de réponse. Utilisez la valeur suivante.
|
Content-Length |
Taille de la charge utile en octets. |
Content-Encoding |
Spécifie le format de codage de l'entrée et de la sortie. Utilisez la valeur suivante.
|
Voici un exemple d'en-tête pour une requête HTTP visant à créer un groupe de ressources incluant toutes les ressources baliséesStage=Test. Dans cet exemple, la Authorization ligne est encapsulée ici pour en faciliter la lecture. Ne l'inscrivez pas dans votre demande réelle.
POST / HTTP/1.1 Host: resource-groups.us-east-1.amazonaws.com X-Amz-Date: 20180112T092034Z Accept-Encoding: identity Authorization: AWS4-HMAC-SHA256 Credential=REDACTED/20220113/us-west-2/resource-groups/aws4_request, SignedHeaders=content-encoding;content-length;content-type;host;x-amz-date;x-amz-target, Signature=EXAMPLE5cb91f88f1EXAMPLEa02d3af93dEXAMPLE91e5d03588EXAMPLE88ff1d Content-Type: application/json Accept: application/json Content-Length: 283 { "Description": "Resources created for the testing stage.", "Name": "QueryGroup", "ResourceQuery": { "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[{\"Key\":\"Stage\",\"Values\":[\"Test\"]}]}", "Type": "TAG_FILTERS_1_0" }, "Tags": {"Department": "Finance"} }
