控制台服务

概览

控制台代理（Console Proxy）：可通过代理地址登录云主机控制台。界面上显示了当前控制台代理的信息，即打开云主机的控制台时使用的代理信息。

清单

属性

名字	描述	可选的	可选的参数值	起始支持版本
uuid	请参见资源结构			0.6
description	资源的详细描述	是		0.6
state	请参见资源结构		Enabled Disabled	0.6
status	状态（连接，断开）			0.6
type	类型			0.6
managementIp	管理节点IP			0.6
consoleProxyOverriddenIp				0.6
createDate	请参见资源结构			0.6
lastOpDate	请参见资源结构			0.6

示例

{
    "inventories": [
        {
            "consoleProxyOverriddenIp": "",
            "createDate": "Mar 10, 2018 3:40:42 PM",
            "description": "Console proxy agent running on the management node[uuid:c6696896a2a34f1782781e42f85d89a4]",
            "lastOpDate": "Mar 10, 2018 3:40:56 PM",
            "managementIp": "10.0.210.4",
            "state": "Enabled",
            "status": "Connected",
            "type": "ManagementServerConsoleProxy",
            "uuid": "c6696896a2a34f1782781e42f85d89a4"
        }
    ],
    "success": true
}

操作（Operations）

请求控制台访问地址（RequestConsoleAccess）

管理员可以使用RequestConsoleAccess请求控制台访问地址。例如：

RequestConsoleAccess vmInstanceUuid=43ff23ed457544e285597ad8d8edad68

参数（Parameters）

名字	描述	可选的	起始支持版本
vmInstanceUuid	云主机uuid		0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	0.6
timeout		是

查询控制台代理（QueryConsoleProxyAgent）

管理员可以使用QueryConsoleProxyAgent查询控制台代理。例如：

QueryConsoleProxyAgent consoleProxyOverriddenIp=172.20.16.176

原生域查询（Primitive Fields of Query）

请参见console proxy agent inventory

重连控制台代理（ReconnectConsoleProxyAgent）

管理员可以使用ReconnectConsoleProxyAgent重连控制台代理。例如：

ReconnectConsoleProxyAgent agentUuids=f3537a0d957e49fc971acd4198ca1729

参数（Parameters）

名字	描述	可选的	起始支持版本
agentUuids	控制台代理Agent的uuid	是	0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	0.6
timeout		是

更新控制台代理（UpdateConsoleProxyAgent）

管理员可以使用UpdateConsoleProxyAgent更新控制台代理。例如：

UpdateConsoleProxyAgent uuid=dccc2549a6b7402cbf5de9551b6c06e9 consoleProxyOverriddenIp=172.20.16.255

参数（Parameters）

名字	描述	可选的	起始支持版本
consoleProxyOverriddenIp	控制台代理IP		0.6
uuid			0.6
userTags	用户标签，请参见创建用户标签(CreateUserTag)	是	0.6
systemTags	系统标签，请参见创建系统标签(CreateSystemTag)	是	0.6
timeout		是

标签（Tags）

用户可以使用CreateUserTag resourceType=ConsoleProxyAgentVO在用户上创建用户标签。例如：

CreateUserTag resourceType=ConsoleProxyAgentVO tag=Test1 \
resourceUuid=3214e0dcd01d4e2aa8407968e1ccreatee51d58