ListUsers - - Centre de documentation Alibaba Cloud

Répertorie les utilisateurs d'une instance Bastionhost spécifiée.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer 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	ListUsers	Opération à effectuer. Définissez la valeur sur ListUsers.
InstanceId	String	Oui	bastionhost-cn-st220aw****	ID de l'instance Bastionhost à laquelle appartiennent les utilisateurs à interroger. Remarque Appelez l'opération DescribeInstances pour obtenir l'ID de l'instance Bastionhost.
RegionId	String	Non	cn-hangzhou	ID de région de l'instance Bastionhost à laquelle appartiennent les utilisateurs à interroger. Remarque Pour plus d'informations sur la correspondance entre les ID de région et les noms de région, consultez la rubrique 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'entrées à renvoyer par page. La valeur du paramètre PageSize ne doit pas dépasser 100. La valeur par défaut est 20. Si vous ne définissez pas le paramètre PageSize, 20 entrées sont renvoyées par page. Remarque Nous vous recommandons de ne pas laisser ce paramètre vide.
UserName	String	Non	abc	Nom de connexion de l'utilisateur à interroger. Seule la correspondance exacte est prise en charge.
DisplayName	String	Non	Utilisateur	Nom d'affichage de l'utilisateur à interroger. Seule la correspondance exacte est prise en charge.
Source	String	Non	Local	Source de l'utilisateur à interroger. Valeurs valides : Local : utilisateur local Ram : utilisateur RAM
Mobile	String	Non	1359999****	Numéro de mobile de l'utilisateur à interroger. Seule la correspondance exacte est prise en charge.
UserState	String	Non	Normal	Statut de l'utilisateur à interroger. Valeurs valides : Normal : L'utilisateur peut accéder à l'instance Bastionhost. Frozen : L'utilisateur est verrouillé et ne peut pas accéder à l'instance Bastionhost. Expired : L'utilisateur a expiré et ne peut pas accéder à l'instance Bastionhost.
SourceUserId	String	Non	122748924538****	ID unique de l'utilisateur à interroger. Seule la correspondance exacte est prise en charge. Remarque Ce paramètre identifie de manière unique un utilisateur RAM de l'instance Bastionhost. Il prend effet uniquement lorsque le paramètre Source est défini sur Ram. Appelez l'opération ListUsers pour obtenir l'ID unique de l'utilisateur à partir du paramètre de réponse UserId.
UserGroupId	String	Non	1	ID du groupe d'utilisateurs à interroger. Remarque Appelez l'opération ListUserGroups pour obtenir l'ID du groupe d'utilisateurs.

Toutes les opérations API Alibaba Cloud doivent inclure des paramètres de requête communs. Pour plus d'informations, consultez la rubrique Paramètres communs.

Pour plus d'informations sur les exemples de requêtes, consultez 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 d'utilisateurs interrogés.
Users	Array of Item		Liste des utilisateurs interrogés.
Comment	String	commentaire	Description de l'utilisateur.
DisplayName	String	Bob	Nom d'affichage de l'utilisateur.
Email	String	1099**@qq.com	Adresse e-mail de l'utilisateur.
Mobile	String	1359999****	Numéro de mobile de l'utilisateur.
MobileCountryCode	String	CN	Pays où le numéro de mobile de l'utilisateur est enregistré. Valeurs valides : CN : Chine continentale, indicatif téléphonique +86 HK : Hong Kong (Chine), indicatif téléphonique +852 MO : Macao (Chine), indicatif téléphonique +853 TW : Taïwan (Chine), indicatif téléphonique +886 RU : Russie, indicatif téléphonique +7 SG : Singapour, indicatif téléphonique +65 MY : Malaisie, indicatif téléphonique +60 ID : Indonésie, indicatif téléphonique +62 DE : Allemagne, indicatif téléphonique +49 AU : Australie, indicatif téléphonique +61 US : États-Unis, indicatif téléphonique +1 AE : Émirats arabes unis, indicatif téléphonique +971 JP : Japon, indicatif téléphonique +81 GB : Royaume-Uni, indicatif téléphonique +44 IN : Inde, indicatif téléphonique +91 KR : Corée du Sud, indicatif téléphonique +82 PH : Philippines, indicatif téléphonique +63 CH : Suisse, indicatif téléphonique +41 SE : Suède, indicatif téléphonique +46
Source	String	Local	Source de l'utilisateur. Valeurs valides : Local : utilisateur local Ram : utilisateur RAM
SourceUserId	String	122748924538****	ID unique de l'utilisateur. Remarque Ce paramètre identifie de manière unique un utilisateur RAM de l'instance Bastionhost. Une valeur est renvoyée si le paramètre Source est défini sur Ram. Aucune valeur n'est renvoyée si le paramètre Source est défini sur Local.
UserId	String	1	ID de l'utilisateur.
UserName	String	abc_def	Nom de connexion de l'utilisateur.
UserState	List	["Normal"]	Statut de l'utilisateur. Valeurs valides : Normal : L'utilisateur peut accéder à l'instance Bastionhost. Frozen : L'utilisateur est verrouillé et ne peut pas accéder à l'instance Bastionhost. Expired : L'utilisateur a expiré et ne peut pas accéder à l'instance Bastionhost.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

Format XML

<ListUsersResponse>
      <TotalCount>1</TotalCount>
      <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
      <Users>
            <Comment>comment</Comment>
            <UserName>abc_def</UserName>
            <Email>1099**@qq.com</Email>
            <UserId>1</UserId>
            <SourceUserId>122748924538****</SourceUserId>
            <MobileCountryCode>CN</MobileCountryCode>
            <DisplayName>Bob</DisplayName>
            <Mobile>1359999****</Mobile>
            <Source>Local</Source>
            <UserState>Normal</UserState>
      </Users>
</ListUsersResponse>

Format JSON

{
    "TotalCount": "1",
    "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
    "Users": [{
        "Comment": "comment",
        "UserName": "abc_def",
        "Email": "1099**@qq.com",
        "UserId": "1",
        "SourceUserId": "122748924538****",
        "MobileCountryCode": "CN",
        "DisplayName": "Bob",
        "Mobile": "1359999****",
        "Source": "Local",
        "UserState": ["Normal"]
    }]
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs de l'API.