文档中心知识库API Explorer
文档中心›ZCF›ZStack Cloud›探索更多›开发手册ZCF
文档目录

SR-IOV相关接口

L3网络中是否存在可用VF网卡(IsVfNicAvailableInL3Network)

API请求

URLs
GET zstack/v1/l3-networks/{l3NetworkUuid}/hosts/{hostUuid}/vfnicavailable
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/l3-networks/443e156ec6883356974f97f803187310/hosts/037404d26b033e9d9fe0d3e7e4bbaa8b/vfnicavailable
参数列表
名字 类型 位置 描述 可选值 起始版本
l3NetworkUuid String url 三层网络UUID 3.9.0
hostUuid String url 物理机UUID 3.9.0
systemTags (可选) List query 系统标签 3.9.0
userTags (可选) List query 用户标签 3.9.0

API返回

返回示例
{
  "vfNicAvailable": true
}
名字 类型 描述 起始版本
vfNicAvailable boolean 是否存在可用VF网卡 3.9.0
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 3.9.0
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 3.9.0
description String 错误的概要描述 3.9.0
details String 错误的详细信息 3.9.0
elaboration String 保留字段，默认为null 3.9.0
opaque LinkedHashMap 保留字段，默认为null 3.9.0
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 3.9.0

SDK示例

Java SDK
IsVfNicAvailableInL3NetworkAction action = new IsVfNicAvailableInL3NetworkAction();
action.l3NetworkUuid = "443e156ec6883356974f97f803187310";
action.hostUuid = "037404d26b033e9d9fe0d3e7e4bbaa8b";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
IsVfNicAvailableInL3NetworkAction.Result res = action.call();
Python SDK
IsVfNicAvailableInL3NetworkAction action = IsVfNicAvailableInL3NetworkAction()
action.l3NetworkUuid = "443e156ec6883356974f97f803187310"
action.hostUuid = "037404d26b033e9d9fe0d3e7e4bbaa8b"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
IsVfNicAvailableInL3NetworkAction.Result res = action.call()

修改云主机网卡类型(ChangeVmNicType)

API请求

URLs
PUT zstack/v1/vm-instances/nics/{vmNicUuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "changeVmNicType": {
    "vmNicType": "VNIC"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"changeVmNicType":{"vmNicType":"VNIC"}}' http://localhost:8080/zstack/v1/vm-instances/nics/ba83aa15bafd33e792267c428465b1e5/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
vmNicUuid String url 云主机网卡UUID 3.9.0
vmNicType String body(包含在changeVmNicType结构中) 云主机网卡类型
  • VNIC
 3.9.0
systemTags (可选) List body 系统标签 3.9.0
userTags (可选) List body 用户标签 3.9.0

API返回

返回示例
{
  "inventory": {
    "uuid": "bd44ea50e2573d5d9249c938dba0dad6",
    "vmInstanceUuid": "1311eba1f7e53c3aa816a140fd783068",
    "usedIpUuid": "464575b453d53e60941c7eeee08f3149",
    "l3NetworkUuid": "b62214c53fde3f6eb825bf2ce59e3d2e",
    "ip": "192.168.1.10",
    "mac": "00:0c:29:bd:99:fc",
    "hypervisorType": "KVM",
    "netmask": "255.255.255.0",
    "gateway": "192.168.1.1",
    "deviceId": 0.0,
    "type": "VF"
  }
}
名字 类型 描述 起始版本
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 3.9.0
inventory VmNicInventory 详情参考inventory 3.9.0
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 3.9.0
description String 错误的概要描述 3.9.0
details String 错误的详细信息 3.9.0
elaboration String 保留字段，默认为null 3.9.0
opaque LinkedHashMap 保留字段，默认为null 3.9.0
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 3.9.0
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 3.9.0
vmInstanceUuid String 云主机UUID 3.9.0
l3NetworkUuid String 三层网络UUID 3.9.0
ip String IP地址 3.9.0
mac String MAC地址 3.9.0
hypervisorType String 虚拟化类型 3.9.0
netmask String 子网掩码 3.9.0
gateway String 网关 3.9.0
metaData String 3.9.0
ipVersion Integer IP地址版本 3.9.0
deviceId Integer 设备ID 3.9.0
type String 网卡类型 3.9.0
createDate Timestamp 创建时间 3.9.0
lastOpDate Timestamp 最后一次修改时间 3.9.0
usedIps List 详情参考usedIps 3.9.0
#usedIps
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 3.9.0
ipRangeUuid String IP段UUID 3.9.0
l3NetworkUuid String 三层网络UUID 3.9.0
ipVersion Integer IP协议号 3.9.0
ip String IP地址 3.9.0
netmask String 网络掩码 3.9.0
gateway String 网关地址 3.9.0
usedFor String 3.9.0
ipInLong long 3.9.0
vmNicUuid String 云主机网卡UUID 3.9.0
createDate Timestamp 创建时间 3.9.0
lastOpDate Timestamp 最后一次修改时间 3.9.0

SDK示例

Java SDK
ChangeVmNicTypeAction action = new ChangeVmNicTypeAction();
action.vmNicUuid = "ba83aa15bafd33e792267c428465b1e5";
action.vmNicType = "VNIC";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeVmNicTypeAction.Result res = action.call();
Python SDK
ChangeVmNicTypeAction action = ChangeVmNicTypeAction()
action.vmNicUuid = "ba83aa15bafd33e792267c428465b1e5"
action.vmNicType = "VNIC"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ChangeVmNicTypeAction.Result res = action.call()

修改云主机VF网卡高可用状态(ChangeVfNicHaState)

API请求

URLs
PUT zstack/v1/vm-instances/nics/{vfNicUuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "changeVfNicHaState": {
    "haState": "Enabled"
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"changeVfNicHaState":{"haState":"Enabled"}}' http://localhost:8080/zstack/v1/vm-instances/nics/8536b111015d3fd289907c5f53c80153/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
vfNicUuid String url VF网卡UUID 5.1.0
haState String body(包含在changeVfNicHaState结构中) 高可用状态 5.1.0
systemTags (可选) List body 系统标签 5.1.0
userTags (可选) List body 用户标签 5.1.0

API返回

返回示例
{
  "inventory": {
    "pciDeviceUuid": "4935759d5e543ff7bb9901262d67e805",
    "haState": "Enabled",
    "uuid": "5a39466d15e9303d8cd091be8f8b98a0",
    "vmInstanceUuid": "0c9912e742793004bd585150a4e243d0",
    "usedIpUuid": "6c1404d271ce3da4a5a845563b65ab55",
    "l3NetworkUuid": "0d42b1c567da3721b04d1bc316b2e0cb",
    "ip": "192.168.1.2",
    "mac": "00:0c:29:bd:99:fc",
    "hypervisorType": "KVM",
    "netmask": "255.255.255.0",
    "gateway": "192.168.1.1",
    "deviceId": 0,
    "type": "VF",
    "state": "enable"
  }
}
名字 类型 描述 起始版本
success boolean 5.1.0
inventory VmVfNicInventory 详情参考inventory 5.1.0
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 5.1.0
#inventory
名字 类型 描述 起始版本
pciDeviceUuid String 网卡PCI地址 5.1.0
haState String 高可用状态 5.1.0
uuid String 资源的UUID，唯一标示该资源 5.1.0
vmInstanceUuid String 云主机UUID 5.1.0
l3NetworkUuid String 三层网络UUID 5.1.0
ip String 5.1.0
mac String 5.1.0
hypervisorType String 5.1.0
netmask String 5.1.0
gateway String 5.1.0
metaData String 5.1.0
ipVersion Integer 5.1.0
driverType String 5.1.0
internalName String 5.1.0
deviceId Integer 5.1.0
type String 5.1.0
state String 5.1.0
createDate Timestamp 创建时间 5.1.0
lastOpDate Timestamp 最后一次修改时间 5.1.0
usedIps List 详情参考 5.1.0
#usedIps
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 5.1.0
ipRangeUuid String IP段UUID 5.1.0
l3NetworkUuid String 三层网络UUID 5.1.0
ipVersion Integer 5.1.0
ip String 5.1.0
netmask String 5.1.0
gateway String 5.1.0
usedFor String 5.1.0
ipInLong long 5.1.0
vmNicUuid String 云主机网卡UUID 5.1.0
createDate Timestamp 创建时间 5.1.0
lastOpDate Timestamp 最后一次修改时间 5.1.0
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 5.1.0
description String 错误的概要描述 5.1.0
details String 错误的详细信息 5.1.0
elaboration String 保留字段，默认为null 5.1.0
opaque LinkedHashMap 保留字段，默认为null 5.1.0
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 5.1.0

SDK示例

Java SDK
ChangeVfNicHaStateAction action = new ChangeVfNicHaStateAction();
action.vfNicUuid = "8536b111015d3fd289907c5f53c80153";
action.haState = "Enabled";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ChangeVfNicHaStateAction.Result res = action.call();
Python SDK
ChangeVfNicHaStateAction action = ChangeVfNicHaStateAction()
action.vfNicUuid = "8536b111015d3fd289907c5f53c80153"
action.haState = "Enabled"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ChangeVfNicHaStateAction.Result res = action.call()

获取L2网络可用的SRIOV VF(GetVfPciDeviceAvailableInL2Network)

API请求

URLs
GET zstack/v1/l2-networks/vf-pci-devices-available
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/vf-pci-devices-available?l2NetworkUuids=7615ff44c9f03400b32b9138e1d332fc
参数列表
名字 类型 位置 描述 可选值 起始版本
l2NetworkUuids List query 2层网络Uuid 5.3.20
systemTags (可选) List query 系统标签 5.3.20
userTags (可选) List query 用户标签 5.3.20

API返回

返回示例
{
  "l2VfAvailableClusters": {
    "76a2d0892dbb3047adc9f27227a47a24": [
      {
        "clusterHostAvailableVfs": {
          "cc8a747f6148357182ccbc922baf3611": {
            "ef8963015cb337e6b6e9ded639e74985": 10
          }
        }
      }
    ]
  }
}
名字 类型 描述 起始版本
success boolean 5.3.20
l2VfAvailableClusters Map 5.3.20
error ErrorCode 错误码，若不为null，则表示操作失败，操作成功时该字段为null。 详情参考error 5.3.20
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 5.3.20
description String 错误的概要描述 5.3.20
details String 错误的详细信息 5.3.20
elaboration String 保留字段，默认为null 5.3.20
opaque LinkedHashMap 保留字段，默认为null 5.3.20
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 5.3.20

SDK示例

Java SDK
GetVfPciDeviceAvailableInL2NetworkAction action = new GetVfPciDeviceAvailableInL2NetworkAction();
action.l2NetworkUuids = asList("7615ff44c9f03400b32b9138e1d332fc");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetVfPciDeviceAvailableInL2NetworkAction.Result res = action.call();
Python SDK
GetVfPciDeviceAvailableInL2NetworkAction action = GetVfPciDeviceAvailableInL2NetworkAction()
action.l2NetworkUuids = [7615ff44c9f03400b32b9138e1d332fc]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetVfPciDeviceAvailableInL2NetworkAction.Result res = action.call()
上一篇USB透传相关接口下一篇龙芯SE模块相关接口
开发手册 | 5.4.12 | ZStack Cloud · ZCF | ZStack 资源中心