ListUsers - - Centre de documentation Alibaba Cloud

Consulte les détails des utilisateurs.

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.

dms:ListUsers

list

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Tid	integer	Non	L'identifiant du locataire. Vous pouvez appeler l'opération GetUserActiveTenant pour obtenir l'identifiant du locataire.	3***
Role	string	Non	Le rôle attribué à l'utilisateur. Valeurs valides : USER : un utilisateur standard. DBA : un administrateur de base de données (DBA). ADMIN : un administrateur Data Management (DMS). SECURITY_ADMIN : un administrateur de sécurité. STRUCT_READ_ONLY : un utilisateur en lecture seule du schéma. Remarque Pour vérifier votre rôle, placez le pointeur sur la photo de profil dans le coin supérieur droit de la console DMS.	DBA
UserState	string	Non	L'état de l'utilisateur. Valeurs valides : NORMAL : l'utilisateur est normal. DISABLE : l'utilisateur est désactivé. DELETE : l'utilisateur est supprimé.	NORMAL
SearchKey	string	Non	Le mot-clé de recherche. La correspondance approximative est prise en charge.	test
PageNumber	integer	Non	Le numéro de la page à renvoyer.	1
PageSize	integer	Non	Le nombre d'entrées à renvoyer sur chaque page. Valeurs valides : 10, 20, 50 et 100.** Valeur par défaut : 10.	10

Éléments de réponse

Élément	Type	Description	Exemple
	object
TotalCount	integer	Le nombre total d'entrées renvoyées.	3
RequestId	string	L'identifiant de la requête.	69161997-6030-53BA-A333-DBEC83B732FF
ErrorCode	string	Le code d'erreur renvoyé si la requête a échoué.	InvalidTid
ErrorMessage	string	Le message d'erreur renvoyé si la requête a échoué.	Le paramètre Tid spécifié n'est pas valide
UserList	object
User	array<object>	Les détails des utilisateurs.
	array<object>	Les détails de l'utilisateur.
State	string	The status of the user. Valid values: NORMAL: The user is normal. DISABLE: The user is disabled. DELETE: The user is deleted.	NORMAL
CurResultCount	integer	The number of rows that were queried on the current day.	0
UserId	string	The ID of the user.	8****
LastLoginTime	string	The time when the user last logged on to the console.	2021-11-08 13:43:43
MaxResultCount	integer	The maximum number of rows that can be queried on the current day.	50000
ParentUid	string	The ID of the Alibaba Cloud account of the user.	140692647406****
RoleIdList	object
RoleIds	array	The IDs of the roles.
	integer	The ID of the role that is assigned to the user. Valid values: 1: a regular user role. 2: a DBA role. 3: a DMS administrator role. 4: a security administrator role. 6: a schema read-only user role.	3
RoleNameList	object
RoleNames	array	The names of roles.
	string	The name of the role that is assigned to the user. Valid values: USER: a regular user. DBA : a DBA. ADMIN: a DMS administrator. SECURITY_ADMIN: a security administrator. STRUCT_READ_ONLY: a schema read-only user.	ADMIN
NickName	string	The nickname of the user.	test_NickName
MaxExecuteCount	integer	The maximum number of queries that can be performed on the current day.	2000
CurExecuteCount	integer	The number of queries that were performed on the current day.	0
Mobile	string	The mobile phone number of the user. Remarque The system returns this parameter if you have set a mobile phone number in the console. To set a mobile phone number in the console, move the pointer over the profile picture in the upper-right corner and click the Edit icon next to Notice. The system does not return this parameter if you have not set a mobile phone number.	1389999****
Uid	string	The ID of the Alibaba Cloud account.	167382665015****
Email	string	The email address that is used to receive notifications. Remarque The system returns this parameter if you have set an email address in the console. To set an email address in the console, move the pointer over the profile picture in the upper-right corner and click the Edit icon next to Notice. The system does not return this parameter if you have not set an email address.	username@example.com
DingRobot	string	The DingTalk chatbot URL that is used to receive notifications. Remarque The system returns this parameter if you have set a DingTalk chatbot URL in the console. To set a DingTalk chatbot URL in the console, move the pointer over the profile picture in the upper-right corner and click the Edit icon next to Notice. The system does not return this parameter if you have not set a DingTalk chatbot URL.	https://XXX.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78e4ef
Webhook	string	The webhook URL that is used to receive notifications. Remarque If you have set a webhook URL, DMS sends notifications to the specified URL. The system does not return this parameter if you have not set a webhook URL.	http://dms-XXX.aliyun.com:8***
SignatureMethod	string	The signature method that is used to secure connections when a webhook URL is used. Valid values: NONE: no signature. HMAC_SHA1: HMAC_SHA1.	HMAC_SHA1
NotificationMode	string	The notification method. The system returns one or more values. Valid values: SMS: text message EMAIL: email. DINGDING: DingTalk. DINGROBOT: DingTalk chatbot. WEBHOOK: webhook.	DINGROBOT
Success	boolean	Indique si la requête a réussi. Valeurs valides : true : la requête a réussi. false : la requête a échoué.	true

Exemples

JSON format

{
  "TotalCount": 3,
  "RequestId": "69161997-6030-53BA-A333-DBEC83B732FF",
  "ErrorCode": "InvalidTid",
  "ErrorMessage": "Specified parameter Tid is not valid.",
  "UserList": {
    "User": [
      {
        "State": "NORMAL",
        "CurResultCount": 0,
        "UserId": "8****",
        "LastLoginTime": "2021-11-08 13:43:43",
        "MaxResultCount": 50000,
        "ParentUid": "140692647406****",
        "RoleIdList": {
          "RoleIds": [
            3
          ]
        },
        "RoleNameList": {
          "RoleNames": [
            "ADMIN"
          ]
        },
        "NickName": "test_NickName",
        "MaxExecuteCount": 2000,
        "CurExecuteCount": 0,
        "Mobile": "1389999****",
        "Uid": "167382665015****",
        "Email": "username@example.com",
        "DingRobot": "https://XXX.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78e4ef",
        "Webhook": "http://dms-XXX.aliyun.com:8***",
        "SignatureMethod": "HMAC_SHA1",
        "NotificationMode": "DINGROBOT"
      }
    ]
  },
  "Success": true
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.