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

Depuração

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListUserGroups	A operação a ser executada. Defina o valor como ListUserGroups.
InstanceId	String	Sim	bastionhost-cn-st220aw****	ID da instância do Bastionhost onde os grupos de usuários serão consultados. Nota Chame a operação DescribeInstances para obter o ID da instância do Bastionhost.
RegionId	String	Não	cn-hangzhou	ID da região da instância do Bastionhost onde os grupos de usuários serão consultados. Nota Para 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	Quantidade de entradas a serem retornadas em cada página. O valor do parâmetro PageSize não deve exceder 100. Valor padrão: 20. Se o parâmetro PageSize for deixado vazio, 20 entradas serão retornadas por página. Nota Recomendamos não deixar o parâmetro PageSize vazio.
UserGroupName	String	Não	TestGroup01	Nome do grupo de usuários a ser consultado. Somente correspondência exata é suportada.

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

Para ver 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 grupos de usuários retornados.
UserGroups	Array of Item		Grupos de usuários retornados.
Comment	String	comment	Descrição do grupo de usuários.
MemberCount	Integer	5	Quantidade de usuários no grupo.
UserGroupId	String	1	ID do grupo de usuários.
UserGroupName	String	TestGroup01	Nome do grupo de usuários.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

Formato XML

<ListUserGroupsResponse>
      <TotalCount>1</TotalCount>
      <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
      <UserGroups>
            <Comment>comment</Comment>
            <UserGroupName>TestGroup01</UserGroupName>
            <UserGroupId>1</UserGroupId>
            <MemberCount>5</MemberCount>
      </UserGroups>
</ListUserGroupsResponse>

Formato JSON

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

Códigos de erro

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