ListTagResources - - Centre de documentation Alibaba Cloud

Notes d'utilisation

Spécifiez au moins l'un des paramètres ou paires de paramètres suivants dans la requête pour définir l'objet de l'interrogation :

ResourceId.N
Paire de paramètres Tag.N (Tag.N.Key et Tag.N.Value)
TagFilter.N

Si vous spécifiez l'un des ensembles de paramètres de requête suivants comme conditions de filtrage, seules les ressources ECS répondant à toutes les conditions sont renvoyées :

Ensemble 1 : Tag.N.Key, Tag.N.Value et ResourceId.N
Ensemble 2 : TagFilter.N.TagKey, TagFilter.N.TagValues.N et ResourceId.N

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ListTagResources	Opération à effectuer. Définissez la valeur sur ListTagResources.
RegionId	String	Yes	cn-hangzhou	ID de région de la ressource. Appelez l'opération DescribeRegions pour obtenir la liste des régions la plus récente.
NextToken	String	No	caeba0bbb2be03f84eb48b699f0a4883	Jeton de pagination.
ResourceType	String	Yes	instance	Type de ressource. Valeurs possibles : instance : instance disk : disque snapshot : snapshot image : image securitygroup : groupe de sécurité volume : volume de stockage eni : interface réseau élastique (ENI) 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 : politique de snapshot automatique elasticityassurance : assurance d'élasticité capacityreservation : réservation de capacité command : commande Cloud Assistant invocation : résultat d'exécution de la commande Cloud Assistant ou résultat de livraison de fichier activation : code d'activation pour l'instance gérée par Cloud Assistant managedinstance : instance gérée par Cloud Assistant
ResourceId.N	String	No	i-bp1j6qtvdm8w0z1o****	ID de la ressource N. Valeurs possibles pour N : 1 à 50.
Tag.N.Key	String	No	TestKey	Clé du tag N utilisée pour la recherche exacte des ressources ECS. La clé doit contenir entre 1 et 128 caractères. Valeurs possibles pour N : 1 à 20. Utilisation de la paire de paramètres `Tag.N` (Tag.N.Key et Tag.N.Value) : Méthode 1 : recherche exacte des ressources ECS associées à des tags spécifiques. Chaque tag est une paire clé-valeur. Si vous spécifiez uniquement `Tag.N.Key`, le système renvoie toutes les ressources ECS dont les tags contiennent la clé spécifiée. Si vous spécifiez uniquement `Tag.N.Value`, le système renvoie l'erreur `InvalidParameter.TagValue`. Si vous spécifiez plusieurs paires clé-valeur, le système ne renvoie que les ressources ECS associées à toutes ces paires. Méthode 2 : interrogation des informations sur les ressources d'un groupe de ressources non par défaut. Définissez `Key` sur `acs:rm:rgId` et `Value` sur l'ID du groupe de ressources. Si vous définissez `Key` sur `acs:rm:rgId`, vous devez définir `Value` sur l'ID d'un groupe de ressources non par défaut. Si vous définissez Value sur l'ID du groupe de ressources par défaut, un message d'erreur s'affiche. Si vous définissez `Key` sur `acs:rm:rgId`, vous ne pouvez pas spécifier d'autres paires de paramètres Tag.N. Si vous spécifiez plusieurs paires `Tag.N` pour interroger simultanément les groupes de ressources et les ressources, un message d'erreur s'affiche.
Tag.N.Value	String	No	TestValue	Valeur du tag N utilisée pour la recherche exacte des ressources ECS. La valeur doit contenir entre 1 et 128 caractères. Valeurs possibles pour N : 1 à 20. Remarque Lorsque Tag.1.Key est défini sur `acs:rm:rgId`, vous ne pouvez définir Tag.1.Value que sur l'ID d'un groupe de ressources non par défaut.
TagFilter.N.TagValues.N	String	No	TestTagFilter	Valeur du tag N utilisée pour la recherche approximative des ressources ECS. La valeur doit contenir entre 1 et 128 caractères. Valeurs possibles pour N : 1 à 5. Pour plus d'informations, consultez la description de `TagFilter.N.TagKey`.
TagFilter.N.TagKey	String	No	env	Clé du tag N utilisée pour la recherche approximative des ressources ECS. La clé doit contenir entre 1 et 128 caractères. Valeurs possibles pour N : 1 à 5. La paire de paramètres `TagFilter.N` (TagFilter.N.TagKey et TagFilter.N.TagValues.N) permet une recherche approximative des ressources ECS associées à des tags spécifiques. Une clé de tag peut correspondre à une ou plusieurs valeurs. La latence d'une recherche approximative peut atteindre 2 secondes. Le jeu de résultats peut contenir jusqu'à 5 000 entrées. Pour utiliser `TagFilter.N.TagKey` dans une recherche approximative, laissez `TagFilter.N.TagValues.N` vide. Par exemple, pour interroger les ressources ECS dont les tags contiennent la clé `environment`, définissez `TagFilter.1.TagKey` sur `env` (recherche par préfixe), `env` (recherche infixée) ou `env` (recherche exacte), mais laissez `TagFilter.1.TagValues` vide. Pour utiliser `TagFilter.N.TagValues.N` dans une recherche approximative, définissez `TagFilter.N.TagKey` sur une valeur exacte. Par exemple, pour interroger les ressources ECS possédant un tag avec la clé `env` et la valeur `product`, définissez `TagFilter.1.TagKey` sur `env` et `TagFilter.1.TagValues.1` sur `proc` (recherche par préfixe), `proc` (recherche infixée) ou `proc` (recherche exacte). Une seule méthode de recherche est autorisée par clé de tag (`TagFilter.N.TagKey`). En cas de configuration multiple, la première méthode prévaut. Si vous spécifiez plusieurs clés de tag, le système ne renvoie que les ressources ECS associées à toutes les clés spécifiées. Si vous spécifiez une clé de tag correspondant à plusieurs valeurs, le système renvoie toutes les ressources ECS associées à l'une ou plusieurs de ces paires clé-valeur. Remarque Vous ne pouvez pas utiliser conjointement la paire de paramètres `TagFilter.N` (TagFilter.N.TagKey et TagFilter.N.TagValues.N) et la paire `Tag.N` (Tag.N.Key et Tag.N.Value). Sinon, un message d'erreur s'affiche.

Paramètres de réponse

Parameter	Type	Example	Description
NextToken	String	caeba0bbb2be03f84eb48b699f0a4883	Jeton requis pour la requête suivante.
RequestId	String	484256DA-D816-44D2-9D86-B6EE4D5BA78C	ID de la requête.
TagResources	Array of TagResource		Détails sur les ressources et les tags, incluant les ID de ressource, les types de ressource et les paires clé-valeur de tag.
TagResource
TagValue	String	TestValue	Valeur de tag de la ressource.
ResourceType	String	instance	Type de ressource. Valeurs possibles : instance : instance ECS disk : disque snapshot : snapshot image : image securitygroup : groupe de sécurité volume : volume de stockage eni : ENI 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 : politique de snapshot automatique elasticityassurance : assurance d'élasticité capacityreservation : réservation de capacité command : commande Cloud Assistant invocation : résultat d'exécution de la commande Cloud Assistant
ResourceId	String	i-bp1j6qtvdm8w0z1o****	ID de la ressource.
TagKey	String	TestKey	Clé de tag.

Exemples

Exemple de requête

http(s)://ecs.aliyuncs.com/?Action=ListTagResources
&RegionId=cn-hangzhou
&ResourceType=instance
&ResourceId.1=i-bp1j6qtvdm8w0z1o****
&<Common request parameters>

Exemple de réponse réussie

Format XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTagResourcesResponse>
    <TagResources>
        <TagResource>
            <ResourceType>instance</ResourceType>
            <TagValue>TestValue</TagValue>
            <ResourceId>i-bp1j6qtvdm8w0z1o****</ResourceId>
            <TagKey>TestKey</TagKey>
        </TagResource>
    </TagResources>
    <RequestId>DE65F6B7-7566-4802-9007-96F2494AC512</RequestId>
</ListTagResourcesResponse>

Format JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TagResources" : {
    "TagResource" : [ {
      "ResourceType" : "instance",
      "TagValue" : "TestValue",
      "ResourceId" : "i-bp1j6qtvdm8w0z1o****",
      "TagKey" : "TestKey"
    } ]
  },
  "RequestId" : "DE65F6B7-7566-4802-9007-96F2494AC512"
}

Codes d'erreur

HTTP status code	Error code	Error message	Description
400	InvalidDefaultResourceGroup.NotSupported	The specified parameter Tag is not support for default resource group.	Le groupe de ressources par défaut ne peut pas être interrogé.
400	InvalidTag.NotSupported	You can only specify Tag for either resource tag or resource group.	Les groupes de ressources et les tags ne peuvent pas être interrogés simultanément.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	La clé de tag existe déjà. Les clés de tag doivent être uniques.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	Valeur Tag.N.Key non valide.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	Valeur Tag.N.Value non valide.
400	OperationDenied.QuotaExceed	The quota of tags on resource is beyond permitted range.	Le nombre maximal de tags est dépassé.
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	Les valeurs Tag.N.Key et Tag.N.Value ne correspondent pas.
400	InvalidTagCount	The specified tags are beyond the permitted range.	Le nombre maximal de tags est dépassé.
400	Invalid.Scope	The specified scope is invalid.	Valeur Scope non valide.
403	PermissionDenied.TagOwnerUid	The specified operator not have permission to set TagOwnerUid value.	Vous n'êtes pas autorisé à spécifier le paramètre TagOwnerUid.
403	PermissionDenied.Scope	The specified operator not have permission to set Scope value.	Vous n'êtes pas autorisé à spécifier le paramètre Scope.
403	InvalidResourceId.NotSupported	The specified ResourceId does not support tagging.	La ressource spécifiée ne prend pas en charge le tagging.
403	NoPermission.Tag	The operator is not permission for the tag.	Vous n'êtes pas autorisé à gérer le tag.
404	InvalidRegionId.NotFound	%s	L'ID de région spécifié est introuvable.
404	MissingParameter.ResourceType	The parameter - ResourceType should not be null.	ResourceType est requis.
404	InvalidResourceId.NotFound	The specified ResourceIds are not found in our records.	L'ID de ressource spécifié est introuvable. Vérifiez si l'ID de ressource est correct.
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.	Le type de ressource spécifié est introuvable.
404	InvalidRegionId.NotFound	The specified RegionId does not exist.	Valeur RegionId non valide.
500	ServiceUnavailable	The service is unavailable, please try again later.	Le service est temporairement indisponible. Réessayez ultérieurement.
500	InternalError	The process of creating snapshot has failed due to some unknown error.	Le snapshot ne peut pas être créé.

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.