查詢一台 ECS 執行個體的 Web 管理終端 地址。
描述
調用該介面時,您需要注意:
-
管理終端地址的有效期間為 15 秒,調用介面成功後如果 15 秒內不使用該連結,URL 地址自動失效,您需要重新查詢。
-
單個管理終端連結的 持久連結(KeepAlive)時間為 60 秒,60 秒內您管理終端視窗沒有任何互動操作時,串連自動斷開。
-
如果串連中斷,每分鐘內重新串連的次數不能超過 30 次。
-
您需要在連結 https://g.alicdn.com/aliyun/ecs-console-vnc/0.0.7/index.html? 末尾加上
vncUrl=xxxx
、instanceId=xxx
和isWindows=True
、isWindows=False
和password=XXXXXX
,參數之間使用&
串連。其中:-
參數
vncUrl
:調用介面成功後會返回的VncUrl
的值。 -
參數
instanceId
:您的執行個體 ID。 -
參數
isWindows
:該執行個體的作業系統是否是 Windows 系統。取值為true
表示是 Windows 系統,取值為false
表示不是 Windows 系統。 -
(可選)參數
password
:該執行個體的遠端連線密碼,由 6 位元字或大小寫字母組成。使用該參數時,在串連管理終端處您不需要再輸入密碼。樣本:
https://g.alicdn.com/aliyun/ecs-console-vnc/0.0.7/index.html?vncUrl=ws%3A%2F%xxx&instanceId=i-wz9hhwq5a6tmxxxxxxx&isWindows=true
或
https://g.alicdn.com/aliyun/ecs-console-vnc/0.0.7/index.html?vncUrl=ws%3A%2F%xxx&instanceId=i-wz9hhwq5a6tmxxxxxxx&isWindows=true&Password=111111
-
請求參數
名稱 | 類型 | 是否必需 | 描述 |
---|---|---|---|
Action | String | 是 | 系統規定參數。取值:DescribeInstanceVncUrl |
RegionId | String | 是 | 執行個體所屬的地域 ID。您可以調用 DescribeRegions 查看最新的阿里雲地域列表。 |
InstanceId | String | 是 | 執行個體 ID。 |
返回參數
名稱 | 類型 | 描述 |
---|---|---|
VncUrl | String | 管理終端 Url |
樣本
請求樣本
https://ecs.aliyuncs.com/?Action=DescribeInstanceVncUrl
&RegionId=cn-qingdao
&InstanceId=AY121018033933eaxxxxxxx
&<公共請求參數>
返回樣本
XML 格式
<DescribeInstanceVncUrlResponse>
<RequestId>1450F2D7-5435-4420-BBC9-49C5xxxxxxxx</RequestId>
<VncUrl>ws%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996</VncUrl>
</DescribeInstanceVncUrlResponse>
JSON 格式
{
"RequestId": "1450F2D7-5435-4420-BBC9-49C514B0157E",
"VncUrl": "ws%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996"
}
錯誤碼
以下為本介面特有的錯誤碼。更多錯誤碼,請訪問 API 錯誤中心。
錯誤碼 | 錯誤資訊 | HTTP 狀態碼 | 說明 |
---|---|---|---|
IncorrectInstanceStatus | The current status of the resource does not support this operation. | 403 | 指定執行個體的狀態需要處於 運行中 (Running )。 |
InstanceNotReady | The specified instance is not ready for use | 403 | 指定的執行個體正在建立中,請稍後再試。 |
InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 404 | 指定的 InstanceId 不存在。 |
InvalidRegionId.NotFound | The specified RegionId does not exist. | 404 | 指定的 RegionId 不存在。 |