Todos os produtos
Search

Este produto

    Data Management:ListUsers

    Central de documentação

    Data Management:ListUsers

    Última atualização: Jun 29, 2026

    Consulta os detalhes dos usuários.

    Experimente agora

    Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

    Testar

    Autorização RAM

    A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

    • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

    • API: A API que você pode chamar para executar a ação.

    • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

    • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

      • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

      • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

    • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

    • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

    Ação

    Nível de acesso

    Tipo de recurso

    Chave de condição

    Ação dependente

    dms:ListUsers

    list

    *All Resource

    *

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    Tid

    integer

    Não

    O ID do locatário. Você pode chamar a operação GetUserActiveTenant para obter o ID do locatário.

    3***
    Role

    string

    Não

    A função atribuída ao usuário. Valores válidos:

    • USER: um usuário comum.

    • DBA : um administrador de banco de dados (DBA).

    • ADMIN: um administrador do Data Management (DMS).

    • SECURITY_ADMIN: um administrador de segurança.

    • STRUCT_READ_ONLY: um usuário com acesso somente leitura ao schema.

    Nota

    Para verificar sua função, passe o ponteiro sobre a foto do perfil no canto superior direito do console do DMS.

    DBA
    UserState

    string

    Não

    O status do usuário. Valores válidos:

    • NORMAL: O usuário está normal.

    • DISABLE: O usuário está desativado.

    • DELETE: O usuário está excluído.

    NORMAL
    SearchKey

    string

    Não

    A palavra-chave de pesquisa. Há suporte para correspondência aproximada.

    test
    PageNumber

    integer

    Não

    O número da página a ser retornada.

    1
    PageSize

    integer

    Não

    O número de entradas a serem retornadas em cada página.

    Valores válidos: 10, 20, 50 e 100. Valor padrão: 10.

    10

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    TotalCount

    integer

    O número total de entradas retornadas.

    3
    RequestId

    string

    O ID da solicitação.

    69161997-6030-53BA-A333-DBEC83B732FF
    ErrorCode

    string

    O código de erro retornado se a solicitação falhar.

    InvalidTid
    ErrorMessage

    string

    A mensagem de erro retornada se a solicitação falhar.

    Specified parameter Tid is not valid.
    UserList

    object

    User

    array<object>

    Os detalhes dos usuários.

    array<object>

    Os detalhes do usuário.

    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.

    Nota

    • 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.

    Nota

    • 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.

    Nota

    • 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.

    Nota

    • 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

    Indica se a solicitação foi bem-sucedida. Valores válidos:

    • true: A solicitação foi bem-sucedida.

    • false: A solicitação falhou.

    true

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "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
}

    Códigos de erro

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.