DescribeInstanceVncUrl

查询一台 ECS 实例的 Web 管理终端地址。

描述

调用该接口时,您需要注意:

  • 管理终端地址的有效期为 15 秒,调用接口成功后如果 15 秒内不使用该链接,URL 地址自动失效,您需要重新查询。
  • 单个管理终端链接的 持久链接(KeepAlive)时间为 60 秒,60 秒内您管理终端窗口没有任何交互操作时,连接自动断开。
  • 如果连接中断,每分钟内重新连接的次数不能超过 30 次。
  • 您需要在链接 https://g.alicdn.com/aliyun/ecs-console-vnc/0.0.7/index.html? 末尾加上 vncUrl=xxxxinstanceId=xxxisWindows=TrueisWindows=Falsepassword=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
              

调试

前往【API Explorer】在线调试,API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力,能显著降低使用云 API 的难度,强烈推荐使用。

请求参数

名称 类型 是否必选 示例值 描述
InstanceId String i-AY121018033933eaxxxxxxx

实例 ID。

RegionId String cn-hangzhou

实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

Action String DescribeInstanceVncUrl

系统规定参数。取值:DescribeInstanceVncUrl

OwnerAccount String ECSforCloud@Alibaba.com

RAM用户的账号登录名称。

返回参数

名称 类型 示例值 描述
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求 ID。无论调用接口成功与否,我们都会返回请求 ID。

VncUrl String ws%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996

管理终端 Url

示例

请求示例


https://ecs.aliyuncs.com/?Action=DescribeInstanceVncUrl
&InstanceId=i-AY121018033933eaxxxxxxx
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

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 格式

{
	"VncUrl":"ws%3A%2F%2Fhz01-vncproxy.aliyun.com%2Fwebsockify%2F%3Fs%3DDvh%252FIA%252BYc73gWO48cBx2gBxUDVzaAnSKr74pq30mzqUYgeUMcB%252FbkNixDxdEA996",
	"RequestId":"1450F2D7-5435-4420-BBC9-49C514B0157E"
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidRegionId.NotFound The specified RegionId does not exist. 指定的 RegionId 不存在,请您检查此产品在该地域是否可用。
403 InstanceNotReady The specified instance is not ready for use 该资源目前的状态不支持此操作,请您等待一段时间再进行操作,并确认实例目前状态与操作是否冲突。

查看本产品错误码

发布者:佚, 佚名,转转请注明出处:https://www.cms2.cn/aliyun/1975.html

发表评论

邮箱地址不会被公开。 必填项已用*标注