ListUsers - - Centro de documentación de Alibaba Cloud

Consulta los detalles de los usuarios.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que invoque esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDKs.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListUsers	La operación que desea ejecutar. Establezca el valor en ListUsers.
Tid	Long	Sí	3***	El ID del inquilino. Puede invocar la operación GetUserActiveTenant para consultar el ID del inquilino.
Role	String	No	DBA	El rol asignado al usuario. Valores válidos: USER: rol de usuario estándar. DBA: rol de administrador de base de datos (DBA). ADMIN: rol de administrador de Data Management (DMS). SECURITY_ADMIN: rol de administrador de seguridad. STRUCT_READ_ONLY: rol de usuario de solo lectura de esquema. Nota Para comprobar su rol, pase el puntero sobre la imagen de perfil en la esquina superior derecha de la consola de DMS.
UserState	String	No	NORMAL	El estado del usuario. Valores válidos: NORMAL: El usuario se encuentra en estado normal. DISABLE: El usuario está deshabilitado. DELETE: El usuario está eliminado.
SearchKey	String	No	test	La palabra clave de búsqueda. Es compatible con coincidencias aproximadas.
PageNumber	Integer	No	1	El número de página que se devolverá.
PageSize	Integer	No	10	El número de entradas que se devolverán en cada página. Nota Valores válidos: 10, 20, 50 y 100. Valor predeterminado: 10.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
TotalCount	Long	3	El número total de entradas devueltas.
RequestId	String	67E910F2-4B62-5B0C-ACA3-7547695C****	El ID de la solicitud.
ErrorCode	String	InvalidTid	El código de error devuelto.
ErrorMessage	String	Specified parameter Tid is not valid.	El mensaje de error devuelto.
UserList	Array of User		Los detalles de los usuarios.
User
State	String	NORMAL	El estado del usuario. Valores válidos: NORMAL: El usuario se encuentra en estado normal. DISABLE: El usuario está deshabilitado. DELETE: El usuario está eliminado.
CurResultCount	Long	0	El número de filas consultadas en el día actual.
UserId	String	8****	El ID del usuario.
LastLoginTime	String	2021-11-08 13:43:43	La última vez que el usuario inició sesión en la consola.
MaxResultCount	Long	50000	El número máximo de filas que se pueden consultar en el día actual.
ParentUid	String	140692647406****	El UID de la cuenta de Alibaba Cloud del usuario.
RoleIdList	Array of Integer	3	El ID del rol asignado al usuario. Valores válidos: 1: rol de usuario estándar. 2: rol de DBA. 3: rol de administrador de DMS. 4: rol de administrador de seguridad. 6: rol de usuario de solo lectura de esquema.
RoleNameList	Array of String	ADMIN	El nombre del rol asignado al usuario. Valores válidos: USER: usuario estándar. DBA: DBA. ADMIN: administrador de DMS. SECURITY_ADMIN: administrador de seguridad. STRUCT_READ_ONLY: usuario de solo lectura de esquema.
NickName	String	test_NickName	El apodo del usuario.
MaxExecuteCount	Long	2000	El número máximo de consultas que se pueden ejecutar en el día actual.
CurExecuteCount	Long	0	El número de consultas ejecutadas en el día actual.
Mobile	String	1389999****	El número de celular utilizado para recibir notificaciones. Nota El sistema devuelve este parámetro si el usuario ha configurado un número de celular en la consola. Para configurar un número de celular en la consola, pase el puntero sobre la imagen de perfil en la esquina superior derecha y haga clic en el icono Editar junto a Notice. El sistema no devuelve este parámetro si el usuario no ha configurado un número de celular.
Uid	String	167382665015****	El UID del usuario.
Email	String	username@example.com	La dirección de correo electrónico utilizada para recibir notificaciones. Nota El sistema devuelve este parámetro si el usuario ha configurado una dirección de correo electrónico en la consola. Para configurar una dirección de correo electrónico en la consola, pase el puntero sobre la imagen de perfil en la esquina superior derecha y haga clic en el icono Editar junto a Notice. El sistema no devuelve este parámetro si el usuario no ha configurado una dirección de correo electrónico.
DingRobot	String	https://XXX.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78e4ef	La URL del chatbot de DingTalk utilizada para recibir notificaciones. Nota El sistema devuelve este parámetro si el usuario ha configurado una URL de chatbot de DingTalk en la consola. Para configurar una URL de chatbot de DingTalk en la consola, pase el puntero sobre la imagen de perfil en la esquina superior derecha y haga clic en el icono Editar junto a Notice. El sistema no devuelve este parámetro si el usuario no ha configurado una URL de chatbot de DingTalk.
Webhook	String	http://dms-XXX.aliyun.com:8***	La URL del webhook utilizada para recibir notificaciones. Nota Si el usuario ha configurado una URL de webhook, DMS envía notificaciones a la URL especificada. El sistema no devuelve este parámetro si el usuario no ha configurado una URL de webhook.
SignatureMethod	String	HMAC_SHA1	El método de firma utilizado para proteger las conexiones cuando se usa una URL de webhook. Valores válidos: NONE: sin firma. HMAC_SHA1: HMAC-SHA1.
NotificationMode	String	DINGROBOT	El método de notificación. El sistema devuelve uno o más valores. Valores válidos: SMS: mensaje de texto. EMAIL: correo electrónico. DingTalk: DingTalk. DINGROBOT: chatbot de DingTalk. WEBHOOK: webhook.
Success	Boolean	true	Indica si la solicitud fue exitosa. Valores válidos: true: La solicitud fue exitosa. false: La solicitud falló.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

Formato XML

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>

Formato JSON

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
}

Códigos de error

Para obtener una lista de códigos de error, visite el Centro de errores de API.