调用此接口虚拟机必须安装被控端,并且安装有VNC服务才生效。

请求地址:

请求地址请求方法
/api/vm/vnc/passwordPOST

请求参数

参数类型是否必填最大长度描述示例值
vmidString32虚拟机ID
passwordString6

密码长度最大6位


modeInt1响应模式:0同步、1异步,默认为1,各差异如下:

同步:服务器不会立即响应客户端,一直等待超时或者任务已被执行(不管成功与失败)

异步:服务器会立即响应客户端,通过任务ID获得任务执行结果

clientidString32代理客户端ID

异步返回示例

{
    "errcode": "200",
    "errmsg": "ok",
    "data": {
        "vmid": "32",
        "taskid": "2h126a3682502fb8ad89a12444c40977"
    }
}

异步返回参数说明

参数描述
vmid虚拟机ID
taskid任务ID,可用于获取任务执行信息


同步返回示例

{
    "TaskID": "72ea58764c7f37c8a38cb6ca830f7501",
    "Describe": "关闭虚拟机(ID:143)",
    "Content": {
        "task": {
            "event_name": "agent_event_host_sethostname",
            "task_errcode": "200",
            "task_errmsg": "success"
        },
        "vm": {
            "vmid": "143"
        }
    },
    "InsertTime": 1695560050,
    "UpdateTime": 1695560050,
    "ExpireTime": 1695646450
}

同步返回参数说明

参数描述
TaskID任务ID
Describe任务描述
Clientid代理客户端ID
Content任务详情
    task任务执行信息
        event_name事件名称
        task_errcode错误代码
        task_errmsg错误提示
    vm虚拟机信息
        vmid虚拟机ID
InsertTime任务创建时间
UpdateTime任务更新时间
ExpireTime任务有效时间



异常示例

{"errcode":"500","errmsg":"内部错误"}