获取云主机可加载L3网络列表(GetVmAttachableL3Network)

获取一个云主机可加载三层网络列表。

API请求

URLs
GET zstack/v1/vm-instances/{vmInstanceUuid}/l3-networks-candidates
Headers
Authorization: OAuth the-session-uuid
Curl示例
curl -H "Content-Type: application/json" \
-H "Authorization: OAuth: 26f05abbc21441dc921a573eda1fed6b" \
-X GET http://localhost:8080/zstack/v1/vm-instances/16bf0d8cb1e346568e4cfba52c70a9c2/l3-networks-candidates
参数列表
名字 类型 位置 描述 可选值 起始版本
vmInstanceUuid String url 云主机UUID 0.6
systemTags (可选) List query 系统标签 0.6
userTags (可选) List query 用户标签 0.6

API返回

返回示例
{
  "inventories": [
    {
      "uuid": "d2f77ca69b1448d3b8e063c3d551cf1b",
      "name": "private L3",
      "type": "L3BasicNetwork",
      "zoneUuid": "67a6601dc8dd476ebca371123ff03f14",
      "l2NetworkUuid": "94bdffb080b346e7a3ac2f44f574cc4a",
      "state": "Enabled",
      "createDate": "Apr 24, 2017 7:11:08 PM",
      "lastOpDate": "Apr 24, 2017 7:11:08 PM",
      "ipRanges": [
        {
          "uuid": "e15972969ac64d1ea01c0c228d969bcc",
          "l3NetworkUuid": "d2f77ca69b1448d3b8e063c3d551cf1b",
          "name": "ip range",
          "startIp": "192.168.0.10",
          "endIp": "192.168.0.100",
          "netmask": "255.255.255.0",
          "gateway": "192.168.0.1",
          "createDate": "Apr 24, 2017 7:11:08 PM",
          "lastOpDate": "Apr 24, 2017 7:11:08 PM"
        }
      ],
      "networkServices": [
        {
          "l3NetworkUuid": "d2f77ca69b1448d3b8e063c3d551cf1b",
          "networkServiceProviderUuid": "a493b6286d6e43f89e06062b7a4ad182",
          "networkServiceType": "DHCP"
        },
        {
          "l3NetworkUuid": "d2f77ca69b1448d3b8e063c3d551cf1b",
          "networkServiceProviderUuid": "a493b6286d6e43f89e06062b7a4ad182",
          "networkServiceType": "DNS"
        },
        {
          "l3NetworkUuid": "d2f77ca69b1448d3b8e063c3d551cf1b",
          "networkServiceProviderUuid": "a493b6286d6e43f89e06062b7a4ad182",
          "networkServiceType": "SNAT"
        }
      ]
    }
  ]
}
名字 类型 描述 起始版本
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 0.6
inventories List 详情参考inventories 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
#inventories
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 0.6
name String 资源名称 0.6
description String 资源的详细描述 0.6
type String 0.6
zoneUuid String 区域UUID 0.6
l2NetworkUuid String 二层网络UUID 0.6
state String 0.6
dnsDomain String 0.6
system Boolean 0.6
category String 0.6
ipVersion Integer IP协议号 3.1.0
createDate Timestamp 创建时间 0.6
lastOpDate Timestamp 最后一次修改时间 0.6
dns List 0.6
ipRanges List 详情参考ipRanges 0.6
networkServices List 详情参考networkServices 0.6
hostRoute List 详情参考hostRoute 0.6
#ipRanges
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 0.6
l3NetworkUuid String 三层网络UUID 0.6
name String 资源名称 0.6
description String 资源的详细描述 0.6
startIp String 0.6
endIp String 0.6
netmask String 0.6
prefixLen String 掩码长度 3.1.0
gateway String 0.6
networkCidr String 0.6
ipVersion Integer IP协议号 3.1.0
addressMode String IPv6地址分配模式 3.1.0
createDate Timestamp 创建时间 0.6
lastOpDate Timestamp 最后一次修改时间 0.6
#networkServices
名字 类型 描述 起始版本
l3NetworkUuid String 三层网络UUID 0.6
networkServiceProviderUuid String 网络服务提供模块UUID 0.6
networkServiceType String 0.6
#hostRoute
名字 类型 描述 起始版本
id Long 2.3
l3NetworkUuid String 三层网络UUID 2.3
prefix String 2.3
nexthop String 2.3
createDate Timestamp 创建时间 2.3
lastOpDate Timestamp 最后一次修改时间 2.3

SDK示例

Java SDK
GetVmAttachableL3NetworkAction action = new GetVmAttachableL3NetworkAction();
action.vmInstanceUuid = "eb2f2966162a47768578a0fb4016d75f";
action.sessionId = "9fe9dda1b076485baa9f3d49dacb0b3d";
GetVmAttachableL3NetworkAction.Result res = action.call();
Python SDK
GetVmAttachableL3NetworkAction action = GetVmAttachableL3NetworkAction()
action.vmInstanceUuid = "2c39b050a8984491922aeadbbdd8ed48"
action.sessionId = "006575fef83c43c68f7bfb9c05f6b05c"
GetVmAttachableL3NetworkAction.Result res = action.call()