获取边缘实例的 VNC 链接--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取边缘实例的 VNC 链接

最近更新时间：2024.08.27 15:30:42首次发布时间：2024.07.26 17:48:22

本接口用于获取边缘实例的 VNC 链接。

使用说明

前提条件：
边缘实例须处于运行中（running）状态。

请求说明

请求方式：POST
请求地址：https://veenedge.volcengineapi.com/?Action=GetVNCUrl&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	GetVNCUrl	要执行的操作，取值：GetVNCUrl。
Version	String	是	2021-04-30	API的版本，取值：2021-04-30。

Body

参数	类型	是否必填	示例值	描述
instance_identity	String	是	veen270206666202565****	边缘实例 ID。您可以通过 ListInstances 接口查询边缘实例 ID。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
vnc_url	String	veen-vnc.byte-edge.com/ws/v1/securevnc?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbHVzdGVyX25hbWUiOiJiZGNkbi1obnhjY3UwMSIsIm****	VNC 链接。注意当您使用 VNC 链接登录边缘实例时，须在 VNC 链接前添加前缀 wss://。

请求示例

POST https://veenedge.volcengineapi.com/?Action=GetVNCUrl&Version=2021-04-30
&<其他公共参数>
{
  "instance_identity": "veen270206666202565****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240726165554931ADD3524411252****",
        "Action": "GetVNCUrl",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "vnc_url": "veen-vnc.byte-edge.com/ws/v1/securevnc?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbHVzdGVyX25hbWUiOiJiZGNkbi1obnhjY3UwMSIsIm****"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。