SearchUser - Drive and Photo Service: Central de Documentação do Alibaba Cloud

Pesquisa 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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Sintaxe da solicitação

POST /v2/user/search HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
domain_id	string	Sim	O ID do domínio.
body	object	Não	O corpo da solicitação.
nick_name	string	Não	O apelido do usuário. O comprimento máximo é de 128 caracteres.	pdsuer
nick_name_for_fuzzy	string	Não	Uma palavra-chave para uma pesquisa aproximada de apelidos. O comprimento máximo é de 128 caracteres.	la
user_name	string	Não	O nome do usuário. O comprimento máximo é de 128 caracteres.	pds
phone	string	Não	O número de telefone do usuário.	13900001111
email	string	Não	O endereço de e-mail do usuário.	123@pds.com
status	string	Não	O status do usuário. `disabled`: O usuário está desativado. `enabled`: O usuário está ativado. Valores válidos: disabled : Desativado. enabled : Ativado.	enabled
role	string	Não	A função do usuário. Valores válidos: `superadmin`: superadministrador `admin`: administrador `user`: usuário comum Valores válidos: superadmin : superadministrador. admin : administrador. user : usuário.	user
marker	string	Não	O marcador de paginação. Os resultados são retornados em ordem alfabética, a partir da entrada que segue o marcador. Se este parâmetro não for especificado, a consulta começará do início da lista. Valor padrão: None	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
limit	integer	Não	O número máximo de usuários a serem retornados por página. Valores válidos: 1 a 100. Valor padrão: 100.	100

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
next_marker	string	O token para recuperar a próxima página de resultados. Este parâmetro fica vazio quando não há mais resultados a serem retornados.	NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg
items	array	Uma lista de usuários.
	User	As informações do usuário.

Exemplos

Resposta de sucesso

JSON formato

{
  "next_marker": "NWQ1Yjk4YmI1ZDRlYmU1Y2E0YWE0NmJhYWJmODBhNDQ2NzhlMTRhMg",
  "items": [
    {
      "domain_id": "bj1",
      "user_id": "c9b7a5aa04d14ae3867fdc886fa01da4",
      "avatar": "http://aa.com/1.jpg",
      "created_at": 1639762579768,
      "updated_at": 1639762579768,
      "email": "a@aliyunpds.com",
      "nick_name": "001",
      "phone": "13900001111",
      "role": "user",
      "status": "enabled",
      "user_name": "pds",
      "description": "vipuser",
      "default_drive_id": "1",
      "creator": "user1",
      "last_login_time": 0,
      "last_refresh_token_time": 0,
      "user_data": {
        "key": ""
      }
    }
  ]
}

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.