Ressources API Gateway pouvant être balisées - APIPasserelle Amazon
Héritage de balises dans l'API Amazon API Gateway V1Restrictions liées aux balises et conventions d'utilisation

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.

Ressources API Gateway pouvant être balisées

Les balises peuvent être définies sur l'API HTTP ou les ressources WebSocket d'API suivantes dans l'API Amazon API Gateway V2 :

  • Api

  • DomainName

  • Stage

  • VpcLink

En outre, les balises peuvent être définies sur les ressources d'API REST suivantes dans l'API Amazon API Gateway V1 :

  • ApiKey

  • ClientCertificate

  • DomainName

  • RestApi

  • Stage

  • UsagePlan

  • VpcLink

Les balises ne peuvent pas être définies directement sur d'autres ressources. Cependant, dans l'API Amazon API Gateway V1, les ressources enfants héritent des balises qui sont définies sur les ressources parents. Par exemple :

  • Si une identification est définie sur une ressource RestApi, cette identification est héritée par les ressources enfants de cet élément RestApi dans le contrôle d’accès basé sur les attributs :

    • Authorizer

    • Deployment

    • Documentation

    • GatewayResponse

    • Integration

    • Method

    • Model

    • Resource

    • ResourcePolicy

    • Setting

    • Stage

  • Si une balise est définie sur une ressource DomainName, cette balise est héritée par les ressources BasePathMapping sous celle-ci.

  • Si une balise est définie sur une ressource UsagePlan, cette balise est héritée par les ressources UsagePlanKey sous celle-ci.

Note

L’héritage d’identifications s'applique uniquement au contrôle d'accès basé sur les attributs. Par exemple, vous ne pouvez pas utiliser de balises héritées pour surveiller les coûts dans AWS Cost Explorer. Pour utiliser des balises pour la répartition des coûts, nous vous recommandons de créer des balises sur les ressources enfants, telles que la Stage ressource.

API Gateway ne renvoie pas les balises héritées lorsque vous appelez GetTagsune ressource.

Héritage de balises dans l'API Amazon API Gateway V1

Auparavant, il était uniquement possible de configurer des balises sur des étapes. Maintenant que vous pouvez également les configurer sur d'autres ressources, une ressource Stage peut recevoir une balise de deux manières :

  • La balise peut être définie directement sur la ressource Stage.

  • L'étape peuvent hériter de la balise de sa ressource paren RestApi.

Si une étape reçoit une balise de ces deux manières, la balise qui a été définie directement sur l'étape est prioritaire. Par exemple, supposons qu'une étape hérite des balises suivantes de l'API REST de son parent :

{
	'foo': 'bar',
	'x':'y'
}

Supposons qu'il possède également les balises suivantes définies directement sur celle-ci :

{
	'foo': 'bar2',
	'hello': 'world'
}

Cela aurait pour effet que l'étape comporte les balises suivantes, avec les valeurs suivantes :

{
	'foo': 'bar2',
	'hello': 'world'
	'x':'y'
}

Restrictions liées aux balises et conventions d'utilisation

Les restrictions et les conventions d'utilisation suivantes s'appliquent à l'utilisation des balises avec les ressources API Gateway :

  • Chaque ressource peut avoir un maximum de 50 balises.

  • Pour chaque ressource, chaque clé de balise doit être unique, et chaque clé de balise peut avoir une seule valeur.

  • La longueur maximale des clés de balise est de 128 caractères Unicode en UTF-8.

  • La longueur maximale des valeurs de balise est de 256 caractères Unicode en UTF-8.

  • Les caractères autorisés pour les clés et les valeurs sont les lettres, les espaces et les chiffres représentables en UTF-8, ainsi que les caractères spéciaux suivants : . : + = @ _ / - (tiret). Les ressources Amazon EC2 autorisent tous les caractères.

  • Les clés et valeurs de balise sont sensibles à la casse. La bonne pratique consiste à choisir une stratégie pour mettre des balises en majuscule et mettre en œuvre cette stratégie de manière cohérente sur tous les types de ressources. Par exemple, décidez si vous souhaitez utiliser Costcenter, costcenter ou CostCenter, et utilisez la même convention pour toutes les balises. Évitez d'utiliser des balises avec une incohérence de traitement de cas similaires.

  • Le préfixe aws: est interdit pour les balises ; il est réservé à l'utilisation d' AWS . Vous ne pouvez pas modifier ni supprimer des clés ou valeurs de balise ayant ce préfixe. Les étiquettes avec ce préfixe ne sont pas comptabilisées comme vos étiquettes pour la limite de ressources.