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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também 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	ListHostGroups	Operação a ser executada. Defina o valor como ListHostGroups.
InstanceId	String	Sim	bastionhost-cn-st220aw****	ID da instância do Bastionhost onde os grupos de hosts 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 hosts 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 retornar. Valor padrão: 1.
PageSize	String	Não	20	Quantidade de entradas a retornar por página. O valor do parâmetro PageSize não deve exceder 100. Valor padrão: 20. Se esse parâmetro ficar vazio, o sistema retorna 20 entradas por página. Nota Recomendamos não deixar o parâmetro PageSize vazio.
HostGroupName	String	Não	Host group 1	Nome do grupo de hosts a consultar. Somente correspondência exata é compatível.

Todas as operações de API do Alibaba Cloud exigem parâmetros de solicitação comuns. 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
HostGroups	Array of Item		Grupos de hosts retornados.
Comment	String	Description	Descrição do grupo de hosts.
HostGroupId	String	1	ID do grupo de hosts.
HostGroupName	String	Host group 1	Nome do grupo de hosts.
MemberCount	Integer	1	Quantidade de hosts no grupo.
RequestId	String	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE	ID da solicitação.
TotalCount	Integer	1	Total de grupos de hosts retornados.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

Formato XML

<ListHostGroupsResponse>
      <TotalCount>1</TotalCount>
      <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
      <HostGroups>
            <Comment>Description</Comment>
            <MemberCount>1</MemberCount>
            <HostGroupId>1</HostGroupId>
            <HostGroupName>Host group 1</HostGroupName>
      </HostGroups>
</ListHostGroupsResponse>

Formato JSON

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

Códigos de erro

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