DescribeInstanceVncUrl - Elastic Compute Service - Centre de documentation Alibaba Cloud

Description de l'opération

L'API renvoie une URL de connexion VNC (VncUrl) qui ne peut pas être utilisée directement. Vous pouvez accéder à l'instance via l'URL du terminal de gestion.

Remarque

Pour construire l'URL du terminal de gestion, ajoutez vncUrl=****, instanceId=**** et isWindows=true/false à la fin de https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?, et reliez les paramètres avec &. Paramètres :

vncUrl : l'URL de connexion VNC.
instanceId : l'identifiant de l'instance.
isWindows : indique si le système d'exploitation de l'instance est Windows. La valeur true indique Windows. La valeur false indique un système autre que Windows.
Les connexions VNC sans mot de passe sont prises en charge. Vous n'avez pas besoin de définir le paramètre password.

La durée KeepAlive d'une URL de terminal de gestion est de 300 secondes. Si aucune interaction ne se produit dans un délai de 300 secondes, la connexion est automatiquement fermée.
Si la connexion est interrompue, appelez à nouveau cette opération pour obtenir une nouvelle VncUrl et construire une nouvelle URL de terminal de gestion pour vous reconnecter. Vous pouvez vous reconnecter jusqu'à 30 fois par minute.

Exemple d'URL de terminal de gestion :

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

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

ecs:DescribeInstanceVncUrl

get

*Instance

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région de l'instance. Vous pouvez appeler DescribeRegions pour obtenir la liste la plus récente des régions.	cn-hangzhou
InstanceId	string	Oui	L'identifiant de l'instance.	i-bp1hzoinajzkh91h****

Éléments de réponse

Élément	Type	Description	Exemple
	object
VncUrl	string	L'URL de connexion VNC. Important L'URL de connexion VNC est temporaire et n'est valide que pendant 15 secondes. Si vous n'utilisez pas l'URL dans les 15 secondes suivant un appel réussi, l'URL expire et vous devez appeler à nouveau cette opération pour en obtenir une nouvelle. .	wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Exemples

JSON format

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

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
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.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.