获取候选的主机Kernel适配器

GET/zstack/v1/hosts/kernel-interfaces

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/hosts/kernel-interfaces?hostUuids=ff0192fa70113da886101145c084bd00&cidr=192.168.1.0/24&trafficTypes=Management&containsRejected=true&limit=1000&start=0

参数列表

名字

类型

位置

描述

可选值

起始版本

hostUuids

List

query

主机UUID列表

 

4.10.20

cidr (可选)

String

query

无类别域间路由

 

4.10.20

trafficTypes (可选)

List

query

流量类型

  • Management
  • Storage

4.10.20

containsRejected (可选)

boolean

query

是否包含被拒绝的候选项

 

4.10.20

limit (可选)

Integer

query

最多返回的记录数,类似MySQL的limit,默认值1000

 

4.10.20

start (可选)

Integer

query

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

 

4.10.20

systemTags (可选)

List

query

系统标签

 

4.10.20

userTags (可选)

List

query

用户标签

 

4.10.20

API返回

返回示例

{
  "results": [
    {
      "candidate": {
        "uuid": "ff054502e59933a8a494cea5dc88d700",
        "name": "host-kernel-interface",
        "description": "example",
        "hostUuid": "ff0192fa70113da886101145c084bd00",
        "l2NetworkUuid": "ff0915ef0d3e32708d3150708a72c400",
        "l3NetworkUuid": "ff07d561c51c3ef996d682825dcff700",
        "usedIps": [
          {
            "hostKernelInterfaceUuid": "ff054502e59933a8a494cea5dc88d700",
            "uuid": "ff0d1627c13c3337a92767d011d03a00",
            "l3NetworkUuid": "ff07d561c51c3ef996d682825dcff700",
            "ipVersion": 4,
            "ip": "192.168.0.2",
            "netmask": "255.255.255.0",
            "ipInLong": 3232235522,
            "ipInBinary": [
              -64,
              -88,
              0,
              2
            ],
            "createDate": "Nov 14, 2017 2:20:57 PM",
            "lastOpDate": "Nov 14, 2017 2:20:57 PM"
          }
        ],
        "trafficTypes": [
          "Management"
        ],
        "createDate": "Nov 14, 2017 2:20:57 PM",
        "lastOpDate": "Nov 14, 2017 2:20:57 PM"
      },
      "finalDecision": "ACCEPTED",
      "decisions": []
    }
  ]
}
名字类型描述起始版本
resultsList候选的主机Kernel适配器的返回结果列表4.10.20
successboolean 4.10.20
errorErrorCode错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error4.10.20

error

名字类型描述起始版本
codeString错误码号,错误的全局唯一标识,例如SYS.1000, HOST.10010.6
descriptionString错误的概要描述0.6
detailsString错误的详细信息0.6
elaborationString保留字段,默认为null0.6
opaqueLinkedHashMap保留字段,默认为null0.6
causeErrorCode根错误,引发当前错误的源错误,若无原错误,该字段为null0.6

SDK示例

Java SDK

GetCandidateHostKernelInterfacesAction action = new GetCandidateHostKernelInterfacesAction();
action.hostUuids = asList("ff0192fa70113da886101145c084bd00");
action.cidr = "192.168.1.0/24";
action.trafficTypes = asList("Management");
action.containsRejected = true;
action.limit = 1000;
action.start = 0;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetCandidateHostKernelInterfacesAction.Result res = action.call();

Python SDK

action = GetCandidateHostKernelInterfacesAction()
action.hostUuids = [ff0192fa70113da886101145c084bd00]
action.cidr = "192.168.1.0/24"
action.trafficTypes = [Management]
action.containsRejected = true
action.limit = 1000
action.start = 0
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()