ListResourceGroups - Resource Management - Centre de documentation Alibaba Cloud

Obtient la liste des groupes de ressources en appelant ListResourceGroups.

Description de l'opération

Vous pouvez appeler cette API pour obtenir la liste de tous les groupes de ressources du compte actuel, ou obtenir la liste des groupes de ressources correspondants en fonction de l'état du groupe de ressources, de l'identifiant du groupe de ressources, de l'identificateur du groupe de ressources ou du nom d'affichage du groupe de ressources.

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

Aucune autorisation n'est requise pour cette opération. En cas de problème, contactez le support technique.

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Status	string	Non	L'état du groupe de ressources. Ce paramètre spécifie une condition de filtre pour la requête. Valeurs valides : Creating : le groupe de ressources est en cours de création. OK : le groupe de ressources est créé. PendingDelete : le groupe de ressources est en attente de suppression.	OK
PageNumber	integer	Non	Le numéro de la page à renvoyer. Les pages commencent à la page 1. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées à renvoyer sur chaque page. Valeurs valides : 1 à 100. Valeur par défaut : 10.	10
ResourceGroupId	string	Non	L'identifiant du groupe de ressources. Ce paramètre spécifie une condition de filtre pour la requête. L'identifiant peut comporter jusqu'à 18 caractères et doit commencer par `rg-`. Remarque Ce paramètre est intégré au paramètre `ResourceGroupIds`. Si vous configurez à la fois les paramètres `ResourceGroupId` et `ResourceGroupIds`, la valeur du paramètre `ResourceGroupIds` prévaut.	rg-9gLOoK****
DisplayName	string	Non	Le nom d'affichage du groupe de ressources. Ce paramètre spécifie une condition de filtre pour la requête. La correspondance approximative est prise en charge. Le nom d'affichage peut comporter jusqu'à 50 caractères.	my-project
Name	string	Non	L'identificateur du groupe de ressources. Ce paramètre spécifie une condition de filtre pour la requête. La correspondance approximative est prise en charge. L'identificateur peut comporter jusqu'à 50 caractères et peut contenir des lettres, des chiffres et des traits d'union (-).	my-project
Tag	array<object>	Non	La balise. Ce paramètre spécifie une condition de filtre pour la requête.
	object	Non	Les balises utilisées comme conditions de filtre pour les requêtes. Vous pouvez spécifier jusqu'à 20 balises.
Key	string	Non	La clé de la balise.	k1
Value	string	Non	La valeur de la balise.	v1
IncludeTags	boolean	Non	Indique si les informations des balises doivent être renvoyées. Valeurs valides : false (valeur par défaut) true Remarque Si vous configurez le paramètre Tag, le système renvoie les informations des balises quel que soit le paramétrage du paramètre `IncludeTags`.	false
ResourceGroupIds	array	Non	Les identifiants des groupes de ressources. Ce paramètre spécifie une condition de filtre pour la requête. Vous pouvez spécifier jusqu'à 100 identifiants de groupes de ressources. Remarque Si vous configurez à la fois les paramètres `ResourceGroupId` et `ResourceGroupIds`, la valeur du paramètre `ResourceGroupIds` prévaut.
	string	Non	Une liste d'identifiants de groupes de ressources utilisés comme conditions de filtre pour les requêtes. Vous pouvez spécifier jusqu'à 100 identifiants de groupes de ressources. Remarque Si `ResourceGroupId` et `ResourceGroupIds` sont tous deux spécifiés, `ResourceGroupIds` est prioritaire.	{"rg-1hSBH2**","rg-9gLOoK**"}

Éléments de réponse

Élément	Type	Description	Exemple
	object	Résultat renvoyé.
PageNumber	integer	Le numéro de la page renvoyée.	1
PageSize	integer	Le nombre d'entrées renvoyées par page.	10
RequestId	string	L'identifiant de la requête.	4B450CA1-36E8-4AA2-8461-86B42BF4CC4E
ResourceGroups	object
ResourceGroup	array<object>	Les informations des groupes de ressources.
	array<object>	La liste des groupes de ressources.
AccountId	string	The ID of the Alibaba Cloud account to which the resource group belongs.	123456789****
CreateDate	string	The time when the resource group was created. The time is displayed in UTC.	2015-01-23T12:33:18Z
DisplayName	string	The display name of the resource group.	my-project
Id	string	The ID of the resource group.	rg-9gLOoK****
Name	string	The identifier of the resource group.	my-project
Status	string	The status of the resource group. Valid values: Creating: The resource group is being created. OK: The resource group is created. PendingDelete: The resource group is waiting to be deleted.	OK
Tags	object
Tag	array<object>	The tags that are added to the resource group.
	object	List of tags.
TagKey	string	The tag key.	k1
TagValue	string	The tag value.	v1
TotalCount	integer	Le nombre total d'entrées renvoyées.	2

Exemples

JSON format

{
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "4B450CA1-36E8-4AA2-8461-86B42BF4CC4E",
  "ResourceGroups": {
    "ResourceGroup": [
      {
        "AccountId": "123456789****",
        "CreateDate": "2015-01-23T12:33:18Z",
        "DisplayName": "my-project",
        "Id": "rg-9gLOoK****",
        "Name": "my-project",
        "Status": "OK",
        "Tags": {
          "Tag": [
            {
              "TagKey": "k1",
              "TagValue": "v1"
            }
          ]
        }
      }
    ]
  },
  "TotalCount": 2
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.