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

Consulta os hosts em um bastion host.

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

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 hosts. 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 hosts. 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
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 padrão: 10. Nota Recomendamos que você não deixe este parâmetro vazio.	20
OSType	string	Não	O sistema operacional do host que você deseja consultar. Valores válidos: Linux Windows	Linux
HostName	string	Não	O nome do host que você deseja consultar. Somente correspondência exata é suportada.	host
HostAddress	string	Não	O endereço do host que você deseja consultar. Você pode definir este parâmetro como um nome de domínio ou um endereço IP. Somente correspondência exata é suportada.	1.1.XX.XX
Source	string	Não	A origem do host que você deseja consultar. Valores válidos: Local: um host em um data center Ecs: uma instância do Elastic Compute Service (ECS) Rds: um host em um cluster dedicado do ApsaraDB MyBase	Local
SourceInstanceId	string	Não	O ID da instância ECS ou do host em um cluster dedicado do ApsaraDB MyBase que você deseja consultar. Somente correspondência exata é suportada.	i-bp19ienyt0yax748****
SourceInstanceState	string	Não	O status do host que você deseja consultar. Valores válidos: Normal: normal Release: liberado	Normal
HostGroupId	string	Não	O ID do grupo de hosts ao qual o host a ser consultado pertence. Nota Você pode chamar a operação ListHostGroups para consultar o ID do grupo de hosts.	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	integer	O número total de hosts retornados.	1
RequestId	string	O ID da solicitação, que é usado para localizar e solucionar problemas.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Hosts	array<object>	Uma matriz que contém os hosts retornados.
	object
Comment	string	A descrição do host.	host
ActiveAddressType	string	O tipo de endereço do host. Valores válidos: Public: um endereço público Private: um endereço privado	Public
HostPublicAddress	string	O endereço público do host. O valor é um nome de domínio ou um endereço IP.	1.1.XX.XX
HostName	string	O nome do host.	name
HostAccountCount	integer	O número de contas de host.	1
Source	string	A origem do host. Valores válidos: Local: um host em um data center Ecs: uma instância ECS Rds: um host em um cluster dedicado do ApsaraDB MyBase	Local
HostPrivateAddress	string	O endereço privado do host. O valor é um nome de domínio ou um endereço IP.	192.168.XX.XX
OSType	string	O sistema operacional do host. Valores válidos: Linux Windows	Linux
HostId	string	O ID do host.	1
SourceInstanceState	string	O status do host. Valores válidos: Normal: normal Release: liberado	Normal
SourceInstanceId	string	O ID da instância ECS ou do host em um cluster dedicado do ApsaraDB MyBase. Nota Nenhum valor é retornado para este parâmetro se o parâmetro Source estiver definido como Local.	i-bp19ienyt0yax748****

Exemplos

Resposta de sucesso

JSON formato

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

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.