虚拟机相关接口

获取虚拟机控制台密码

GET/zstack/v1/vm-instances/{uuid}/console-passwords

获取一个虚拟机的控制台密码。

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth 64bdb6ac8c3044d589ab6a0e96745fc2" \
-X GET http://localhost:8080/zstack/v1/vm-instances/3bc9f63f0de6492991c59bef96b27565/console-passwords

参数列表

名字类型位置描述可选值起始版本
uuidStringurl虚拟机UUID 0.6
systemTags (可选)Listquery系统标签 0.6
userTags (可选)Listquery用户标签 0.6

API返回

返回示例

{
  "consolePassword": "password"
}
名字类型描述起始版本
successboolean 0.6
passwordString控制台密码0.6
errorErrorCode错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error0.6

error

名字类型描述起始版本
codeString错误码号,错误的全局唯一标识,例如SYS.1000, HOST.10010.6
descriptionString错误的概要描述0.6
detailsString错误的详细信息0.6
elaborationString保留字段,默认为null0.6
opaqueLinkedHashMap保留字段,默认为null0.6
causeErrorCode根错误,引发当前错误的源错误,若无原错误,该字段为null0.6

SDK示例

Java SDK

GetVmConsolePasswordAction action = new GetVmConsolePasswordAction();
action.uuid = "b06703c5616e4c29ba4d080ea6b3d760";
action.sessionId = "4cf31da078ce44348e0d77af4269c756";
GetVmConsolePasswordAction.Result res = action.call();

Python SDK

GetVmConsolePasswordAction action = GetVmConsolePasswordAction()
action.uuid = "73b0881a95c0456ca9d20f2896ea6b76"
action.sessionId = "d568904f39914ffbaf6245aa3c949b37"
GetVmConsolePasswordAction.Result res = action.call()