获取分布式交换机允许加载的集群

GET/zstack/v1/l2-networks/{l2NetworkUuid}/cluster-candidates

Request

cURL

curl --request GET \
  --url '/v1/l2-networks/{l2NetworkUuid}/cluster-candidates'

{
  "status": "ok",
  "method": "GET",
  "path": "/v1/l2-networks/{l2NetworkUuid}/cluster-candidates"
}

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/l2-networks/0b888b1f97993dbc9a22667219bcc690/cluster-candidates?limit=1000&start=0

参数列表

名字	类型	位置	描述	起始版本
l2NetworkUuid	String	url	分布式交换机UUID	4.0.0
clusterTypes (可选)	List	query	集群类型列表	4.0.0
limit (可选)	Integer	query	最多返回的记录数，类似MySQL的limit	4.0.0
start (可选)	Integer	query	起始查询记录位置，类似MySQL的offset。跟`limit`配合使用可以实现分页	4.0.0
systemTags (可选)	List	query	系统标签	4.0.0
userTags (可选)	List	query	用户标签	4.0.0

API返回

返回示例

{
  "inventories": [
    {
      "name": "cluster1",
      "uuid": "170abd61de68305cb2ccaa008a17c11e",
      "description": "test",
      "state": "Enabled",
      "hypervisorType": "KVM",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM",
      "zoneUuid": "8de4bc023e4c3be6bfa7c514eb3bb024",
      "type": "zstack"
    }
  ]
}

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

inventories

名字	类型	描述	起始版本
name	String	资源名称	0.6
uuid	String	资源的UUID，唯一标示该资源	0.6
description	String	资源的详细描述	0.6
state	String	集群状态	0.6
hypervisorType	String	虚拟机管理程序类型	0.6
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6
zoneUuid	String	数据中心UUID	0.6
type	String	保留域	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

SDK示例

Java SDK

GetCandidateClustersForAttachingL2NetworkAction action = new GetCandidateClustersForAttachingL2NetworkAction();
action.l2NetworkUuid = "0b888b1f97993dbc9a22667219bcc690";
action.limit = 1000;
action.start = 0;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetCandidateClustersForAttachingL2NetworkAction.Result res = action.call();

Python SDK

GetCandidateClustersForAttachingL2NetworkAction action = GetCandidateClustersForAttachingL2NetworkAction()
action.l2NetworkUuid = "0b888b1f97993dbc9a22667219bcc690"
action.limit = 1000
action.start = 0
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetCandidateClustersForAttachingL2NetworkAction.Result res = action.call()