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

Consulta os usuários de uma instância do Bastionhost especificada.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para facilitar, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListUsers	Operação a ser executada. Defina o valor como ListUsers.
InstanceId	String	Sim	bastionhost-cn-st220aw****	ID da instância do Bastionhost à qual pertencem os usuários consultados. Nota Chame a operação DescribeInstances para consultar o ID da instância do Bastionhost.
RegionId	String	Não	cn-hangzhou	ID da região da instância do Bastionhost à qual pertencem os usuários consultados. Nota Para obter mais informações sobre o mapeamento entre IDs e nomes de regiões, consulte Regiões e zonas.
PageNumber	String	Não	1	Número da página a ser retornada. Valor padrão: 1.
PageSize	String	Não	20	Número de entradas a serem retornadas em cada página. O valor do parâmetro PageSize não deve exceder 100. Por padrão, são retornadas 20 entradas por página. Caso o parâmetro PageSize não seja definido, 20 entradas serão retornadas por página. Nota Recomendamos não deixar este parâmetro vazio.
UserName	String	Não	abc	Nome de logon do usuário a ser consultado. Somente correspondência exata é suportada.
DisplayName	String	Não	User	Nome de exibição do usuário a ser consultado. Somente correspondência exata é suportada.
Source	String	Não	Local	Origem do usuário a ser consultado. Valores válidos: Local: usuário local RAM: usuário RAM
Mobile	String	Não	1359999****	Número de celular do usuário a ser consultado. Somente correspondência exata é suportada.
UserState	String	Não	Normal	Status do usuário a ser consultado. Valores válidos: Normal: o usuário pode acessar a instância do Bastionhost. Frozen: o usuário está bloqueado e não pode acessar a instância do Bastionhost. Expired: o usuário expirou e não pode acessar a instância do Bastionhost.
SourceUserId	String	Não	122748924538****	ID exclusivo do usuário a ser consultado. Somente correspondência exata é suportada. Nota Este parâmetro identifica exclusivamente um usuário RAM da instância do Bastionhost e entra em vigor apenas quando o parâmetro Source está definido como RAM. Chame a operação ListUsers para obter o ID exclusivo do usuário no parâmetro de resposta UserId.
UserGroupId	String	Não	1	ID do grupo de usuários a ser consultado. Nota Chame a operação ListUserGroups para consultar o ID do grupo de usuários.

Todas as operações de API do Alibaba Cloud devem incluir parâmetros de solicitação comuns. Para obter mais informações sobre esses parâmetros, consulte Parâmetros comuns.

Para obter mais informações sobre exemplos de solicitações, consulte a seção "Exemplos" deste tópico.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE	ID da solicitação.
TotalCount	Integer	1	Número total de usuários consultados.
Users	Array of Item		Lista de usuários consultados.
Comment	String	comment	Descrição do usuário.
DisplayName	String	Bob	Nome de exibição do usuário.
Email	String	1099**@qq.com	Endereço de e-mail do usuário.
Mobile	String	1359999****	Número de celular do usuário.
MobileCountryCode	String	CN	País onde o número de celular do usuário está registrado. Valores válidos: CN: China continental, cujo código de chamada internacional é +86 HK: Hong Kong (China), cujo código de chamada internacional é +852 MO: Macau (China), cujo código de chamada internacional é +853 TW: Taiwan (China), cujo código de chamada internacional é +886 RU: Rússia, cujo código de chamada internacional é +7 SG: Singapura, cujo código de chamada internacional é +65 MY: Malásia, cujo código de chamada internacional é +60 ID: Indonésia, cujo código de chamada internacional é +62 DE: Alemanha, cujo código de chamada internacional é +49 AU: Austrália, cujo código de chamada internacional é +61 US: Estados Unidos, cujo código de chamada internacional é +1 AE: Emirados Árabes Unidos, cujo código de chamada internacional é +971 JP: Japão, cujo código de chamada internacional é +81 GB: Reino Unido, cujo código de chamada internacional é +44 IN: Índia, cujo código de chamada internacional é +91 KR: Coreia do Sul, cujo código de chamada internacional é +82 PH: Filipinas, cujo código de chamada internacional é +63 CH: Suíça, cujo código de chamada internacional é +41 SE: Suécia, cujo código de chamada internacional é +46
Source	String	Local	Origem do usuário. Valores válidos: Local: usuário local RAM: usuário RAM
SourceUserId	String	122748924538****	ID exclusivo do usuário. Nota Este parâmetro identifica exclusivamente um usuário RAM da instância do Bastionhost. Um valor será retornado se o parâmetro Source estiver definido como RAM. Nenhum valor será retornado se o parâmetro Source estiver definido como Local.
UserId	String	1	ID do usuário.
UserName	String	abc_def	Nome de logon do usuário.
UserState	List	["Normal"]	Status do usuário. Valores válidos: Normal: o usuário pode acessar a instância do Bastionhost. Frozen: o usuário está bloqueado e não pode acessar a instância do Bastionhost. Expired: o usuário expirou e não pode acessar a instância do Bastionhost.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=ListUsers
&InstanceId=bastionhost-cn-st220aw****
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

<ListUsersResponse>
      <TotalCount>1</TotalCount>
      <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
      <Users>
            <Comment>comment</Comment>
            <UserName>abc_def</UserName>
            <Email>1099**@qq.com</Email>
            <UserId>1</UserId>
            <SourceUserId>122748924538****</SourceUserId>
            <MobileCountryCode>CN</MobileCountryCode>
            <DisplayName>Bob</DisplayName>
            <Mobile>1359999****</Mobile>
            <Source>Local</Source>
            <UserState>Normal</UserState>
      </Users>
</ListUsersResponse>

Formato JSON

{
    "TotalCount": "1",
    "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
    "Users": [{
        "Comment": "comment",
        "UserName": "abc_def",
        "Email": "1099**@qq.com",
        "UserId": "1",
        "SourceUserId": "122748924538****",
        "MobileCountryCode": "CN",
        "DisplayName": "Bob",
        "Mobile": "1359999****",
        "Source": "Local",
        "UserState": ["Normal"]
    }]
}

Códigos de erro

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