Configuration de balises pour une étape d’API dans API Gateway

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.

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.

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, le AWS CLI/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.

Pour plus d’informations sur le balisage des ressources API Gateway, consultez Ajout de balises à vos ressources API Gateway.

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.

Configurez des balises pour une étape d'API à l'aide du AWS CLI

Vous pouvez configurer des balises pour une étape d'API à l'aide de la AWS CLI commande create-stage ou de la commande tag-resource. Vous pouvez supprimer une ou plusieurs balises d’une étape d’API à l’aide de la commande untag-resource.

La commande create-stage suivante ajoute une balise lors de la création d'une test étape :

aws apigateway create-stage --rest-api-id abc1234 --stage-name test --description 'Testing stage' --deployment-id efg456 --tag Department=Sales

La commande tag-resource suivante ajoute une balise à une prod étape :

aws apigateway tag-resource --resource-arn arn:aws:apigateway:us-east-2::/restapis/abc123/stages/prod --tags Department=Sales

La commande untag-resource suivante supprime le Department=Sales tag de la scène : 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 :

Vous pouvez également appeler tags:get 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 tags:tag. 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 stage:create pour créer l’étape :

POST /restapis/<restapi_id>/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 tags:untag :

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 tags:get:

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"
    }
}