跳转到主要内容
API Explorer|API Explorer
网络管理/网络资源/分布式交换机相关接口
GETDistributed Switch Related Interfaces起始版本 4.0.0同步需要认证

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

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

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

路径参数

查询参数

请求参数

路径参数

  • l2NetworkUuidString必填

    分布式交换机UUID

查询参数

  • clusterTypesList

    集群类型列表

  • limitInteger

    最多返回的记录数，类似MySQL的limit

  • startInteger

    起始查询记录位置，类似MySQL的offset。跟limit配合使用可以实现分页

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    操作是否成功。

  • inventoriesList必填

    详情参考inventories

    • nameString必填

      资源名称

    • uuidString必填

      资源的UUID，唯一标示该资源

    • descriptionString必填

      资源的详细描述

    • stateString必填

      集群状态

    • hypervisorTypeString必填

      虚拟机管理程序类型

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • zoneUuidString必填

      数据中心UUID

    • typeString必填

      保留域

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

请求地址

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

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

操作 ID

GetCandidateClustersForAttachingL2Network

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/l2-networks/{l2NetworkUuid}/cluster-candidates?clusterTypes=<clusterTypes>&limit=1&start=1&systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "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" } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史