DescribeTags - Elastic Compute Service - Centre de documentation Alibaba Cloud

Consulte les balises disponibles pour vous. Vous pouvez effectuer une requête conditionnelle pour les balises en fonction du type de ressource, de l'identifiant de la ressource, de la clé de balise ou de la valeur de balise. Les conditions de filtrage sont évaluées à l'aide d'un opérateur logique ET (&&), et seules les balises qui remplissent toutes les conditions de filtrage sont renvoyées.

Remarque

Cette API est obsolète. Nous recommandons de migrer vers Tag(2018-08-28) - CountResourcesByTags pour bénéficier de fonctionnalités améliorées et d'un support continu. L'API obsolète reste temporairement accessible, mais aucune mise à jour ni correction de bug ne sera fournie.

Description de l'opération

Si vous spécifiez une clé de balise (Tag.N.Key) sans spécifier de valeur de balise (Tag.N.Value), toutes les paires clé-valeur de balise associées à la clé de balise sont renvoyées. Si vous spécifiez une paire clé-valeur de balise, seule la balise qui correspond exactement à la paire clé-valeur est renvoyée.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

ecs:DescribeTags

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
PageSize	integer	Non	Le nombre d'entrées par page pour une requête paginée. Valeur maximale : 100. Valeur par défaut : 50.	50
PageNumber	integer	Non	Le numéro de page de la liste des balises. Valeur minimale : 1. Valeur par défaut : 1.	1
ResourceType	string	Non	Le type de ressource. Valeurs valides : instance : instance ECS. disk : disque cloud. snapshot : instantané. image : image. securitygroup : groupe de sécurité. volume : volume de stockage. eni : interface réseau (NIC). ddh : hôte dédié. keypair : paire de clés SSH. launchtemplate : modèle de lancement. reservedinstance : instance réservée. snapshotpolicy : stratégie d'instantané automatique. Toutes les valeurs valides sont en minuscules.	snapshot
ResourceId	string	Non	L'identifiant de la ressource à laquelle la balise est attachée. Par exemple, si le type de ressource (ResourceType) est instance, l'identifiant de la ressource est l'identifiant de l'instance.	s-946ntx4wr****
RegionId	string	Oui	L'identifiant de la région. Vous pouvez appeler DescribeRegions pour consulter la liste des régions la plus récente.	cn-hangzhou
Category	string	Non	Remarque Ce paramètre est sur le point d'être obsolète. Pour garantir la compatibilité, utilisez d'autres paramètres.	null
Tag	array<object>	Non	La liste des balises.
	object	Non	La liste des balises.
key	string	Non	La clé de balise de la ressource. Remarque Pour garantir la compatibilité, utilisez le paramètre Tag.N.Key.	testkey
Key	string	Non	La clé de balise de la ressource. Valeurs valides de N : 1 à 20. La clé de balise ne peut pas être une chaîne vide. La clé de balise peut comporter jusqu'à 64 caractères et ne peut pas commencer par aliyun ou acs:. La clé de balise ne peut pas contenir http:// ou https://.	TestKey
Value	string	Non	La valeur de balise de la ressource. Valeurs valides de N : 1 à 20. La valeur de balise peut être une chaîne vide. La valeur de balise peut comporter jusqu'à 128 caractères et ne peut pas commencer par aliyun ou acs:. La valeur de balise ne peut pas contenir http:// ou https://.	TestValue
value	string	Non	La valeur de balise de la ressource. Remarque Pour garantir la compatibilité, utilisez le paramètre Tag.N.Value.	testvalue

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	B04B8CF3-4489-432D-83BA-6F128E4F2295
PageSize	integer	Le paramètre du nombre d'entrées par page pour la requête paginée. Il s'agit de la taille de pagination.	50
PageNumber	integer	Le numéro de page de la liste des balises.	1
TotalCount	integer	Le nombre total de balises.	1
Tags	object
Tag	array<object>	Les balises qui remplissent toutes les conditions de filtrage.
	array<object>	Les balises qui remplissent toutes les conditions de filtrage.
TagValue	string	The tag value.	TestValue
TagKey	string	The tag key.	TestKey
ResourceTypeCount	object	The number of resource types.
Instance	integer	The number of instances to which the tag is attached.	45
Image	integer	The number of images to which the tag is attached.	6
Ddh	integer	The number of dedicated hosts to which the tag is attached.	1
SnapshotPolicy	integer	The number of automatic snapshot policies to which the tag is attached.	4
Securitygroup	integer	The number of security groups to which the tag is attached.	4
Snapshot	integer	The number of snapshots to which the tag is attached.	15
ReservedInstance	integer	The number of reserved instances to which the tag is attached.	4
LaunchTemplate	integer	The number of launch templates to which the tag is attached.	6
Eni	integer	The number of Elastic Network Interfaces (ENIs) to which the tag is attached.	5
Disk	integer	The number of cloud disks to which the tag is attached.	15
KeyPair	integer	The number of key pairs to which the tag is attached.	17
Volume	integer	The number of storage volumes to which the tag is attached.	6

Exemples

JSON format

{
  "RequestId": "B04B8CF3-4489-432D-83BA-6F128E4F2295",
  "PageSize": 50,
  "PageNumber": 1,
  "TotalCount": 1,
  "Tags": {
    "Tag": [
      {
        "TagValue": "TestValue",
        "TagKey": "TestKey",
        "ResourceTypeCount": {
          "Instance": 45,
          "Image": 6,
          "Ddh": 1,
          "SnapshotPolicy": 4,
          "Securitygroup": 4,
          "Snapshot": 15,
          "ReservedInstance": 4,
          "LaunchTemplate": 6,
          "Eni": 5,
          "Disk": 15,
          "KeyPair": 17,
          "Volume": 6
        }
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidTagCount	The specified tags are beyond the permitted range.	The number of specified tags exceeds the upper limit.
400	InvalidTagKey.Malformed	The parameter Tag.n.Key is illegal.	The specified Tag.N.Key parameter is invalid.
400	InvalidTagValue.Malformed	The parameter Tag.n.Value is illegal.	The specified Tag.N.Value parameter is invalid.
400	Invalid.TagCategory	The parameter Category is illegal.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.	The specified region ID does not exist.
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.	The specified resource type does not exist.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.