接口说明
获取实例VNC远程登录地址。
注意事项:
- 当实例状态为
active时,才可获取实例VNC远程登录地址。
URL
GET https://ecloud.10086.cn/api/openapi-instance/v4/vnc-url
请求参数
Query
|
参数名称
|
类型
|
必填
|
描述
|
|
instanceId
|
string
|
是
|
实例ID,可通过查询实例状态列表接口获取。 |
请求示例
GET https://ecloud.10086.cn/api/openapi-instance/v4/vnc-url
返回参数
返回码:200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
VncInfo
|
请求成功时返回的数据。 |
|
vncUrl
|
string
|
VNC返回地址。 |
|
errorCode
|
string
|
统一错误码。 |
|
errorMessage
|
string
|
页面国际化错误提示。 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数。 |
|
requestId
|
string
|
每个请求的序列号。 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码。返回正常:OK,返回错误:ERROR,返回异常:EXCEPTION,需要告警实现的:ALARM,禁止访问:FORBIDDEN。 |
返回示例
返回码:200
OK
{
"requestId":"reqId-034dd847-7fb6-***",
"state":"OK",
"body":{
"vncUrl":"https://console-***.cn/vnc_auto.html?token=***&title=***"
}
}