查询虚拟机模板(QueryTemplatedVmInstance)

API请求

URLs

GET zstack/v1/vm-instances/templatedVmInstance
GET zstack/v1/vm-instances/templatedVmInstance/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/vm-instances/templatedVmInstance?q=uuid=2ed42f5960c43ba287bb486badfdd727

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/vm-instances/templatedVmInstance/8152b4c564f537808ae6e46dd8d8c245

可查询字段

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

API返回

返回示例

{
  "inventories": [
    {
      "uuid": "e0746082b05030a1ac908cc43a424b84",
      "name": "templatedVmInstance",
      "zoneUuid": "ecf920e0ded43afe831b2c9fbde1c0d9",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}

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

#inventories

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.2.6
name	String	资源名称	4.2.6
zoneUuid	String	数据中心UUID	4.2.6
createDate	Timestamp	创建时间	4.2.6
lastOpDate	Timestamp	最后一次修改时间	4.2.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

SDK示例

Java SDK

QueryTemplatedVmInstanceAction action = new QueryTemplatedVmInstanceAction();
action.conditions = asList("uuid=5866861926f03755a9855f15f892a446");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryTemplatedVmInstanceAction.Result res = action.call();

Python SDK

QueryTemplatedVmInstanceAction action = QueryTemplatedVmInstanceAction()
action.conditions = ["uuid=49a7e94d15fb3e2092dd8ea3c8d7ecdf"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryTemplatedVmInstanceAction.Result res = action.call()

上一篇删除虚拟机模板(DeleteTemplatedVmInstance)下一篇更新虚拟机模板(UpdateTemplatedVmInstance)