Obtém a lista de usuários de um bastion host especificado.
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
yundun-bastionhost:ListUsers |
get |
*Todos os recursos.
|
Nenhuma | Nenhuma |
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| InstanceId |
string |
Sim |
O ID da instância do bastion host para o qual você deseja consultar a lista de usuários. Nota
Você pode invocar a operação DescribeInstances para obter esse parâmetro. |
bastionhost-cn-st220aw**** |
| RegionId |
string |
Não |
O ID da região do bastion host para o qual você deseja consultar a lista de usuários. Nota
Para o mapeamento entre IDs de região e nomes de região, consulte Regiões e zonas. |
cn-hangzhou |
| PageNumber |
string |
Não |
O número da página atual em uma consulta paginada. Valor padrão: 1. |
1 |
| PageSize |
string |
Não |
O número máximo de entradas por página em uma consulta paginada. Nota
Não deixe PageSize vazio. |
20 |
| UserName |
string |
Não |
O nome de logon do usuário que você deseja consultar. Apenas correspondência exata é suportada. |
abc |
| DisplayName |
string |
Não |
O nome de exibição do usuário que você deseja consultar. Apenas correspondência exata é suportada. |
testuser |
| Source |
string |
Não |
A origem do usuário que você deseja consultar. Valores válidos:
|
Local |
| Mobile |
string |
Não |
O número de telefone celular do usuário que você deseja consultar. Apenas correspondência exata é suportada. |
1359999**** |
| UserState |
string |
Não |
O status do usuário que você deseja consultar. Valores válidos:
|
Normal |
| SourceUserId |
string |
Não |
A identidade única do usuário que você deseja consultar. Apenas correspondência exata é suportada. Nota
Este parâmetro é a identidade única do usuário do Resource Access Management (RAM) que corresponde ao usuário do bastion host. Este parâmetro entra em vigor quando a origem do usuário recém-criado é um usuário RAM (ou seja, Source está definido como Ram). Você pode invocar a operação ListUsers de controle de acesso e obter esse parâmetro no campo UserId da resposta. |
122748924538**** |
| UserGroupId |
string |
Não |
O ID do grupo de usuários que você deseja consultar. Nota
Você pode chamar a operação ListUserGroups para obter esse parâmetro. |
1 |
Ao chamar esta operação, você deve incluir os parâmetros de solicitação comuns das APIs do Alibaba Cloud, além dos parâmetros de solicitação descritos neste tópico. Para mais informações sobre parâmetros de solicitação comuns, consulte Parâmetros comuns. Para o formato de solicitação desta operação, consulte os exemplos de solicitação neste tópico.
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
Os dados da resposta. |
||
| TotalCount |
integer |
O número total de usuários retornados. |
1 |
| RequestId |
string |
O ID da solicitação. |
EC9BF0F4-8983-491A-BC8C-1B4DD94976DE |
| Users |
array<object> |
A lista de usuários retornada. |
|
|
object |
|||
| DisplayName |
string |
O nome de exibição do usuário. |
Bob |
|
string |
O endereço de e-mail do usuário. |
1099**@qq.com |
|
| Comment |
string |
As observações do usuário. |
comment |
| MobileCountryCode |
string |
O código de país do número de telefone celular do usuário. Valores válidos:
|
CN |
| Mobile |
string |
O número de telefone celular do usuário. |
1359999**** |
| UserId |
string |
O ID do usuário. |
1 |
| Source |
string |
A origem do usuário. Valores válidos:
|
Local |
| UserName |
string |
O nome de logon do usuário. |
abc_def |
| SourceUserId |
string |
A identidade única do usuário. Nota
Este parâmetro é a identidade única do usuário do Resource Access Management (RAM) que corresponde ao usuário do bastion host. Este parâmetro é retornado quando a origem do usuário é um usuário RAM (ou seja, Source está definido como Ram). Se a origem do usuário for um usuário local (ou seja, Source está definido como Local), este parâmetro estará vazio. |
122748924538**** |
| UserState |
array |
O array de status do usuário. |
|
|
string |
O status do usuário. Valores válidos:
|
["Normal"] |
|
| EffectiveStartTime |
integer |
A hora de início do período de validade do usuário, em segundos (formato de timestamp UNIX). |
1669630029 |
| EffectiveEndTime |
integer |
A hora de término do período de validade do usuário, em segundos (formato de timestamp UNIX). |
1672502400 |
| NeedResetPassword |
boolean |
Indica se a senha deve ser redefinida no próximo logon. Valores válidos:
|
true |
| TwoFactorStatus |
string |
O status de autenticação de dois fatores do usuário. Valores válidos:
|
Enable |
| TwoFactorMethods |
array |
O array de métodos de autenticação de dois fatores ativados. |
|
|
string |
O array de métodos de autenticação de dois fatores ativados. No máximo um método é suportado. Valores válidos:
|
[ "sms" ] |
|
| LanguageStatus |
string |
A configuração de idioma para notificações de mensagens. Valores válidos:
|
Custom |
| Language |
string |
O idioma para notificações de mensagens. Este parâmetro é obrigatório quando LanguageStatus está definido como Custom. Valores válidos:
|
en |
Exemplos
Resposta de sucesso
JSON formato
{
"TotalCount": 1,
"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
"Users": [
{
"DisplayName": "Bob",
"Email": "1099**@qq.com",
"Comment": "comment",
"MobileCountryCode": "CN",
"Mobile": "1359999****",
"UserId": "1",
"Source": "Local",
"UserName": "abc_def",
"SourceUserId": "122748924538****",
"UserState": [
"[\"Normal\"]"
],
"EffectiveStartTime": 1669630029,
"EffectiveEndTime": 1672502400,
"NeedResetPassword": true,
"TwoFactorStatus": "Enable",
"TwoFactorMethods": [
"[\n \"sms\"\n]"
],
"LanguageStatus": "Custom",
"Language": "en"
}
]
}Códigos de erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
Descrição |
|---|---|---|---|
| 400 | InvalidParameter | The argument is invalid. | |
| 500 | InternalError | An unknown error occurred. |
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.