安全设置相关接口

请求控制台访问地址(RequestConsoleAccess)

API请求

URLs

POST zstack/v1/consoles

Headers

Authorization: OAuth the-session-uuid

Body

{   "params": {     "vmInstanceUuid": "b95acae48c804003ac3820751b58a50d"   },   "systemTags": [],   "userTags": [] }

说明: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"vmInstanceUuid":"e0442db541833083bd7e411a4d94d969"}}' \ http://localhost:8080/zstack/v1/consoles

参数列表

名字	类型	位置	描述	起始版本
vmInstanceUuid	String	body(包含在params结构中)	虚拟机UUID	0.6
systemTags (可选)	List	body	系统标签	0.6
userTags (可选)	List	body	用户标签	0.6

API返回

返回示例

{   "inventory": {     "scheme": "http",     "hostname": "127.0.0.1",     "port": 4900.0,     "token": "d96caf24fae54c76b7652f548a258261"   } }

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	0.6
inventory	ConsoleInventory	详情参考inventory	0.6

#error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.6

#inventory

名字	类型	描述	起始版本
scheme	String	访问协议类型	0.6
hostname	String	宿主机名称	0.6
port	int	端口	0.6
token	String	口令	0.6

SDK示例

Java SDK

RequestConsoleAccessAction action = new RequestConsoleAccessAction(); action.vmInstanceUuid = "c8925478e1f840caa1f3919affa19155"; action.sessionId = "f896abb919754292aa8d2f286596142c"; RequestConsoleAccessAction.Result res = action.call();

Python SDK

RequestConsoleAccessAction action = RequestConsoleAccessAction() action.vmInstanceUuid = "f37c825f87444941bf16261f63c7dbb7" action.sessionId = "331a21749df940e4b447e9103518890d" RequestConsoleAccessAction.Result res = action.call()

查询控制台代理(QueryConsoleProxyAgent)

API请求

URLs

GET zstack/v1/consoles/agents GET zstack/v1/consoles/agents/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth 350b72c2d3f24641a767acbcec744b19" \ -X GET http://localhost:8080/zstack/v1/consoles/agents?q=uuid=745b7c17cd224025b3adfef4ae61b3d2

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth bb08e240616b482984c397e4517a021c" \ -X GET http://localhost:8080/zstack/v1/consoles/agents/8a3cc2be7e20420db29925e381c598bc

可查询字段

运行CLI命令行工具，输入QueryConsoleProxyAgent并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例

{   "inventories": [     {       "uuid": "c77bbc7d3364449e9543d0776a6087de",       "managementIp": "127.0.0.1",       "type": "ManagementServerConsoleProxy",       "state": "Connected"     }   ] }

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	0.6
inventories	List	详情参考inventories	0.6

#error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.6

#inventories

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	0.6
description	String	资源的详细描述	0.6
managementIp	String	管理节点IP	0.6
type	String	类型	0.6
status	String	状态（连接，断开）	0.6
state	String	状态（启用，禁用）	0.6
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6

SDK示例

Java SDK

QueryConsoleProxyAgentAction action = new QueryConsoleProxyAgentAction(); action.conditions = asList("uuid=dfbe49d87cb94d93b69354fa1270012b"); action.sessionId = "e2300cd4f74a457e87f13842aeb8fdef"; QueryConsoleProxyAgentAction.Result res = action.call();

Python SDK

QueryConsoleProxyAgentAction action = QueryConsoleProxyAgentAction() action.conditions = ["uuid=1e47046946f849ee871de20a2b045750"] action.sessionId = "1655d7f2e56d4710824cd1082bd5cc94" QueryConsoleProxyAgentAction.Result res = action.call()

升级提醒

若您选择升级至4.0.0及之后版本，请注意以下功能调整：

1. 云路由器全面升级为VPC路由器，云路由网络全面升级为VPC网络，不再单独设云路由器页面。升级全程无感知，相关业务不受任何影响。

2. 企业管理账号体系取代用户组与用户，不再单独设用户/用户组页面，不可再使用用户/用户组账号登录云平台。升级前，请先将“用户组与用户”纳管的账号数据妥善迁移至“企业管理”纳管，再执行升级操作。注意：对于admin创建并具备admin权限的用户账号同步取消，如有需要，可使用企业管理账号体系中的平台管理员实现相同功能。

3. 调整AD/LDAP与账户的对接管理方式，统一由企业管理纳管，不再单独设AD/LDAP页面。升级前，请先将“账户”对接纳管的AD/LDAP账号数据妥善迁移至“企业管理”纳管，再执行升级操作。

如对上述升级提醒有任何疑问或需要升级帮助，请联系ZStack官方技术支持

下载提醒

1.灵活的备份计划设置：轻松设定备份计划，自定义备份策略和保留策略，增量备份和全量备份可以设置不同的保留策略，在保证数据安全的同时最大限度地优化存储空间。

2.第三方认证服务器支持添加AD和LDAP，支持同步AD/LDAP用户成为虚拟化平台子账户，并使用指定的登录属性直接登录虚拟化平台。

3.分布式交换机不同主机上的上行链路网卡可以同时支持单网卡和聚合网卡，可以灵活配置网络，满足服务器虚拟化用户的网络配置需求。

如对上述升级提醒有任何疑问或需要下载帮助，请联系ZStack官方技术支持

控制台代理相关接口

请求控制台访问地址(RequestConsoleAccess)

API请求

API返回

SDK示例

查询控制台代理(QueryConsoleProxyAgent)

API请求

API返回

SDK示例

客户评论

撰写评论

产品

解决方案

支持

联系