ListHostGroupsForUserGroup - 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:ListHostGroupsForUserGroup

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID do bastion host ao qual o grupo de usuários pertence. 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 ao qual o grupo de usuários pertence. Nota Para obter mais informações sobre o mapeamento entre IDs de região e nomes de região, consulte Regiões e zonas.	cn-hangzhou
Mode	string	Não	Especifica a categoria do grupo de hosts que você deseja consultar. Valores válidos: Authorized: consulta os grupos de hosts que o grupo de usuários está autorizado a gerenciar. Este é o valor padrão. Unauthorized: consulta os grupos de hosts que o grupo de usuários não está autorizado a gerenciar.	Authorized
UserGroupId	string	Sim	O ID do grupo de usuários. Nota Você pode chamar a operação ListUserGroups para consultar o ID do grupo de usuários.	1
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. Nota Recomendamos que você não deixe este parâmetro vazio.	20
HostGroupName	string	Não	O nome do grupo de hosts que você deseja consultar. Há suporte apenas para correspondência exata.	group

Todas as operações de API do Alibaba Cloud devem incluir parâmetros de solicitação comuns. Para obter mais informações sobre os parâmetros de solicitação comuns, consulte Parâmetros comuns. Para obter mais informações sobre solicitações de exemplo, consulte a seção "Exemplos" deste tópico.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	integer	O número total de grupos de hosts retornados.	1
RequestId	string	O ID da solicitação.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
HostGroups	array<object>	Os grupos de hosts retornados.
	object
HostGroupId	string	O ID do grupo de hosts.	1
Comment	string	A descrição do grupo de hosts.	comment
HostGroupName	string	O nome do grupo de hosts.	group

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "HostGroups": [
    {
      "HostGroupId": "1",
      "Comment": "comment",
      "HostGroupName": "group"
    }
  ]
}

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.