ListUsers - : Central de Documentação do Alibaba Cloud

Consulta os detalhes dos usuários.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListUsers	Operação a ser executada. Defina o valor como ListUsers.
Tid	Long	Sim	3***	ID do tenant. Chame a operação GetUserActiveTenant para consultar esse ID.
Role	String	Não	DBA	Função atribuída ao usuário. Valores válidos: USER: função de usuário comum. DBA: função de administrador de banco de dados (DBA). ADMIN: função de administrador do Data Management (DMS). SECURITY_ADMIN: função de administrador de segurança. STRUCT_READ_ONLY: função de usuário com acesso somente leitura ao esquema. Nota Para verificar sua função, passe o ponteiro sobre a foto do perfil no canto superior direito do console do DMS.
UserState	String	Não	NORMAL	Status do usuário. Valores válidos: NORMAL: usuário normal. DISABLE: usuário desabilitado. DELETE: usuário excluído.
SearchKey	String	Não	test	Palavra-chave de pesquisa. Suporta correspondência aproximada.
PageNumber	Integer	Não	1	Número da página a retornar.
PageSize	Integer	Não	10	Quantidade de entradas a retornar por página. Nota Valores válidos: 10, 20, 50 e 100. Valor padrão: 10.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
TotalCount	Long	3	Número total de entradas retornadas.
RequestId	String	67E910F2-4B62-5B0C-ACA3-7547695C****	ID da solicitação.
ErrorCode	String	InvalidTid	Código de erro retornado.
ErrorMessage	String	Specified parameter Tid is not valid.	Mensagem de erro retornada.
UserList	Array of User		Detalhes dos usuários.
User
State	String	NORMAL	Status do usuário. Valores válidos: NORMAL: usuário normal. DISABLE: usuário desabilitado. DELETE: usuário excluído.
CurResultCount	Long	0	Quantidade de linhas consultadas no dia atual.
UserId	String	8****	ID do usuário.
LastLoginTime	String	2021-11-08 13:43:43	Último login do usuário no console.
MaxResultCount	Long	50000	Limite diário de linhas consultáveis.
ParentUid	String	140692647406****	UID da conta Alibaba Cloud do usuário.
RoleIdList	Array of Integer	3	ID da função atribuída ao usuário. Valores válidos: 1: função de usuário comum. 2: função de DBA. 3: função de administrador do DMS. 4: função de administrador de segurança. 6: função de usuário com acesso somente leitura ao esquema.
RoleNameList	Array of String	ADMIN	Nome da função atribuída ao usuário. Valores válidos: USER: usuário comum. DBA: DBA. ADMIN: administrador do DMS. SECURITY_ADMIN: administrador de segurança. STRUCT_READ_ONLY: usuário com acesso somente leitura ao esquema.
NickName	String	test_NickName	Apelido do usuário.
MaxExecuteCount	Long	2000	Limite diário de consultas executáveis.
CurExecuteCount	Long	0	Quantidade de consultas executadas no dia atual.
Mobile	String	1389999****	Número de celular para recebimento de notificações. Nota O sistema retorna este parâmetro apenas se o usuário tiver definido um número de celular no console. Para configurar, passe o ponteiro sobre a foto do perfil no canto superior direito e clique em no ícone Editar ao lado de Notice. Caso o usuário não tenha definido um número de celular, o sistema não retorna este parâmetro.
Uid	String	167382665015****	UID do usuário.
Email	String	username@example.com	Endereço de e-mail para recebimento de notificações. Nota O sistema retorna este parâmetro apenas se o usuário tiver definido um e-mail no console. Para configurar, passe o ponteiro sobre a foto do perfil no canto superior direito e clique em no ícone Editar ao lado de Notice. Caso o usuário não tenha definido um e-mail, o sistema não retorna este parâmetro.
DingRobot	String	https://XXX.dingtalk.com/robot/send?access_token=9b7a4a562cbe7fcdea9962afac7b9d7b4504d564948083419750f9cafa78e4ef	URL do chatbot do DingTalk para recebimento de notificações. Nota O sistema retorna este parâmetro apenas se o usuário tiver definido uma URL de chatbot do DingTalk no console. Para configurar, passe o ponteiro sobre a foto do perfil no canto superior direito e clique em no ícone Editar ao lado de Notice. Caso o usuário não tenha definido uma URL de chatbot do DingTalk, o sistema não retorna este parâmetro.
Webhook	String	http://dms-XXX.aliyun.com:8***	URL do webhook para recebimento de notificações. Nota Se o usuário tiver definido uma URL de webhook, o DMS envia notificações para o endereço especificado. Caso o usuário não tenha definido uma URL de webhook, o sistema não retorna este parâmetro.
SignatureMethod	String	HMAC_SHA1	Método de assinatura usado para proteger conexões via webhook. Valores válidos: NONE: sem assinatura. HMAC_SHA1: HMAC-SHA1.
NotificationMode	String	DINGROBOT	Método de notificação. O sistema pode retornar um ou mais valores. Valores válidos: SMS: mensagem de texto. EMAIL: e-mail. DingTalk: DingTalk. DINGROBOT: chatbot do DingTalk. WEBHOOK: webhook.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true: solicitação bem-sucedida. false: falha na solicitação.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

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 erro

Para obter uma lista de códigos de erro, visite o Centro de Erros de API.