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

Retorna todos os atributos da instância, como o ID da instância e a descrição.

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

get

*Instance

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região onde a instância do Bastionhost está localizada.	cn-hangzhou
InstanceId	string	Sim	O ID da instância do Bastionhost. Nota Você pode chamar a operação DescribeInstances para obter o ID da instância do Bastionhost.	bastionhost-cn-78v1ghxxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID único da solicitação. Você pode usar este ID para solucionar problemas.	082FAB35-6AB9-4FD5-8750-D36673548E76
InstanceAttribute	object	Os atributos da instância.
VpcId	string	O ID da Virtual Private Cloud (VPC) da instância.	vpc-bp1c85tzgqu1bf5bxxxxx
VswitchId	string	O ID do VSwitch da instância.	vsw-bp1xfwzzfti0kjbfxxxxx
Description	string	A descrição da instância.	Test API
ExpireTime	integer	O timestamp de expiração da instância do Bastionhost, em milissegundos.	1578326400000
ModifyPasswordModule	string	O status do recurso de alteração de senha. Enable: O recurso está ativado. Disable: O recurso está desativado.	Enable
EniInstanceId	string	O ID da interface de rede elástica (ENI).	eni-bp1455jrzwm7moaxxxxx
InstanceId	string	O ID da instância.	bastionhost-cn-78v1ghxxxxx
InternetEndpoint	string	O nome de domínio público da instância.	******lwb-public.bastionhost.aliyuncs.com
RegionId	string	O ID da região onde a instância do Bastionhost está localizada.	cn-hangzhou
IntranetEndpoint	string	O endpoint interno da instância.	******xalwb.bastionhost.aliyuncs.com
StartTime	integer	O timestamp em que a instância do Bastionhost foi adquirida ou renovada, em milissegundos.	1577681345000
ResourceGroupId	string	O ID do grupo de recursos da instância.	rg-aekzc427db******
NetworkProxyModule	string	O status do recurso de proxy de domínio de rede. Enable: O recurso de proxy de domínio de rede está ativado. Disable: O recurso de proxy de domínio de rede está desativado.	Enable
WebTerminalModule	string	O status do terminal web. Enable: Suporta conexões remotas baseadas na web. Disable: Não suporta conexões remotas baseadas na web.	Enable
InstanceStatus	string	O status da instância. Valores válidos: PENDING: A instância está sendo inicializada. CREATING: A instância está sendo criada. RUNNING: A instância está em execução. EXPIRED: A instância expirou. CREATE_FAILED: Falha na criação da instância. UPGRADING: A instância está sendo atualizada. UPGRADE_FAILED: Falha na atualização da instância.	RUNNING
LicenseCode	string	O código da licença.	bhah_ent_50_asset
PublicNetworkAccess	boolean	Indica se a instância do Bastionhost está acessível pela rede pública. Valores válidos: true: A instância do Bastionhost está acessível pela rede pública. false: A instância do Bastionhost não está acessível pela rede pública.	true
Storage	integer	A capacidade total de armazenamento da instância do Bastionhost, em bytes.	2199023255552
Ports	array<object>	As portas de O&M da instância do Bastionhost.
	object	Uma porta de O&M da instância do Bastionhost.
StandardPort	integer	The standard O&M port number. The following are the default standard ports for specific protocols: SSH: 60022 RDP: 63389 HTTPS: 443	60022
CustomPort	integer	The custom O&M port. Nota Only SSH and RDP ports can be customized. If no custom port is set, this parameter returns the value of the `StandardPort` parameter.	600xx
PublicExportIps	array	Uma lista de endereços IP de saída públicos da instância do Bastionhost.
	string	Um endereço IP de saída público.	[10.162.168.xx/32]
PublicWhiteList	array	A lista de permissões pública da instância do Bastionhost.
	string	Um endereço IP na lista de permissões pública.	[10.162.168.xx/32]
AuthorizedSecurityGroups	array	Uma lista de IDs de grupos de segurança autorizados.
	string	O ID de um grupo de segurança autorizado.	[sg-bp14u00sh39jvw5xxxxx]
PrivateExportIps	array	Uma lista de endereços IP de saída privados da instância do Bastionhost.
	string	Um endereço IP de saída privado.	192.168.xx.xx
PublicIps	array	Uma lista de endereços IP públicos da instância do Bastionhost.
	string	Um endereço IP público.	116.62.xx.xx
SecurityGroupIds	array	Uma lista dos IDs dos grupos de segurança da instância.
	string	O ID de um grupo de segurança que contém a instância.	sg-bp15ed6xe1yxeycg7o****
PrivateWhiteList	array	A lista de permissões privada da instância.
	string	Um endereço IP na lista de permissões privada.	192.168.xx.xx
Bandwidth	string	A largura de banda total da instância do Bastionhost, em Mbit/s.	30
BandwidthPackage	string	O pacote de largura de banda extra da instância do Bastionhost, em Mbit/s.	5
DbOperationModule	string	O status do recurso de O&M de banco de dados. Enable: O recurso de O&M de banco de dados está ativado. Disable: O recurso de O&M de banco de dados está desativado.	Disable
RouterRules	array	Uma lista de regras de roteamento para a instância do Bastionhost.
	string
IDaaSModule	string	Indica se o módulo de integração IDaaS está ativado. Os valores válidos são `Enable` e `Disable`.	Enable
SlaveVswitchId	string	O ID do VSwitch em standby para a instância do Bastionhost.	vsw-uf6cmnae7hu5****
ScriptDeliverModule	string	Indica se o módulo de O&M baseado em scripts está ativado. Os valores válidos são `Enable` e `Disable`.	Enable
KmsSecretModule	string	Indica se a instância está integrada ao Key Management Service (KMS) e ao Secrets Manager. Os valores válidos são `Enable` e `Disable`.	Enable
RDModule	string	Indica se o módulo de multiconta está ativado. Os valores válidos são `Enable` e `Disable`.	Enable
HSMModule	string	Indica se a instância do Bastionhost está integrada a um Hardware Security Module (HSM).
WhiteListPolicies	array<object>	As políticas de lista de permissões de endereços IP configuradas.
	object
Entry	string	An IP address or CIDR block in the whitelist.	94.74.xx.xx/32
Description	string	The description of the whitelist rule.	description
AppOperationModule	string	Indica se o módulo de O&M de aplicativos está ativado. Os valores válidos são `Enable` e `Disable`.	Enable

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "082FAB35-6AB9-4FD5-8750-D36673548E76",
  "InstanceAttribute": {
    "VpcId": "vpc-bp1c85tzgqu1bf5bxxxxx",
    "VswitchId": "vsw-bp1xfwzzfti0kjbfxxxxx",
    "Description": "Test API",
    "ExpireTime": 1578326400000,
    "ModifyPasswordModule": "Enable",
    "EniInstanceId": "eni-bp1455jrzwm7moaxxxxx",
    "InstanceId": "bastionhost-cn-78v1ghxxxxx",
    "InternetEndpoint": "******lwb-public.bastionhost.aliyuncs.com",
    "RegionId": "cn-hangzhou",
    "IntranetEndpoint": "******xalwb.bastionhost.aliyuncs.com",
    "StartTime": 1577681345000,
    "ResourceGroupId": "rg-aekzc427db******",
    "NetworkProxyModule": "Enable",
    "WebTerminalModule": "Enable",
    "InstanceStatus": "RUNNING",
    "LicenseCode": "bhah_ent_50_asset",
    "PublicNetworkAccess": true,
    "Storage": 2199023255552,
    "Ports": [
      {
        "StandardPort": 60022,
        "CustomPort": 0
      }
    ],
    "PublicExportIps": [
      "[10.162.168.xx/32]"
    ],
    "PublicWhiteList": [
      "[10.162.168.xx/32]"
    ],
    "AuthorizedSecurityGroups": [
      "[sg-bp14u00sh39jvw5xxxxx]"
    ],
    "PrivateExportIps": [
      "192.168.xx.xx"
    ],
    "PublicIps": [
      "116.62.xx.xx"
    ],
    "SecurityGroupIds": [
      "sg-bp15ed6xe1yxeycg7o****"
    ],
    "PrivateWhiteList": [
      "192.168.xx.xx"
    ],
    "Bandwidth": "30",
    "BandwidthPackage": "5",
    "DbOperationModule": "Disable",
    "RouterRules": [
      ""
    ],
    "IDaaSModule": "Enable",
    "SlaveVswitchId": "vsw-uf6cmnae7hu5****",
    "ScriptDeliverModule": "Enable",
    "KmsSecretModule": "Enable",
    "RDModule": "Enable",
    "HSMModule": "",
    "WhiteListPolicies": [
      {
        "Entry": "94.74.xx.xx/32",
        "Description": "description"
      }
    ],
    "AppOperationModule": "Enable"
  }
}

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.