DescribeInstanceVncUrl - Elastic Compute Service

介面說明

介面傳回的是 VNC 登入位址（VncUrl），不能直接使用存取，您可以透過 Web 管理終端位址存取。

說明

Web 管理終端位址需在連結https://g.alicdn.com/aliyun/ecs-console-vnc2/0.0.8/index.html?末尾加上vncUrl=\*\*\*\*、instanceId=****和isWindows=true/false，參數之間使用&連接。其中：

vncUrl：VNC 登入位址。
instanceId：執行個體 ID。
isWindows：執行個體的作業系統是否為 Windows 系統。取值為true表示是 Windows 系統，取值為false表示不是 Windows 系統。
當前已支援免 VNC 密碼連線執行個體，您無需設定參數password。

單個管理終端連結位址的 KeepAlive 時間為 300 秒，300 秒內您與管理終端視窗沒有任何互動操作時，連線自動斷開。
如果連線中斷，您需要重新呼叫介面來取得新的VncUrl，以組成新的管理終端位址進行重新連線，且每分鐘內重新連線的次數不能超過 30 次。

Web 管理終端位址範例：

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

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:DescribeInstanceVncUrl

get

*Instance

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	執行個體所屬的地域 ID。您可以呼叫 DescribeRegions 查看最新的阿里雲地域列表。	cn-hangzhou
InstanceId	string	是	執行個體 ID。	i-bp1hzoinajzkh91h****

返回參數

名稱	類型	描述	樣本值
	object
VncUrl	string	VNC 登入位址。重要 VNC 登入位址存在時效性，有效期為 15 秒，呼叫介面成功後如果 15 秒內不使用該連結，該位址會自動失效，您需要重新呼叫介面取得。	wss%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	InvalidRegionInstance	The specified InstanceId does not exist in given 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.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。