ListUserGroups - Bastionhost: Central de Documentação do Alibaba Cloud

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

yundun-bastionhost:ListUserGroups

get

*Instance

acs:yundun-bastionhost:{#regionId}:{#accountId}:instance/{#InstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID do bastion host no qual você deseja consultar grupos de usuários. Nota Você pode chamar a operação DescribeInstances para consultar o ID do bastion host.	bastionhost-cn-st220aw****
RegionId	string	Não	O ID da região do bastion host no qual você deseja consultar grupos de usuários. Nota Para mais informações sobre 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 a ser retornada. Valor padrão: 1.	1
PageSize	string	Não	O número de entradas a serem retornadas em cada página. Valor máximo: 100. Valor padrão: 20. Se você deixar este parâmetro vazio, 20 entradas serão retornadas em cada página.	20
UserGroupName	string	Não	O nome do grupo de usuários que você deseja consultar. Apenas correspondência exata é suportada.	TestGroup01

Ao chamar esta operação de API, você deve incluir os parâmetros de solicitação comuns da API da Alibaba Cloud em sua solicitação, 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 da solicitação, consulte os exemplos de solicitação neste tópico.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados de resposta.
TotalCount	integer	O número total de grupos de usuários retornados.	1
RequestId	string	O ID da solicitação.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
UserGroups	array<object>	Os grupos de usuários retornados.
	object
UserGroupName	string	O nome do grupo de usuários.	TestGroup01
MemberCount	integer	O número de usuários no grupo de usuários.	6
Comment	string	A descrição do grupo de usuários.	comment
UserGroupId	string	O ID do grupo de usuários.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "UserGroups": [
    {
      "UserGroupName": "TestGroup01",
      "MemberCount": 6,
      "Comment": "comment",
      "UserGroupId": "1"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter	The argument is invalid.	The argument is invalid.
500	InternalError	An unknown error occurred.	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.