DescribeInstanceVncUrl - Elastic Compute Service: Central de Documentação do Alibaba Cloud

Descrição da operação

A API retorna uma URL de logon VNC (VncUrl) que não pode ser usada diretamente. Você pode acessar a instância por meio da URL do terminal de gerenciamento.

Nota

Para construir a URL do terminal de gerenciamento, anexe vncUrl=\*\*\*\*, instanceId=**** e isWindows=true/false ao final de https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html? e conecte os parâmetros com &. Parâmetros:

vncUrl: a URL de logon VNC.
instanceId: o ID da instância.
isWindows: especifica se o sistema operacional da instância é Windows. O valor true indica Windows. O valor false indica não Windows.
Conexões VNC sem senha são suportadas. Você não precisa definir o parâmetro password.

O tempo de KeepAlive de uma única URL de terminal de gerenciamento é de 300 segundos. Se nenhuma interação ocorrer dentro de 300 segundos, a conexão será fechada automaticamente.
Se a conexão for interrompida, chame esta operação novamente para obter uma nova VncUrl e construir uma nova URL de terminal de gerenciamento para reconectar. Você pode reconectar até 30 vezes por minuto.

Exemplo de URL de terminal de gerenciamento:

https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?vncUrl=ws%3A%2F%****&instanceId=i-wz9hhwq5a6tm****&isWindows=true
```.

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

ecs:DescribeInstanceVncUrl

get

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da instância. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
InstanceId	string	Sim	O ID da instância.	i-bp1hzoinajzkh91h****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
VncUrl	string	A URL de logon VNC. Importante A URL de logon VNC é sensível ao tempo e válida por 15 segundos. Se você não usar a URL dentro de 15 segundos após uma chamada bem-sucedida, a URL expirará e você deverá chamar esta operação novamente para obter uma nova. .	wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Exemplos

Resposta de sucesso

JSON formato

{
  "VncUrl": "wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidRegionInstance	The specified InstanceId does not exist in given region.	The instance does not exist in the specified region.
500	InternalError	The request processing has failed due to some unknown error.
403	IncorrectInstanceStatus	The current status of the resource does not support this operation.
403	InstanceNotReady	The specified instance is not ready for use
404	InvalidRegionId.NotFound	The specified RegionId does not exist.	The specified region ID does not exist.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.	The specified instanceId is invalid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.