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. # Configurer des plans d'utilisation pour REST APIs dans API Gateway Avant de créer un plan d’utilisation, assurez-vous d’avoir configuré vos clés d’API. Pour de plus amples informations, veuillez consulter [Configuration des clés d'API pour REST APIs dans API Gateway](api-gateway-setup-api-keys.md). **Topics** + [Migration de votre API vers les plans d’utilisation par défaut (si nécessaire)](#api-gateway-usage-plan-migrate-to-default) + [Création d'un plan d'utilisation](#api-gateway-usage-plan-create) + [Ajout d’une étape d’API à un plan d’utilisation.](#api-gateway-usage-plan-add-stage) + [Ajout d’une clé d’API à un plan d’utilisation](#api-gateway-usage-plan-add-key) ## Migration de votre API vers les plans d’utilisation par défaut (si nécessaire) Si vous avez commencé à utiliser API Gateway *après* le déploiement de la fonction des plans d’utilisation le 11 août 2016, les plans d’utilisation seront automatiquement activés dans toutes les régions prises en charge. Si vous avez commencé à utiliser API Gateway avant cette date, vous devrez peut-être migrer vers les plans d’utilisation par défaut. Vous serez invité à définir l’option **Enable Usage Plans** (Activer les plans d’utilisation) avant d’utiliser des plans d’utilisation pour la première fois dans la région sélectionnée. Lorsque vous activez cette option, des plans d’utilisation par défaut sont créés pour chaque étape d’API unique associée aux clés d’API existantes. Dans le plan d’utilisation par défaut, aucune limitation ou limite de quota n’est définie initialement, et les associations entre les clés d’API et les étapes d’API sont copiées dans les plans d’utilisation. L’API se comporte de la même manière qu’auparavant. Toutefois, vous devez utiliser la [https://docs.aws.amazon.com/apigateway/latest/api/API_UsagePlan.html](https://docs.aws.amazon.com/apigateway/latest/api/API_UsagePlan.html)`apiStages`propriété pour associer les valeurs d'étape d'API spécifiées (`apiId`et`stage`) aux clés d'API incluses (via [https://docs.aws.amazon.com/apigateway/latest/api/API_UsagePlanKey.html](https://docs.aws.amazon.com/apigateway/latest/api/API_UsagePlanKey.html)), au lieu d'utiliser la [ApiKey](https://docs.aws.amazon.com/apigateway/latest/api/API_ApiKey.html)`stageKeys`propriété. Pour vérifier si vous avez déjà migré vers les plans d’utilisation par défaut, utilisez la commande CLI [https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-account.html](https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-account.html). Dans la sortie de la commande, la liste `features` inclut une entrée de `"UsagePlans"` lorsque les plans d’utilisation sont activés. Vous pouvez également migrer vos plans d'utilisation APIs vers les plans d'utilisation par défaut en utilisant AWS CLI ce qui suit : **Pour passer aux plans d'utilisation par défaut à l'aide du AWS CLI** 1. Appelez cette commande CLI : [https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-account.html](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-account.html). 1. Pour le paramètre `cli-input-json`, utilisez le code JSON suivant : ``` [ { "op": "add", "path": "/features", "value": "UsagePlans" } ] ``` ## Création d'un plan d'utilisation La procédure suivante explique comment créer un plan d'utilisation. ------ #### [ AWS Management Console ] **Pour créer un plan d’utilisation** 1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway) 1. Dans le panneau de navigation principal d’Amazon API Gateway, choisissez **Plans d’utilisation**, puis **Créer un plan d’utilisation**. ![\[Entités de plan d'utilisation d'API\]](http://docs.aws.amazon.com/fr_fr/apigateway/latest/developerguide/images/api-gateway-new-console-usage-plan-keys-create-setup.png) 1. Pour **Nom**, entrez un nom. 1. (Facultatif) Sous **Description**, entrez une description. 1. Par défaut, les plans d’utilisation permettent une limitation. Entrez un **Taux** et un **Débit** pour votre plan d'utilisation. Choisissez **Limitation** pour désactiver la limitation. 1. Par défaut, les plans d’utilisation activent un quota pour une période donnée. Pour **Demandes**, entrez le nombre total de demandes qu’un utilisateur peut effectuer au cours de la période de votre plan d’utilisation. Choisissez **Quota** pour désactiver le quota. 1. Choisissez **Créer un plan d’utilisation**. ------ #### [ AWS CLI ] La [create-usage-plan](https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-usage-plan.html)commande suivante crée un plan d'utilisation qui est réinitialisé au début du mois : ``` aws apigateway create-usage-plan \ --name "New Usage Plan" \ --description "A new usage plan" \ --throttle burstLimit=10,rateLimit=5 \ --quota limit=500,offset=0,period=MONTH ``` ------ #### [ REST API ] Appelez [https://docs.aws.amazon.com/apigateway/latest/api/API_CreateUsagePlan.html](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateUsagePlan.html) pour créer un plan d’utilisation. ------ ## Ajout d’une étape d’API à un plan d’utilisation. La procédure suivante explique comment ajouter une étape à un plan d’utilisation. ------ #### [ AWS Management Console ] **Pour ajouter une étape à un plan d’utilisation** 1. Sélectionnez votre plan d’utilisation. 1. Sous l’onglet **Étapes associées**, choisissez **Ajouter une étape**. ![\[Ajout d’une étape d’API à un plan d’utilisation.\]](http://docs.aws.amazon.com/fr_fr/apigateway/latest/developerguide/images/api-gateway-new-console-usage-plan-keys-create-add-stage.png) 1. Pour **API**, sélectionnez une API. 1. Pour **Étape**, sélectionnez une étape. 1. (Facultatif) Pour activer la limitation au niveau de la méthode, procédez comme suit : 1. Choisissez **Limitation au niveau de la méthode**, puis choisissez **Ajouter une méthode**. 1. Pour **Ressource**, sélectionnez une ressource dans votre API. 1. Pour **Méthode**, sélectionnez une méthode dans votre API. 1. Entrez un **Taux** et un **Débit** pour votre plan d'utilisation. 1. Choisissez **Ajouter au plan d’utilisation**. ------ #### [ AWS CLI ] La [update-usage-plan](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-usage-plan.html)commande suivante ajoute l'`Prod`étape d'une API à un plan d'utilisation : ``` aws apigateway update-usage-plan \ --usage-plan-id abc123 \ --patch-operations op="add",path="/apiStages",value="a1b1c2:Prod" ``` ------ #### [ REST API ] Appelez [https://docs.aws.amazon.com/apigateway/latest/api/API_UpdateUsagePlan.html](https://docs.aws.amazon.com/apigateway/latest/api/API_UpdateUsagePlan.html) pour mettre à jour un plan d’utilisation. ------ ## Ajout d’une clé d’API à un plan d’utilisation La procédure suivante montre comment ajouter une clé d’API à un plan d’utilisation. ------ #### [ AWS Management Console ] **Pour ajouter une clé à un plan d’utilisation** 1. Sous l’onglet **Clés d’API associées**, choisissez **Ajouter une clé d’API**. ![\[Entités de plan d'utilisation d'API\]](http://docs.aws.amazon.com/fr_fr/apigateway/latest/developerguide/images/api-gateway-new-console-usage-plan-keys-create-add-key.png) 1. 1. Pour associer une clé existante à votre plan d’utilisation, sélectionnez **Ajouter une clé existante**, puis sélectionnez votre clé existante dans le menu déroulant. 1. Pour créer une nouvelle clé d’API, sélectionnez **Créer et ajouter une clé**, puis créez une nouvelle clé. Pour plus d’informations sur la création d’une nouvelle clé, consultez [Création d’une clé d’API](api-gateway-setup-api-keys.md#api-gateway-usage-plan-create-apikey). 1. Choisissez **Ajouter une clé d’API**. ------ #### [ AWS CLI ] La [create-usage-plan-key](https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-usage-plan-key.html)commande suivante associe une clé d'API existante à un plan d'utilisation : ``` aws apigateway create-usage-plan-key \ --usage-plan-id a1b2c3 \ --key-type "API_KEY" \ --key-id aaa111bbb ``` ------ #### [ REST API ] Appelez [https://docs.aws.amazon.com/apigateway/latest/api/API_CreateUsagePlanKey.html](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateUsagePlanKey.html) pour associer une clé d’API existante à un plan d’utilisation. Vous pouvez également associer directement vos APIs clés à un plan d'utilisation lorsque vous les importez. Appelez [https://docs.aws.amazon.com/apigateway/latest/api/API_ImportApiKeys.html](https://docs.aws.amazon.com/apigateway/latest/api/API_ImportApiKeys.html) pour ajouter directement une ou plusieurs clés d’API au plan d’utilisation spécifié. La charge utile de la requête doit contenir les valeurs de clé d’API, l’identifiant du plan d’utilisation associé, les indicateurs booléens permettant d’indiquer que les clés sont activées pour le plan d’utilisation et, éventuellement, les noms et descriptions des clés d’API. L’exemple suivant de requête `apikey:import` ajoute trois clés d’API (identifiées par `key`, `name` et `description`) à un plan d’utilisation (identifié par `usageplanIds`) : ``` POST /apikeys?mode=import&format=csv&failonwarnings=fase HTTP/1.1 Host: apigateway.us-east-1.amazonaws.com Content-Type: text/csv Authorization: ... key,name, description, enabled, usageplanIds abcdef1234ghijklmnop8901234567, importedKey_1, firstone, tRuE, n371pt abcdef1234ghijklmnop0123456789, importedKey_2, secondone, TRUE, n371pt abcdef1234ghijklmnop9012345678, importedKey_3, , true, n371pt ``` En conséquence, trois ressources `UsagePlanKey` sont créées et ajoutées au plan d’utilisation `UsagePlan`. Vous pouvez également ajouter des clés d’API à plusieurs plans d’utilisation de cette façon. Pour ce faire, remplacez la valeur de chaque colonne `usageplanIds` par une chaîne indiquée entre guillemets contenant les identifiants des plans d’utilisation sélectionnés, séparés par des virgules (`"n371pt,m282qs"` ou `'n371pt,m282qs'`). ------ **Note** Une clé d'API peut être associée à plusieurs plans d'utilisation. Un plan d'utilisation peut être associé à plusieurs étapes. Toutefois, une clé d'API donnée ne peut être associée qu'à un seul plan d'utilisation pour chaque étape de votre API.