ListUsers - - Centre de documentation Alibaba Cloud

Récupère les détails des utilisateurs.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. L'outil 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	ListUsers	Opération à effectuer. Définissez la valeur sur ListUsers.
Tid	Long	Yes	3***	ID du locataire (tenant). Appelez l'opération GetUserActiveTenant pour récupérer cet ID.
Role	String	No	DBA	Rôle attribué à l'utilisateur. Valeurs possibles : USER : utilisateur standard. DBA : administrateur de base de données. ADMIN : administrateur DMS. SECURITY_ADMIN : administrateur de sécurité. STRUCT_READ_ONLY : utilisateur en lecture seule sur le schéma. Remarque Pour vérifier votre rôle, survolez votre photo de profil dans le coin supérieur droit de la console DMS.
UserState	String	No	NORMAL	Statut de l'utilisateur. Valeurs possibles : NORMAL : actif. DISABLE : désactivé. DELETE : supprimé.
SearchKey	String	No	test	Mot-clé de recherche (correspondance floue acceptée).
PageNumber	Integer	No	1	Numéro de la page à renvoyer.
PageSize	Integer	No	10	Nombre d'entrées par page. Remarque Valeurs valides : 10, 20, 50 et 100. Valeur par défaut : 10.

Paramètres de réponse

Parameter	Type	Example	Description
TotalCount	Long	3	Nombre total d'entrées renvoyées.
RequestId	String	67E910F2-4B62-5B0C-ACA3-7547695C****	ID de la requête.
ErrorCode	String	InvalidTid	Code d'erreur renvoyé.
ErrorMessage	String	Specified parameter Tid is not valid.	Message d'erreur renvoyé.
UserList	Array of User		Détails des utilisateurs.
User
State	String	NORMAL	Statut de l'utilisateur. Valeurs possibles : NORMAL : actif. DISABLE : désactivé. DELETE : supprimé.
CurResultCount	Long	0	Nombre de lignes interrogées ce jour.
UserId	String	8****	ID de l'utilisateur.
LastLoginTime	String	2021-11-08 13:43:43	Date et heure de la dernière connexion à la console.
MaxResultCount	Long	50000	Nombre maximal de lignes interrogeables ce jour.
ParentUid	String	140692647406****	UID du compte Alibaba Cloud de l'utilisateur.
RoleIdList	Array of Integer	3	ID du rôle attribué à l'utilisateur. Valeurs possibles : 1 : utilisateur standard. 2 : DBA. 3 : administrateur DMS. 4 : administrateur de sécurité. 6 : utilisateur en lecture seule sur le schéma.
RoleNameList	Array of String	ADMIN	Nom du rôle attribué à l'utilisateur. Valeurs possibles : USER : utilisateur standard. DBA : DBA. ADMIN : administrateur DMS. SECURITY_ADMIN : administrateur de sécurité. STRUCT_READ_ONLY : utilisateur en lecture seule sur le schéma.
NickName	String	test_NickName	Pseudonyme de l'utilisateur.
MaxExecuteCount	Long	2000	Nombre maximal de requêtes exécutables ce jour.
CurExecuteCount	Long	0	Nombre de requêtes exécutées ce jour.
Mobile	String	1389999****	Numéro de mobile utilisé pour recevoir les notifications. Remarque Ce paramètre est renvoyé si l'utilisateur a configuré un numéro de mobile dans la console. Pour ce faire, survolez votre photo de profil dans le coin supérieur droit, puis cliquez sur l'icône Modifier à côté de Notice. Ce paramètre n'est pas renvoyé si aucun numéro de mobile n'est configuré.
Uid	String	167382665015****	UID de l'utilisateur.
Email	String	username@example.com	Adresse e-mail utilisée pour recevoir les notifications. Remarque Ce paramètre est renvoyé si l'utilisateur a configuré une adresse e-mail dans la console. Pour ce faire, survolez votre photo de profil dans le coin supérieur droit, puis cliquez sur l'icône Modifier à côté de Notice. Ce paramètre n'est pas renvoyé si aucune adresse e-mail n'est configurée.
DingRobot	String	https://XXX.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78e4ef	URL du robot DingTalk utilisée pour recevoir les notifications. Remarque Ce paramètre est renvoyé si l'utilisateur a configuré une URL de robot DingTalk dans la console. Pour ce faire, survolez votre photo de profil dans le coin supérieur droit, puis cliquez sur l'icône Modifier à côté de Notice. Ce paramètre n'est pas renvoyé si aucune URL de robot DingTalk n'est configurée.
Webhook	String	http://dms-XXX.aliyun.com:8***	URL Webhook utilisée pour recevoir les notifications. Remarque Si l'utilisateur a configuré une URL Webhook, DMS y envoie les notifications. Ce paramètre n'est pas renvoyé si aucune URL Webhook n'est configurée.
SignatureMethod	String	HMAC_SHA1	Méthode de signature utilisée pour sécuriser les connexions via Webhook. Valeurs possibles : NONE : aucune signature. HMAC_SHA1 : HMAC-SHA1.
NotificationMode	String	DINGROBOT	Mode de notification. Le système renvoie une ou plusieurs valeurs. Valeurs possibles : SMS : SMS. EMAIL : e-mail. DingTalk : DingTalk. DINGROBOT : robot DingTalk. WEBHOOK : Webhook.
Success	Boolean	true	Indique si la requête a réussi. Valeurs possibles : true : succès. false : échec.

Exemples

Exemple de requête

http(s)://dms-enterprise.aliyuncs.com/?Action=ListUsers
&Tid=3***
&Role=DBA
&UserState=NORMAL
&SearchKey=test
&PageNumber=1
&PageSize=10
&<Common request parameters>

Exemple de réponse réussie

XML format

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

<ListUsersResponse>
    <TotalCount>3</TotalCount>
    <RequestId>67E910F2-4B62-5B0C-ACA3-7547695C****</RequestId>
    <UserList>
        <User>
            <Email>test1_email</Email>
            <RoleNameList>
                <RoleNames>DBA</RoleNames>
            </RoleNameList>
            <NickName>Ms. Wang</NickName>
            <MaxExecuteCount>2000</MaxExecuteCount>
            <CurResultCount>0</CurResultCount>
            <LastLoginTime>2021-10-22 17:02:19</LastLoginTime>
            <Uid>23236106758310****</Uid>
            <RoleIdList>
                <RoleIds>2</RoleIds>
            </RoleIdList>
            <MaxResultCount>10000</MaxResultCount>
            <State>NORMAL</State>
            <UserId>13****</UserId>
            <CurExecuteCount>1</CurExecuteCount>
            <ParentUid>140692647406****</ParentUid>
        </User>
        <User>
            <Email>test2_email</Email>
            <RoleNameList>
                <RoleNames>ADMIN</RoleNames>
                <RoleNames>USER</RoleNames>
                <RoleNames>SECURITY_ADMIN</RoleNames>
                <RoleNames>DBA</RoleNames>
                <RoleNames>SUPPORT</RoleNames>
            </RoleNameList>
            <NickName>Mr. Wang</NickName>
            <MaxExecuteCount>2000</MaxExecuteCount>
            <CurResultCount>400</CurResultCount>
            <LastLoginTime>2021-09-16 10:19:58</LastLoginTime>
            <Uid>26984203785603****</Uid>
            <RoleIdList>
                <RoleIds>3</RoleIds>
                <RoleIds>1</RoleIds>
                <RoleIds>4</RoleIds>
                <RoleIds>2</RoleIds>
                <RoleIds>5</RoleIds>
            </RoleIdList>
            <MaxResultCount>10000</MaxResultCount>
            <State>NORMAL</State>
            <UserId>12****</UserId>
            <CurExecuteCount>5</CurExecuteCount>
            <ParentUid>140692647406****</ParentUid>
        </User>
        <User>
            <NotificationMode>DINGROBOT</NotificationMode>
            <Email>username@example.com</Email>
            <RoleNameList>
                <RoleNames>ADMIN</RoleNames>
                <RoleNames>USER</RoleNames>
                <RoleNames>SECURITY_ADMIN</RoleNames>
                <RoleNames>DBA</RoleNames>
                <RoleNames>STRUCT_READ_ONLY</RoleNames>
            </RoleNameList>
            <NickName>test_NickName</NickName>
            <MaxExecuteCount>2000</MaxExecuteCount>
            <CurResultCount>0</CurResultCount>
            <LastLoginTime>2021-11-08 13:43:43</LastLoginTime>
            <Uid>167382665015****</Uid>
            <RoleIdList>
                <RoleIds>3</RoleIds>
                <RoleIds>1</RoleIds>
                <RoleIds>4</RoleIds>
                <RoleIds>2</RoleIds>
                <RoleIds>6</RoleIds>
            </RoleIdList>
            <MaxResultCount>50000</MaxResultCount>
            <State>NORMAL</State>
            <UserId>8****</UserId>
            <CurExecuteCount>0</CurExecuteCount>
            <Webhook>http://****.aliyun.com:8080</Webhook>
            <SignatureMethod>HMAC_SHA1</SignatureMethod>
            <DingRobot>https://****.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78****</DingRobot>
        </User>
    </UserList>
    <Success>true</Success>
</ListUsersResponse>

JSON format

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

{
  "TotalCount" : 3,
  "RequestId" : "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "UserList" : {
    "User" : [ {
      "Email" : "test1_email",
      "RoleNameList" : {
        "RoleNames" : [ "DBA" ]
      },
      "NickName" : "Ms. Wang",
      "MaxExecuteCount" : 2000,
      "CurResultCount" : 0,
      "LastLoginTime" : "2021-10-22 17:02:19",
      "Uid" : "23236106758310****",
      "RoleIdList" : {
        "RoleIds" : [ 2 ]
      },
      "MaxResultCount" : 10000,
      "State" : "NORMAL",
      "UserId" : "13****",
      "CurExecuteCount" : 1,
      "ParentUid" : "140692647406****"
    }, {
      "Email" : "test2_email",
      "RoleNameList" : {
        "RoleNames" : [ "ADMIN", "USER", "SECURITY_ADMIN", "DBA", "SUPPORT" ]
      },
      "NickName" : "Mr. Wang",
      "MaxExecuteCount" : 2000,
      "CurResultCount" : 400,
      "LastLoginTime" : "2021-09-16 10:19:58",
      "Uid" : "26984203785603****",
      "RoleIdList" : {
        "RoleIds" : [ 3, 1, 4, 2, 5 ]
      },
      "MaxResultCount" : 10000,
      "State" : "NORMAL",
      "UserId" : "12****",
      "CurExecuteCount" : 5,
      "ParentUid" : "140692647406****"
    }, {
      "NotificationMode" : "DINGROBOT",
      "Email" : "username@example.com",
      "RoleNameList" : {
        "RoleNames" : [ "ADMIN", "USER", "SECURITY_ADMIN", "DBA", "STRUCT_READ_ONLY" ]
      },
      "NickName" : "test_NickName",
      "MaxExecuteCount" : 2000,
      "CurResultCount" : 0,
      "LastLoginTime" : "2021-11-08 13:43:43",
      "Uid" : "167382665015****",
      "RoleIdList" : {
        "RoleIds" : [ 3, 1, 4, 2, 6 ]
      },
      "MaxResultCount" : 50000,
      "State" : "NORMAL",
      "UserId" : "8****",
      "CurExecuteCount" : 0,
      "Webhook" : "http://****.aliyun.com:8080",
      "SignatureMethod" : "HMAC_SHA1",
      "DingRobot" : "https://****.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78****"
    } ]
  },
  "Success" : true
}

Codes d'erreur

Pour la liste des codes d'erreur, consultez le Centre d'erreurs API.