批量获取云主机能力(GetVmsCapabilities)

API请求

URLs

POST zstack/v1/vm-instances/capabilities

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "vmUuids": [
      "86db798b3a0530b187380da6c9c58190"
    ]
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"vmUuids":["86db798b3a0530b187380da6c9c58190"]}}' http://localhost:8080/zstack/v1/vm-instances/capabilities

参数列表

名字	类型	位置	描述	起始版本
vmUuids	String	body(包含在params结构中)	待查询的云主机uuid集合	4.0.0
systemTags (可选)	List	body	系统标签	4.0.0
userTags (可选)	List	body	用户标签	4.0.0

API返回

返回示例

{
  "vmsCaps": {
    "68e8ed0735333faab95816b3e8596cea": {
      "supportLiveMigration": true,
      "supportVolumeMigration": true,
      "supportReimage": true,
      "supportMemorySnapshot": false
    }
  }
}

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

#error

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

#vmsCaps

名字	类型	起始版本
supportLiveMigration	boolean	4.0.0
supportVolumeMigration	boolean	4.0.0
supportReimage	boolean	4.0.0
supportMemorySnapshot	boolean	4.0.0

SDK示例

Java SDK

GetVmsCapabilitiesAction action = new GetVmsCapabilitiesAction();
action.vmUuids = asList("86db798b3a0530b187380da6c9c58190");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetVmsCapabilitiesAction.Result res = action.call();

Python SDK

GetVmsCapabilitiesAction action = GetVmsCapabilitiesAction()
action.vmUuids = [86db798b3a0530b187380da6c9c58190]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetVmsCapabilitiesAction.Result res = action.call()