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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos usar esta operação no OpenAPI Explorer, que também gera dinamicamente códigos de exemplo para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListHosts	Operação a ser executada. Defina o valor como ListHosts.
InstanceId	String	Sim	bastionhost-cn-st220aw****	ID da instância do Bastionhost onde os 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 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 for deixado vazio, 20 entradas serão retornadas por página. Nota Recomendamos não deixar o parâmetro PageSize vazio.
OSType	String	Não	Linux	Sistema operacional do host a consultar. Valores válidos: Linux Windows
HostName	String	Não	host	Nome do host a consultar. Somente correspondência exata é suportada.
HostAddress	String	Não	1.1.XX.XX	Endpoint do host a consultar. Aceita nome de domínio ou endereço IP. Somente correspondência exata é suportada.
source	String	Não	Local	Origem do host a consultar. Valores válidos: Local: host local (on-premises) Ecs: instância do Elastic Compute Service (ECS) Rds: host em cluster dedicado
SourceInstanceId	String	Não	i-bp19ienyt0yax748****	ID da instância ECS ou do host de cluster dedicado a consultar. Somente correspondência exata é suportada.
SourceInstanceState	String	Não	Normal	Status do host a consultar. Valores válidos: Normal: host normal. Release: host liberado.
HostGroupId	String	Não	1	ID do grupo de hosts ao qual o host consultado pertence. Nota Chame a operação ListHostGroups para obter o ID do grupo de hosts.

Todas as operações de API da Alibaba Cloud devem incluir parâmetros de solicitação comuns. Para mais informações, 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
Hosts	Array of Item		Hosts consultados.
ActiveAddressType	String	Public	Tipo de endpoint do host. Valores válidos: Public: endpoint público Private: endpoint interno
Comment	String	host	Descrição do host.
HostAccountCount	Integer	1	Quantidade de contas associadas ao host.
HostId	String	1	ID do host.
HostName	String	name	Nome do host.
HostPrivateAddress	String	192.168.XX.XX	Endpoint interno do host. Pode ser um nome de domínio ou um endereço IP.
HostPublicAddress	String	1.1.XX.XX	Endpoint público do host. Pode ser um nome de domínio ou um endereço IP.
OSType	String	Linux	Sistema operacional do host. Valores válidos: Linux Windows
source	String	Local	Origem do host. Valores válidos: Local: host local (on-premises) Ecs: instância do Elastic Compute Service (ECS) Rds: host em cluster dedicado
SourceInstanceId	String	i-bp19ienyt0yax748****	ID da instância ECS ou do host de cluster dedicado consultado. Nota Nenhum valor será retornado se o parâmetro source estiver definido como Local.
SourceInstanceState	String	Normal	Status do host. Valores válidos: Normal: host normal. Release: host liberado.
RequestId	String	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE	ID da solicitação.
TotalCount	Integer	1	Número total de hosts consultados.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

Formato XML

<ListHostsResponse>
      <Hosts>
            <Comment>host</Comment>
            <ActiveAddressType>Public</ActiveAddressType>
            <HostPrivateAddress>192.168.XX.XX</HostPrivateAddress>
            <HostPublicAddress>1.1.XX.XX</HostPublicAddress>
            <OSType>Linux</OSType>
            <HostId>1</HostId>
            <HostAccountCount>1</HostAccountCount>
            <SourceInstanceId>i-bp19ienyt0yax748****</SourceInstanceId>
            <SourceInstanceState>Normal</SourceInstanceState>
            <HostName>name</HostName>
            <Source>Local</Source>
      </Hosts>
      <TotalCount>1</TotalCount>
      <RequestId>EC9BF0F4-8983-491A-BC8C-1B4DD94976DE</RequestId>
</ListHostsResponse>

Formato JSON

{
	"Hosts": [{
		"Comment": "host",
		"ActiveAddressType": "Public",
		"HostPrivateAddress": "192.168.XX.XX",
		"HostPublicAddress": "1.1.XX.XX",
		"OSType": "Linux",
		"HostId": "1",
		"HostAccountCount": "1",
		"SourceInstanceId": "i-bp19ienyt0yax748****",
		"SourceInstanceState": "Normal",
		"HostName": "name",
		"Source": "Local"
	}],
	"TotalCount": "1",
	"RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE"
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o API Error Center.