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

Obtém uma lista de instâncias do Bastionhost.

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

get

*Instance

acs:yundun-bastionhost:{#regionId}:{#accountId}:instance/{#InstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Não	O número da página a ser retornada. Valor padrão: 1.	1
PageSize	integer	Não	O número de instâncias do Bastionhost a serem retornadas em cada página. Valor padrão: 10.	10
PageNumber	integer	Não	O número da página a ser retornada. Valor padrão: 1.	1
RegionId	string	Não	O ID da região na qual as instâncias do Bastionhost residem.	cn-hangzhou
InstanceStatus	string	Não	O status da instância do Bastionhost. Valores válidos: PENDING: A instância não está inicializada. CREATING: A instância está sendo criada. RUNNING: A instância está em execução. EXPIRED: A instância expirou. CREATE_FAILED: A criação da instância falhou. UPGRADING: A instância está sendo atualizada. UPGRADE_FAILED: A atualização da instância falhou.	RUNNING
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual a instância do Bastionhost pertence.	rg-acfm26ougi****
InstanceId	array	Não	Os IDs das instâncias do Bastionhost.	bastionhost-cn-78v1ghxxxxx
	string	Não	O ID de uma instância do Bastionhost.	2
Tag	array<object>	Não	As tags associadas às instâncias do Bastionhost.
	object	Não	Uma tag, que consiste em um par chave-valor.
Key	string	Não	A chave da tag.	test
Value	string	Não	O valor da tag.	testapi

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	integer	O número total de instâncias do Bastionhost retornadas.	4
RequestId	string	O ID da solicitação. O Alibaba Cloud gera este ID exclusivo para fins de solução de problemas.	61D36C55-AAFC-4678-8FAD-34FEF9E7182E
Instances	array<object>	Uma lista de instâncias do Bastionhost.
	object
VpcId	string	O ID da VPC à qual a instância do Bastionhost está associada.	vpc-bp1c85tzgqu1bf5b****
VswitchId	string	O ID do vSwitch ao qual a instância do Bastionhost está associada.	vsw-bp1xfwzzfti0kjbf****
ImageVersion	string	A versão da imagem da instância do Bastionhost.	3.2.41
PlanCode	string	A edição da instância do Bastionhost. Valores válidos: cloudbastion: Edição Básica cloudbastion_ha: Edição Empresarial	cloudbastion_ha
Description	string	A descrição personalizada da instância do Bastionhost.	Test API
ExpireTime	integer	O horário de expiração da instância do Bastionhost, especificado como um timestamp em milissegundos.	1578326400000
Legacy	boolean	Indica se a instância do Bastionhost é uma instância legada. Valores válidos: true: A instância é da série V2 ou V3.1. false: A instância é da série V3.2.	false
InstanceId	string	O ID da instância do Bastionhost.	bastionhost-cn-78v1gh****
InternetEndpoint	string	O nome de domínio público da instância do Bastionhost.	******lwb-public.bastionhost.aliyuncs.com
RegionId	string	O ID da região da instância do Bastionhost.	cn-hangzhou
IntranetEndpoint	string	O nome de domínio privado da instância do Bastionhost.	******lwb.bastionhost.aliyuncs.com
StartTime	integer	O horário de compra ou renovação da instância do Bastionhost, especificado como um timestamp em milissegundos.	1577681345000
ResourceGroupId	string	O ID do grupo de recursos ao qual a instância do Bastionhost pertence.	g-acfm26ougi****
InstanceStatus	string	O status da instância do Bastionhost. Valores válidos: PENDING: Não inicializada CREATING: A instância está sendo criada. RUNNING: A instância está em execução. EXPIRED: A instância expirou. CREATE_FAILED: A criação da instância falhou. UPGRADING: A instância está sendo atualizada. UPGRADE_FAILED: A atualização da instância falhou.	RUNNING
LicenseCode	string	O código de licença da instância do Bastionhost.	bhah_ent_50_asset
PublicNetworkAccess	boolean	Indica se a instância do Bastionhost está acessível pela Internet. Valores válidos: true: A instância está acessível pela Internet. false: A instância não está acessível pela Internet.	true
SlaveVswitchId	string	O ID do vSwitch em standby ao qual a instância do Bastionhost está associada.	vsw-uf6j0u49poi8qr****
BandWidth	integer	A largura de banda padrão da instância, em Mbit/s.	60M

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 4,
  "RequestId": "61D36C55-AAFC-4678-8FAD-34FEF9E7182E",
  "Instances": [
    {
      "VpcId": "vpc-bp1c85tzgqu1bf5b****",
      "VswitchId": "vsw-bp1xfwzzfti0kjbf****",
      "ImageVersion": "3.2.41",
      "PlanCode": "cloudbastion_ha",
      "Description": "Test API",
      "ExpireTime": 1578326400000,
      "Legacy": false,
      "InstanceId": "bastionhost-cn-78v1gh****",
      "InternetEndpoint": "******lwb-public.bastionhost.aliyuncs.com",
      "RegionId": "cn-hangzhou",
      "IntranetEndpoint": "******lwb.bastionhost.aliyuncs.com",
      "StartTime": 1577681345000,
      "ResourceGroupId": "g-acfm26ougi****",
      "InstanceStatus": "RUNNING",
      "LicenseCode": "bhah_ent_50_asset",
      "PublicNetworkAccess": true,
      "SlaveVswitchId": "vsw-uf6j0u49poi8qr****",
      "BandWidth": 0
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.