DescribeVncUrl

1. 接口描述

本接口用于获取实例VNC地址。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称
必选
类型
描述

instanceId

是

String

要查询的实例ID。

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 requestId。

url

String

VNC地址URL。

4. 代码示例

1. 获取实例的VNC地址。

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeVncUrl
<Common Request Params>

Request：
{
  "instanceId": "<instanceId>"
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "url": "https://vnc.asia-southeast-2a.zec.zenservice.cn/vnc/index?s=xxxxxxxx"
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码
错误码
说明

404

INVALID_INSTANCE_NOT_FOUND

服务器实例不存在。

400

OPERATION_DENIED_INSTANCE_STATUS_NOT_SUPPORT

实例状态不允许操作。

PreviousReleaseInstancesNextDescribeInstanceMonitorData

Last updated