ListTagResources - Elastic Compute Service - Centre de documentation Alibaba Cloud

Répertorie les balises d'une ou plusieurs ressources ECS.

Description de l'opération

API

Pour trouver des ressources spécifiques, incluez au moins l'un des paramètres suivants dans votre requête.

ResourceId.N
Tag.N (Tag.N.Key et Tag.N.Value)
TagFilter.N

Si vous spécifiez les combinaisons de paramètres suivantes, l'API ne renvoie que les ressources ECS qui correspondent à toutes les conditions.

Tag.N et ResourceId.N
TagFilter.N et ResourceId.N

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:ListTagResources

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région où se trouve la ressource. Vous pouvez appeler l'opération DescribeRegions pour consulter la liste la plus récente des régions d'Alibaba Cloud. DescribeRegions	cn-hangzhou
RegionId	string	Oui		cn-hangzhou
NextToken	string	Non	Le jeton de pagination pour récupérer la page de résultats suivante.	caeba0bbb2be03f84eb48b699f0a4883
ResourceType	string	Oui	Le type de ressource. Valeurs valides : instance : instance ECS disk : disque snapshot : instantané image : image securitygroup : groupe de sécurité volume : volume eni : interface réseau élastique ddh : hôte dédié ddhcluster : cluster d'hôtes dédiés keypair : paire de clés SSH launchtemplate : modèle de lancement reservedinstance : instance réservée snapshotpolicy : stratégie d'instantané elasticityassurance : Elasticity Assurance capacityreservation : réservation de capacité command : commande Cloud Assistant invocation : résultat de l'exécution d'une commande ou de la remise d'un fichier dans Cloud Assistant activation : code d'activation d'instance gérée Cloud Assistant managedinstance : instance gérée Cloud Assistant	instance
ResourceId	array	Non	L'identifiant d'une ressource ECS. La valeur de N varie de 1 à 50.	i-bp1j6qtvdm8w0z1o****
	string	Non		i-bp1j6qtvdm8w0z1o****
Tag	array<object>	Non	Une liste de balises.
	object	Non
Key	string	Non	La clé de balise à utiliser pour une correspondance exacte. La clé de balise doit comporter de 1 à 128 caractères. La valeur de N varie de 1 à 20. Notes d'utilisation pour le paramètre Tag.N : Méthode 1 : pour trouver des ressources ECS possédant des balises spécifiques. Si vous spécifiez uniquement Tag.N.Key, l'opération renvoie toutes les ressources possédant la clé de balise spécifiée. Si vous spécifiez uniquement Tag.N.Value, l'opération renvoie une erreur InvalidParameter.TagValue. Si vous spécifiez plusieurs paires clé-valeur de balise, l'opération renvoie uniquement les ressources ECS qui correspondent à toutes les paires spécifiées. Méthode 2 : pour interroger des ressources dans un groupe de ressources non par défaut. Si vous définissez Key sur acs:rm:rgId, vous devez définir Value sur l'identifiant d'un groupe de ressources non par défaut. Si vous spécifiez l'identifiant du groupe de ressources par défaut, l'opération renvoie une erreur. Si vous définissez Key sur acs:rm:rgId, vous ne pouvez pas spécifier d'autres paires clé-valeur de balise. Si vous utilisez plusieurs paramètres Tag.N pour interroger des ressources à la fois par groupe de ressources et par balise, l'opération renvoie une erreur.	TestKey
Value	string	Non	La valeur de balise à utiliser pour une correspondance exacte. La valeur de balise doit comporter de 1 à 128 caractères. La valeur de N varie de 1 à 20. Remarque Lorsque Key est acs:rm:rgId, vous devez définir ce paramètre sur l'identifiant d'un groupe de ressources non par défaut.	TestValue
TagFilter	array<object>	Non	Une liste de filtres de balises. Remarque Ce paramètre est en avant-première sur invitation uniquement et n'est pas encore disponible.
	object	Non
TagValues	array	Non	Les valeurs de balise à utiliser pour une correspondance approximative. La valeur de balise doit comporter de 1 à 128 caractères. La valeur de N varie de 1 à 5. Pour plus d'informations, consultez la description du paramètre TagFilter.N.TagKey.	TestTagFilter
	string	Non		TestTagFilter
TagKey	string	Non	La clé de balise à utiliser pour une correspondance approximative. La clé de balise doit comporter de 1 à 128 caractères. La valeur de N varie de 1 à 5. Utilisez le paramètre TagFilter.N pour effectuer une correspondance approximative sur les balises afin de trouver les ressources ECS correspondantes. Chaque filtre se compose d'une clé et d'une ou plusieurs valeurs. Une correspondance approximative peut avoir une latence de 2 secondes et n'est prise en charge que pour les requêtes qui renvoient 5 000 ressources ou moins après filtrage. Pour effectuer une correspondance approximative par clé de balise (TagFilter.N.TagKey), vous devez laisser les valeurs de balise (TagFilter.N.TagValues.N) vides. Par exemple, pour rechercher des ressources ECS possédant la clé de balise environment, vous pouvez définir TagFilter.1.TagKey sur env* (correspondance de préfixe), env (correspondance de sous-chaîne) ou env (correspondance exacte), mais vous devez laisser TagFilter.1.TagValues vide. Pour effectuer une correspondance approximative par valeur de balise (TagFilter.N.TagValues.N), vous devez définir la clé de balise (TagFilter.N.TagKey) sur une valeur exacte. Par exemple, pour rechercher des ressources ECS avec la clé de balise env et la valeur de balise product, vous devez définir TagFilter.1.TagKey sur env. Vous pouvez ensuite définir TagFilter.1.TagValues.1 sur proc* (correspondance de préfixe), proc (correspondance de sous-chaîne) ou proc (correspondance exacte). Pour le même TagKey, vous ne pouvez utiliser qu'un seul modèle de recherche. Si vous spécifiez plusieurs modèles, le système utilise uniquement le premier modèle. Les clés de balise sont combinées à l'aide d'un ET logique. L'opération renvoie uniquement les ressources ECS qui correspondent à toutes les clés de balise spécifiées. Les valeurs de balise pour la même clé de balise sont combinées à l'aide d'un OU logique. L'opération renvoie les ressources ECS qui correspondent à l'une des valeurs de balise spécifiées pour cette clé de balise. Remarque Vous ne pouvez pas spécifier à la fois les paramètres TagFilter.N et Tag.N dans la même requête.	env

Éléments de réponse

Élément	Type	Description	Exemple
	object
NextToken	string	Le jeton pour récupérer la page de résultats suivante.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	L'identifiant de la requête.	484256DA-D816-44D2-9D86-B6EE4D5BA78C
TagResources	object
TagResource	array<object>	Un tableau de balises et de leurs ressources associées. Chaque objet du tableau contient l'identifiant de la ressource, le type de ressource, la clé de balise et la valeur de balise.
	object
TagValue	string	The tag value.	TestValue
ResourceType	string	The resource type. Valid values: `instance`: An ECS instance. `disk`: A disk. `snapshot`: A snapshot. `image`: An image. `securitygroup`: A security group. `volume`: A volume. `eni`: An elastic network interface. `ddh`: A dedicated host. `ddhcluster`: A dedicated host cluster. `keypair`: An SSH key pair. `launchtemplate`: A launch template. `reservedinstance`: A reserved instance. `snapshotpolicy`: An automatic snapshot policy. `elasticityassurance`: An elasticity assurance. `capacityreservation`: A capacity reservation. `command`: A Cloud Assistant command. `invocation`: The result of a Cloud Assistant command execution. `activation`: An activation code for a managed instance. `managedinstance`: A managed instance.	instance
ResourceId	string	The resource ID.	i-bp1j6qtvdm8w0z1o****
TagKey	string	The tag key.	TestKey

Exemples

JSON format

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "484256DA-D816-44D2-9D86-B6EE4D5BA78C",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "TestValue",
        "ResourceType": "instance",
        "ResourceId": "i-bp1j6qtvdm8w0z1o****",
        "TagKey": "TestKey"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidDefaultResourceGroup.NotSupported	The specified parameter Tag is not support for default resource group.	The default resource group cannot be queried.
400	InvalidTag.NotSupported	You can only specify Tag for either resource tag or resource group.	Resource groups and tags cannot be queried at the same time.
400	NumberExceed.ResourceIds	The ResourceIds parameter's number is exceed , Valid : 50.	The number of ResourceIds parameters specified exceeds the limit.
400	NumberExceed.Tags	The Tags parameter's number is exceed , Valid : 20.	The number of labels specified exceeds the limit.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	The specified tag key already exists. Tag keys must be unique.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	The specified Tag.N.Key parameter is invalid.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	The specified tag value is invalid.
400	OperationDenied.QuotaExceed	The quota of tags on resource is beyond permitted range.
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	The specified Tag.N.Key and Tag.N.Value parameters do not correspond to each other.
400	InvalidTagCount	The specified tags are beyond the permitted range.	The number of specified tags exceeds the upper limit.
400	Invalid.Scope	The specified scope is invalid.
400	InvalidTags.MalFormed	The tags must be empty, when the tagFilters is not empty.
500	ServiceUnavailable	The service is unavailable, please try again later.
500	InternalError	The process of creating snapshot has failed due to some unknown error.	The snapshot cannot be created.
403	PermissionDenied.TagOwnerBid	The specified operator not have permission to set TagOwnerBid value.
403	PermissionDenied.TagOwnerUid	The specified operator not have permission to set TagOwnerUid value.	You are not authorized to specify the TagOwnerUid parameter.
403	PermissionDenied.Scope	The specified operator not have permission to set Scope value.	You are not authorized to specify the Scope parameter.
403	InvalidResourceId.NotSupported	The specified ResourceId does not support tagging.
403	NoPermission.Tag	The operator is not permission for the tag.	You are not authorized to manage the tag.
403	BothEmpty.TagsAndResources	The specified Tags and ResourcesIds are not allow to both empty.	The parameter passed in must contain Tags or
403	PermissionDenied.TagsFuzzyQuery	The specified operator has not permission to query fuzzy tags.
403	NumberExceed.TagValues	The number of the specified TagValues is beyond permitted range, the max is 5.
403	InvalidFilter.Malformed	The specified Filter is not valid.
403	InvalidTagFilter.Malformed	The specified TagFilter is not valid.
403	Invalid.NextToken	The specified NextToken is not valid.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Region information error
404	MissingParameter.ResourceIds	The parameter - ResourceIds.N should not be null.
404	MissingParameter.TagOwnerUid	The parameter - TagOwnerUid should not be null.
404	MissingParameter.TagOwnerBid	The parameter - TagOwnerBid should not be null.
404	MissingParameter.ResourceType	The parameter - ResourceType should not be null.	The ResourceType parameter is required.
404	MissingParameter.Tags	The parameter - Tags should not be null.
404	MissingParameter.RegionId	The parameter - RegionId should not be null.
404	InvalidResourceId.NotFound	The specified ResourceIds are not found in our records.	The specified resource does not exist. Check whether the ResourceId parameter is correct.
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.