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.
# Configuration de balises pour une étape d’API dans API Gateway
Dans API Gateway, vous pouvez ajouter une balise à une étape d’API, supprimer la balise de l’étape ou afficher la balise. Pour ce faire, vous pouvez utiliser la console API Gateway, l’AWS CLI/le kit SDK ou l’API REST API Gateway.
Une étape peut également hériter des balises de son API REST parente. Pour de plus amples informations, veuillez consulter [Héritage de balises dans l’API Amazon API Gateway V1](apigateway-tagging-supported-resources.md#apigateway-tagging-inheritance).
Pour plus d’informations sur le balisage des ressources API Gateway, consultez [Ajout de balises à vos ressources API Gateway](apigateway-tagging.md).
**Topics**
+ [Configuration des balises pour une étape d’API à l’aide de la console API Gateway](#set-up-tags-using-console)
+ [Configuration de balises pour une étape d’API à l’aide de l’AWS CLI](#set-up-tags-using-cli)
+ [Configuration des balises pour une étape d’API à l’aide de l’API REST API Gateway](#set-up-tags-using-api)
## Configuration des balises pour une étape d’API à l’aide de la console API Gateway
La procédure suivante explique comment configurer des balises pour une étape d’API.
**Pour configurer les balises pour une étape d’API à l’aide de la console API Gateway**
1. Connectez-vous à la console API Gateway.
1. Choisissez une API existante ou créez-en une qui comporte des ressources, des méthodes et les intégrations correspondantes.
1. Choisissez une étape ou déployez l’API dans une nouvelle étape.
1. Dans le volet de navigation principal, choisissez **Étapes**.
1. Sélectionnez l’onglet **Tags** (Identifications). Vous devrez peut-être choisir la flèche droite pour afficher l’onglet.
1. Choisissez **Gérer les balises**.
1. Dans **Éditeur de balise**, choisissez **Ajouter une balise**. Entrez une clé de balise (par exemple, `Department`) dans le champ **Key (Clé)**, puis entrez une valeur de balise (par exemple, `Sales`) dans le champ colonne **Value (Valeur)**. Choisissez **Enregistrer** pour enregistrer la balise.
1. Si nécessaire, répétez l’étape 5 pour ajouter des balises supplémentaires à l’étape d’API. Le nombre maximal de balises par étape est de 50.
1. Pour supprimer une balise existante de l’étape, choisissez **Supprimer**.
1. Si l’API a déjà été déployée dans la console API Gateway, vous devez la redéployer pour que les changements prennent effet.
## Configuration de balises pour une étape d’API à l’aide de l’AWS CLI
Vous pouvez configurer des balises pour une étape d’API à l’aide de l’AWS CLI en utilisant la commande [create-stage](https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-stage.html) ou [tag-resource](https://docs.aws.amazon.com/cli/latest/reference/apigateway/tag-resource.html). Vous pouvez supprimer une ou plusieurs balises d’une étape d’API à l’aide de la commande [untag-resource](https://docs.aws.amazon.com/cli/latest/reference/apigateway/untag-resource.html).
La commande [create-stage](https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-stage.html) suivante ajoute une balise lors de la création d’une étape `test` :
```
aws apigateway create-stage --rest-api-id abc1234 --stage-name test --description 'Testing stage' --deployment-id efg456 --tag Department=Sales
```
La commande [tag-resource](https://docs.aws.amazon.com/cli/latest/reference/apigateway/tag-resource.html) suivante ajoute une balise à une étape `prod` :
```
aws apigateway tag-resource --resource-arn arn:aws:apigateway:us-east-2::/restapis/abc123/stages/prod --tags Department=Sales
```
La commande [untag-resource](https://docs.aws.amazon.com/cli/latest/reference/apigateway/untag-resource.html) suivante supprime la balise `Department=Sales` de l’étape `test` :
```
aws apigateway untag-resource --resource-arn arn:aws:apigateway:us-east-2::/restapis/abc123/stages/test --tag-keys Department
```
## Configuration des balises pour une étape d’API à l’aide de l’API REST API Gateway
Vous pouvez configurer des balises pour une étape d’API à l’aide de l’API REST API Gateway en effectuant l’une des actions suivantes :
+ Appelez [https://docs.aws.amazon.com/apigateway/latest/api/API_TagResource.html](https://docs.aws.amazon.com/apigateway/latest/api/API_TagResource.html) pour baliser une étape d’API.
+ Appelez [https://docs.aws.amazon.com/apigateway/latest/api/API_UntagResource.html](https://docs.aws.amazon.com/apigateway/latest/api/API_UntagResource.html) pour supprimer une ou plusieurs balises d’une étape d’API.
+ Appelez [https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html) pour ajouter une ou plusieurs balises à une étape d’API que vous êtes en train de créer.
Vous pouvez également appeler [https://docs.aws.amazon.com/apigateway/latest/api/API_GetTags.html](https://docs.aws.amazon.com/apigateway/latest/api/API_GetTags.html) pour décrire les balises d’une étape d’API.
### Balisage d’une étape d’API
Une fois que vous avez déployé une API (`m5zr3vnks7`) sur une étape (`test`), balisez cette dernière en appelant [https://docs.aws.amazon.com/apigateway/latest/api/API_TagResource.html](https://docs.aws.amazon.com/apigateway/latest/api/API_TagResource.html). L’ARN (Amazon Resource Name) obligatoire de l’étape (`arn:aws:apigateway:us-east-1::/restapis/m5zr3vnks7/stages/test`) doit être encodé en URL (`arn%3Aaws%3Aapigateway%3Aus-east-1%3A%3A%2Frestapis%2Fm5zr3vnks7%2Fstages%2Ftest`).
```
PUT /tags/arn%3Aaws%3Aapigateway%3Aus-east-1%3A%3A%2Frestapis%2Fm5zr3vnks7%2Fstages%2Ftest
{
"tags" : {
"Department" : "Sales"
}
}
```
Vous pouvez également utiliser la demande précédente pour mettre à jour une balise existante avec une nouvelle valeur.
Vous pouvez ajouter des balises à une étape lorsque vous appelez [https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html) pour créer l’étape :
```
POST /restapis//stages
{
"stageName" : "test",
"deploymentId" : "adr134",
"description" : "test deployment",
"cacheClusterEnabled" : "true",
"cacheClusterSize" : "500",
"variables" : {
"sv1" : "val1"
},
"documentationVersion" : "test",
"tags" : {
"Department" : "Sales",
"Division" : "Retail"
}
}
```
### Suppression du balisage d’une étape d’API
Pour supprimer la balise `Department` de l’étape, appelez [https://docs.aws.amazon.com/apigateway/latest/api/API_UntagResource.html](https://docs.aws.amazon.com/apigateway/latest/api/API_UntagResource.html) :
```
DELETE /tags/arn%3Aaws%3Aapigateway%3Aus-east-1%3A%3A%2Frestapis%2Fm5zr3vnks7%2Fstages%2Ftest?tagKeys=Department
Host: apigateway.us-east-1.amazonaws.com
Authorization: ...
```
Pour supprimer plusieurs balises, utilisez une liste de clés de balise séparées par des virgules dans l’expression de requête : par exemple, `?tagKeys=Department,Division,…`.
### Description des balises d’une étape d’API
Pour décrire les balises existantes au niveau d’une étape donnée, appelez [https://docs.aws.amazon.com/apigateway/latest/api/API_GetTags.html](https://docs.aws.amazon.com/apigateway/latest/api/API_GetTags.html):
```
GET /tags/arn%3Aaws%3Aapigateway%3Aus-east-1%3A%3A%2Frestapis%2Fm5zr3vnks7%2Fstages%2Ftags
Host: apigateway.us-east-1.amazonaws.com
Authorization: ...
```
La réponse positive est semblable à ce qui suit :
```
200 OK
{
"_links": {
"curies": {
"href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-tags-{rel}.html",
"name": "tags",
"templated": true
},
"tags:tag": {
"href": "/tags/arn%3Aaws%3Aapigateway%3Aus-east-1%3A%3A%2Frestapis%2Fm5zr3vnks7%2Fstages%2Ftags"
},
"tags:untag": {
"href": "/tags/arn%3Aaws%3Aapigateway%3Aus-east-1%3A%3A%2Frestapis%2Fm5zr3vnks7%2Fstages%2Ftags{?tagKeys}",
"templated": true
}
},
"tags": {
"Department": "Sales"
}
}
```