ListUserGroups - - Centre de documentation Alibaba Cloud

Débogage

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

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	ListUserGroups	Nom de l'opération à effectuer. Définissez la valeur sur ListUserGroups.
InstanceId	String	Oui	bastionhost-cn-st220aw****	ID de l'instance Bastionhost dont vous souhaitez répertorier les groupes d'utilisateurs. Remarque Appelez l'opération DescribeInstances pour obtenir l'ID de votre instance Bastionhost.
RegionId	String	Non	cn-hangzhou	ID de région de l'instance Bastionhost cible. Remarque Pour connaître la correspondance entre les ID de région et leurs noms, consultez la page Régions et zones.
PageNumber	String	Non	1	Numéro de la page à renvoyer. Valeur par défaut : 1.
PageSize	String	Non	20	Nombre d'éléments renvoyés par page. La valeur du paramètre PageSize ne doit pas dépasser 100. La valeur par défaut est 20. Si ce paramètre est omis, 20 éléments sont renvoyés par page. Remarque Nous vous recommandons de renseigner explicitement le paramètre PageSize.
UserGroupName	String	Non	TestGroup01	Nom du groupe d'utilisateurs à rechercher. Seule la correspondance exacte est prise en charge.

Toutes les requêtes API Bastionhost doivent inclure les paramètres de requête communs. Pour plus d'informations, consultez la page Paramètres communs.

Des exemples de requêtes figurent dans la section « Exemples » de cette rubrique.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE	ID de la requête.
TotalCount	Integer	1	Nombre total de groupes d'utilisateurs renvoyés.
UserGroups	Array of Item		Liste des groupes d'utilisateurs renvoyés.
Comment	String	comment	Description du groupe d'utilisateurs.
MemberCount	Integer	5	Nombre d'utilisateurs appartenant au groupe.
UserGroupId	String	1	ID du groupe d'utilisateurs.
UserGroupName	String	TestGroup01	Nom du groupe d'utilisateurs.

Exemples

Exemple de requête

http(s)://[Endpoint]/?Action=ListUserGroups
&InstanceId=bastionhost-cn-st220aw****
&<Common request parameters>

Exemple de réponse réussie

XML format

<ListUserGroupsResponse>
      <TotalCount>1</TotalCount>
      <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
      <UserGroups>
            <Comment>comment</Comment>
            <UserGroupName>TestGroup01</UserGroupName>
            <UserGroupId>1</UserGroupId>
            <MemberCount>5</MemberCount>
      </UserGroups>
</ListUserGroupsResponse>

JSON format

{
	"TotalCount": "1",
	"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
	"UserGroups": [{
		"Comment": "comment",
		"UserGroupName": "TestGroup01",
		"UserGroupId": "1",
		"MemberCount": "5"
	}]
}

Codes d'erreur

Pour consulter la liste des codes d'erreur, rendez-vous sur le Centre d'erreurs API.