DescribeTags - Virtual Private Cloud - Centre de documentation Alibaba Cloud

Consulte la liste des balises répondant aux conditions de filtrage spécifiées.

Description de l'opération

Spécifiez au moins ResourceId.N ou Tag.N (Tag.N.Key et Tag.N.Value) dans la requête pour déterminer les objets à interroger.
Tag.N est une balise de ressource et se compose d'une paire clé-valeur. Si vous spécifiez uniquement Tag.N.Key, toutes les valeurs de balise associées à la clé de balise sont renvoyées. Si vous spécifiez uniquement Tag.N.Value, une erreur est renvoyée.
Si vous spécifiez à la fois Tag.N et ResourceId.N pour filtrer les balises, ResourceId.N doit correspondre à l'une des paires clé-valeur de balise spécifiées.
Si vous spécifiez plusieurs paires clé-valeur de balise, les résultats contiennent toutes les balises qui correspondent à l'une des paires clé-valeur de balise.

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.

vpc:DescribeTags

get

*All Resource

*

vpc:tag

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ResourceType	string	Non	Le type de ressource. Valeurs valides : VPC : instance de cloud privé virtuel (VPC). VSWITCH : instance de commutateur virtuel. ROUTETABLE : instance de table de routage. EIP : instance d'adresse IP élastique (EIP). VPNGATEWAY : instance de passerelle VPN. NATGATEWAY : instance de passerelle NAT. COMMONBANDWIDTHPACKAGE : instance de bande passante partagée Internet. PREFIXLIST : instance de liste de préfixes. PUBLICIPADDRESSPOOL : instance de pool d'adresses IP. IPV4GATEWAY : instance de passerelle IPv4. IPV6GATEWAY : instance de passerelle IPv6. NETWORKACL : instance d'ACL réseau. TRAFFICMIRRORFILTER : instance de filtre de miroir de trafic. TRAFFICMIRRORSESSION : instance de session de miroir de trafic. FLOWLOG : instance de journal de flux. HAVIP : instance d'adresse IP virtuelle haute disponibilité. DHCPOPTIONSSET : instance d'ensemble d'options DHCP. GATEWAYENDPOINT : instance de point de terminaison de passerelle. Remarque La valeur du type de ressource n'est pas sensible à la casse.	VPC
RegionId	string	Oui	L'identifiant de la région de la ressource. Vous pouvez appeler l'opération DescribeRegions pour obtenir l'identifiant de la région.	cn-hangzhou
NextToken	string	Non	Le jeton de pagination. Valeurs valides : S'il s'agit de la première requête ou s'il n'existe aucune requête ultérieure, laissez ce paramètre vide. S'il existe une requête ultérieure, définissez ce paramètre sur la valeur NextToken renvoyée par l'appel d'API précédent.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResult	integer	Non	Le nombre d'entrées par page. Valeurs valides : 1 à 50. Valeur par défaut : 50.	50
ResourceId	array	Non	L'identifiant de la ressource. Vous pouvez spécifier jusqu'à 50 identifiants de ressource.
	string	Non	L'identifiant de la ressource. Vous pouvez spécifier jusqu'à 50 identifiants de ressource. Remarque Lorsque vous spécifiez ce paramètre, vous devez également spécifier le paramètre ResourceType.	vpc-bp16qjewdsunr41m1****
Tag	array<object>	Non	Les balises de la ressource.
	object	Non	Les balises de la ressource.
Key	string	Non	La clé de balise de la ressource. Vous pouvez spécifier jusqu'à 20 clés de balise. Une clé de balise peut comporter jusqu'à 128 caractères. Elle ne peut pas être une chaîne vide, ni commencer par `aliyun` ou `acs:`, et ne peut pas contenir `http://` ou `https://`.	FinanceDept
Value	string	Non	La valeur de balise de la ressource. Vous pouvez spécifier jusqu'à 20 valeurs de balise. Une valeur de balise peut comporter jusqu'à 128 caractères. Elle peut être une chaîne vide, mais ne peut pas commencer par `aliyun` ou `acs:`, et ne peut pas contenir `http://` ou `https://`.	FinanceJoshua

Éléments de réponse

Élément	Type	Description	Exemple
	object	Objet.
NextToken	string	Le jeton de pagination. Valeurs valides : Si NextToken est vide, il n'existe aucune requête ultérieure. Si NextToken est renvoyé, la valeur indique le jeton pour la requête suivante.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	L'identifiant de la requête.	C46FF5A8-C5F0-4024-8262-B16B639225A0
TagResources	object
TagResource	array<object>	La liste de toutes les balises qui répondent aux conditions de filtrage.
	object	La liste des balises.
TagValue	string	The tag value.	FinanceJoshua
TagKey	string	The tag key.	FinanceDept

Exemples

JSON format

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "C46FF5A8-C5F0-4024-8262-B16B639225A0",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "FinanceJoshua",
        "TagKey": "FinanceDept"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	BothEmpty.TagsAndResources	The specified Tags and ResourcesIds are not allow to both empty.	The tags and resource groups cannot be empty at the same time.
400	MissingParameter.TagKey	The input parameter TagKey that is mandatory for processing this request is not supplied.	The TagKey parameter is not set.
400	MissingParameter.TagValue	The input parameter TagValue that is mandatory for processing this request is not supplied.	The TagValue parameter is not set.
400	InvalidTagKey	The tag keys are not valid.	The tag index is invalid.
400	InvalidTagValue	The tag values are not valid.	The tag value is invalid.
400	MissingParam	%s
400	InvalidInstanceType.NotFound	The instance type is not found	The instance type is not found.
400	InvalidInstanceIds.NotFound	The instanceIds are not found	The instance ID is not found.
400	Forbidden.TagKeys	The request do not allow to operate the tag keys	You do not have the permissions to set the TagKeys parameter.
400	QuotaExceeded.TagNum	Custom Tags quota exceeded	The upper limit is reached.
400	Forbidden.NotAllowedCategary	The System tag is not valid	The error message returned because the system tag is invalid.
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.	The tag resources are duplicate.
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.	The number of tags has reached the upper limit.
400	SizeLimitExceeded.ResourceId	The maximum number of resource IDs is exceeded.	The number of resource group IDs has reached the upper limit.
403	Forbidden	User not authorized to operate on the specified resource.	You do not have the permissions to manage the specified resource. Apply for the permissions and try again.

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

Notes de version

Consultez Notes de version pour la liste complète.