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

物理网络相关接口

创建物理网络标签类型(CreateHostNetworkServiceType)

API请求

URLs
POST zstack/v1/hosts/service-types
Headers
Authorization: OAuth the-session-uuid
Body

{
  "params": {
    "serviceType": "ManagementNetwork",
    "system": true
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"serviceType":"ManagementNetwork","system":true}}' \
http://localhost:8080/zstack/v1/hosts/service-types
参数列表
名字 类型 位置 描述 可选值 起始版本
serviceType String body(包含在params结构中) 5.3.0
system (可选) boolean body(包含在params结构中) 5.3.0
resourceUuid (可选) String body(包含在params结构中) 资源UUID 5.3.0
tagUuids (可选) List body(包含在params结构中) 标签UUID列表 5.3.0
systemTags (可选) List body 系统标签 5.3.0
userTags (可选) List body 用户标签 5.3.0

API返回

返回示例
{
  "inventory": {}
}
名字 类型 描述 起始版本
success boolean 5.3.0
inventory HostNetworkLabelInventory 详情参考inventory 5.3.0
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 5.3.0
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 5.3.0
serviceType String 5.3.0
system Boolean 5.3.0
createDate Timestamp 创建时间 5.3.0
lastOpDate Timestamp 最后一次修改时间 5.3.0
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 5.3.0
description String 错误的概要描述 5.3.0
details String 错误的详细信息 5.3.0
elaboration String 保留字段，默认为null 5.3.0
opaque LinkedHashMap 保留字段，默认为null 5.3.0
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 5.3.0

SDK示例

Java SDK
CreateHostNetworkServiceTypeAction action = new CreateHostNetworkServiceTypeAction();
action.serviceType = "ManagementNetwork";
action.system = true;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CreateHostNetworkServiceTypeAction.Result res = action.call();
Python SDK
CreateHostNetworkServiceTypeAction action = CreateHostNetworkServiceTypeAction()
action.serviceType = "ManagementNetwork"
action.system = true
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CreateHostNetworkServiceTypeAction.Result res = action.call()

删除物理网络标签类型(DeleteHostNetworkServiceType)

API请求

URLs
DELETE zstack/v1/hosts/service-types/{uuid}
Headers
Authorization: OAuth the-session-uuid
Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/hosts/service-types/21ce80c3a7783e11b78a343a50470abf
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID，唯一标示该资源 5.3.0
deleteMode (可选) String body 删除模式(Permissive / Enforcing，Permissive) 5.3.0
systemTags (可选) List body 系统标签 5.3.0
userTags (可选) List body 用户标签 5.3.0

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：
{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

SDK示例

Java SDK
DeleteHostNetworkServiceTypeAction action = new DeleteHostNetworkServiceTypeAction();
action.uuid = "21ce80c3a7783e11b78a343a50470abf";
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
DeleteHostNetworkServiceTypeAction.Result res = action.call();
Python SDK
DeleteHostNetworkServiceTypeAction action = DeleteHostNetworkServiceTypeAction()
action.uuid = "21ce80c3a7783e11b78a343a50470abf"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
DeleteHostNetworkServiceTypeAction.Result res = action.call()

更新物理网络标签类型(UpdateHostNetworkServiceType)

API请求

URLs
PUT zstack/v1/hosts/service-types/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
  "updateHostNetworkServiceType": {
    "serviceType": "ManagementNetwork",
    "system": true
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateHostNetworkServiceType":{"serviceType":"ManagementNetwork","system":true}}' \
http://localhost:8080/zstack/v1/hosts/service-types/63513aaff0a13c6fa9f9661acf9cd64b/actions
参数列表
名字 类型 位置 描述 可选值 起始版本
uuid String url 资源的UUID，唯一标示该资源 5.3.0
serviceType String body(包含在updateHostNetworkServiceType结构中) 5.3.0
system (可选) boolean body(包含在updateHostNetworkServiceType结构中) 5.3.0
systemTags (可选) List body 系统标签 5.3.0
userTags (可选) List body 用户标签 5.3.0

API返回

返回示例
{
  "inventory": {}
}
名字 类型 描述 起始版本
success boolean 5.3.0
inventory HostNetworkLabelInventory 详情参考inventory 5.3.0
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 5.3.0
#inventory
名字 类型 描述 起始版本
uuid String 资源的UUID，唯一标示该资源 5.3.0
serviceType String 5.3.0
system Boolean 5.3.0
createDate Timestamp 创建时间 5.3.0
lastOpDate Timestamp 最后一次修改时间 5.3.0
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 5.3.0
description String 错误的概要描述 5.3.0
details String 错误的详细信息 5.3.0
elaboration String 保留字段，默认为null 5.3.0
opaque LinkedHashMap 保留字段，默认为null 5.3.0
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 5.3.0

SDK示例

Java SDK
UpdateHostNetworkServiceTypeAction action = new UpdateHostNetworkServiceTypeAction();
action.uuid = "63513aaff0a13c6fa9f9661acf9cd64b";
action.serviceType = "ManagementNetwork";
action.system = true;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateHostNetworkServiceTypeAction.Result res = action.call();
Python SDK
UpdateHostNetworkServiceTypeAction action = UpdateHostNetworkServiceTypeAction()
action.uuid = "63513aaff0a13c6fa9f9661acf9cd64b"
action.serviceType = "ManagementNetwork"
action.system = true
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateHostNetworkServiceTypeAction.Result res = action.call()

标记物理网口(非聚合口)网络类型(SetServiceTypeOnHostNetworkInterface)

API请求

URLs
POST zstack/v1/hosts/nics/service-types
Headers
Authorization: OAuth the-session-uuid
Body
{
  "params": {
    "interfaceUuids": [
      "2894f52c7d84366c85dd115b3bc193ca"
    ]
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"interfaceUuids":["2894f52c7d84366c85dd115b3bc193ca"]}}' \
http://localhost:8080/zstack/v1/hosts/nics/service-types
参数列表
名字 类型 位置 描述 可选值 起始版本
interfaceUuids List body(包含在params结构中) 物理网口Uuids 4.7.11
vlanIds (可选) List body(包含在params结构中) vlan接口Ids 4.7.11
serviceTypes (可选) List body(包含在params结构中) 网络服务类型
  • ManagementNetwork
  • TenantNetwork
  • StorageNetwork
  • BackupNetwork
  • MigrationNetwork
 4.7.11
systemTags (可选) List body 系统标签 4.7.11
userTags (可选) List body 用户标签 4.7.11

API返回

返回示例
{
  "inventory": [
    {
      "id": 0,
      "interfaceUuid": "8534263f624a3962b7603c99a3e44eb2",
      "vlanId": 10,
      "serviceType": "BackupNetwork"
    }
  ]
}
名字 类型 描述 起始版本
success boolean 4.7.11
inventory List 详情参考inventory 4.7.11
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 4.7.11
#inventory
名字 类型 描述 起始版本
interfaceUuid String 物理网口Uuid 4.7.11
vlanId Integer vlan子接口id 4.7.11
createDate Timestamp 创建时间 4.7.11
lastOpDate Timestamp 最后一次修改时间 4.7.11
serviceType HostNetworkInterfaceServiceType 详情参考serviceType 4.7.11
#serviceType
名字 类型 描述 起始版本
ManagementNetwork HostNetworkInterfaceServiceType 管理网络 4.7.11
TenantNetwork HostNetworkInterfaceServiceType 业务网络 4.7.11
StorageNetwork HostNetworkInterfaceServiceType 存储网络 4.7.11
BackupNetwork HostNetworkInterfaceServiceType 备份网络 4.7.11
MigrationNetwork HostNetworkInterfaceServiceType 迁移网络 4.7.11
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 4.7.11
description String 错误的概要描述 4.7.11
details String 错误的详细信息 4.7.11
elaboration String 保留字段，默认为null 4.7.11
opaque LinkedHashMap 保留字段，默认为null 4.7.11
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 4.7.11

SDK示例

Java SDK
SetServiceTypeOnHostNetworkInterfaceAction action = new SetServiceTypeOnHostNetworkInterfaceAction();
action.interfaceUuids = asList("2894f52c7d84366c85dd115b3bc193ca");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SetServiceTypeOnHostNetworkInterfaceAction.Result res = action.call();
Python SDK
SetServiceTypeOnHostNetworkInterfaceAction action = SetServiceTypeOnHostNetworkInterfaceAction()
action.interfaceUuids = [2894f52c7d84366c85dd115b3bc193ca]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
SetServiceTypeOnHostNetworkInterfaceAction.Result res = action.call()

标记聚合网口网络类型(SetServiceTypeOnHostNetworkBonding)

API请求

URLs
POST zstack/v1/hosts/bondings/service-types
Headers
Authorization: OAuth the-session-uuid
Body
{
  "params": {
    "bondingUuids": [
      "e96881d20cde3a9ab337cdf0ab4e8b08"
    ],
    "serviceTypes": [
      "TenantNetwork"
    ]
  },
  "systemTags": [],
  "userTags": []
}
Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"bondingUuids":["e96881d20cde3a9ab337cdf0ab4e8b08"],"serviceTypes":["TenantNetwork"]}}' \
http://localhost:8080/zstack/v1/hosts/bondings/service-types
参数列表
名字 类型 位置 描述 可选值 起始版本
bondingUuids List body(包含在params结构中) bond网口Uuids 4.7.11
vlanIds (可选) List body(包含在params结构中) vlan接口Ids 4.7.11
serviceTypes (可选) List body(包含在params结构中) 网络服务类型
  • ManagementNetwork
  • TenantNetwork
  • StorageNetwork
  • BackupNetwork
  • MigrationNetwork
 4.7.11
systemTags (可选) List body 系统标签 4.7.11
userTags (可选) List body 用户标签 4.7.11

API返回

返回示例
{
  "inventory": [
    {
      "id": 0,
      "bondingUuid": "d1fd53a607c936859414f6222175c820",
      "vlanId": 10,
      "serviceType": "BackupNetwork"
    }
  ]
}
名字 类型 描述 起始版本
success boolean 4.7.11
inventory List 详情参考inventory 4.7.11
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 4.7.11
#inventory
名字 类型 描述 起始版本
bondingUuid String bond网口Uuid 4.7.11
vlanId Integer vlan子接口id 4.7.11
createDate Timestamp 创建时间 4.7.11
lastOpDate Timestamp 最后一次修改时间 4.7.11
serviceType HostNetworkInterfaceServiceType 详情参考serviceType 4.7.11
#serviceType
名字 类型 描述 起始版本
ManagementNetwork HostNetworkInterfaceServiceType 管理网络 4.7.11
TenantNetwork HostNetworkInterfaceServiceType 业务网络 4.7.11
StorageNetwork HostNetworkInterfaceServiceType 存储网络 4.7.11
BackupNetwork HostNetworkInterfaceServiceType 备份网络 4.7.11
MigrationNetwork HostNetworkInterfaceServiceType 迁移网络 4.7.11
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 4.7.11
description String 错误的概要描述 4.7.11
details String 错误的详细信息 4.7.11
elaboration String 保留字段，默认为null 4.7.11
opaque LinkedHashMap 保留字段，默认为null 4.7.11
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 4.7.11

SDK示例

Java SDK
SetServiceTypeOnHostNetworkBondingAction action = new SetServiceTypeOnHostNetworkBondingAction();
action.bondingUuids = asList("e96881d20cde3a9ab337cdf0ab4e8b08");
action.serviceTypes = asList("TenantNetwork");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SetServiceTypeOnHostNetworkBondingAction.Result res = action.call();
Python SDK
SetServiceTypeOnHostNetworkBondingAction action = SetServiceTypeOnHostNetworkBondingAction()
action.bondingUuids = [e96881d20cde3a9ab337cdf0ab4e8b08]
action.serviceTypes = [TenantNetwork]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
SetServiceTypeOnHostNetworkBondingAction.Result res = action.call()

获取网口交集子接口信息(GetCandidateInterfaceVlanIds)

API请求

URLs
GET zstack/v1/host/network-interface-vlan-ids
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/host/network-interface-vlan-ids?interfaceUuids=d25e83af6ccf3d9ca8baa1702861a0c8&limit=1000&start=0
参数列表
名字 类型 位置 描述 可选值 起始版本
interfaceUuids List query 网口UUID 4.7.11
limit (可选) Integer query 4.7.11
start (可选) Integer query 4.7.11
systemTags (可选) List query 系统标签 4.7.11
userTags (可选) List query 用户标签 4.7.11

API返回

返回示例
{
    "vlanIds": [
        1010,
        1011,
        10,
        11,
        2000,
        1101,
        1110,
        1108,
        1107,
        1109,
        1106,
        1103,
        1102,
        1105,
        1104,
        0
    ],
    "success": true
}
名字 类型 描述 起始版本
vlanIds List vlan接口ID 4.7.11
success boolean 4.7.11
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 4.7.11
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 0.6
description String 错误的概要描述 4.7.11
details String 错误的详细信息 4.7.11
elaboration String 保留字段，默认为null 4.7.11
opaque LinkedHashMap 保留字段，默认为null 4.7.11
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 4.7.11

SDK示例

Java SDK
GetCandidateInterfaceVlanIdsAction action = new GetCandidateInterfaceVlanIdsAction();
action.interfaceUuids = asList("d25e83af6ccf3d9ca8baa1702861a0c8");
action.limit = 1000;
action.start = 0;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetCandidateInterfaceVlanIdsAction.Result res = action.call();
Python SDK
GetCandidateInterfaceVlanIdsAction action = GetCandidateInterfaceVlanIdsAction()
action.interfaceUuids = [d25e83af6ccf3d9ca8baa1702861a0c8]
action.limit = 1000
action.start = 0
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetCandidateInterfaceVlanIdsAction.Result res = action.call()

获取物理网口网络类型信息(GetInterfaceServiceTypeStatistic)

API请求

URLs
GET zstack/v1/hosts/hosts-network-interfaces/service-type-statistic
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/hosts-network-interfaces/service-type-statistic? \
interfaceUuid=d8797841479d3951bcb698164b56bd9e&interfaceType=All&sortBy=CreateDate&sortDirection=asc&start=0&limit=20&replyWithCount=false
参数列表
名字 类型 位置 描述 可选值 起始版本
interfaceUuid (可选) String query 物理机网卡UUID 4.7.11
vlanId (可选) Integer query vlan接口ID 4.7.11
interfaceType (可选) String query 网卡类型
  • All
  • Interface
  • Bonding
 4.7.11
serviceType (可选) List query 统计网络类型
  • All
  • ManagementNetwork
  • TenantNetwork
  • StorageNetwork
  • MigrationNetwork
  • BackupNetwork
 4.7.11
zoneUuid (可选) String query 区域UUID 4.7.11
clusterUuid (可选) String query 集群UUID 4.7.11
hostUuid (可选) String query 物理机UUID 4.7.11
sortBy (可选) String query 排序方式
  • InterfaceName
  • VlanId
  • HostIp
  • HostName
  • ClusterName
  • CreateDate
 4.7.11
sortDirection (可选) String query 排序方向
  • asc
  • desc
 4.7.11
start (可选) Integer query 统计结果起始位置 4.7.11
limit (可选) Integer query 统计结果数量 4.7.11
replyWithCount (可选) boolean query 同时返回统计结果总数 4.7.11
systemTags (可选) List query 系统标签 4.7.11
userTags (可选) List query 用户标签 4.7.11

API返回

返回示例
{
  "serviceTypeStatistics": [
    {
      "interfaceUuid": "474f9d7d7a1d3b46b8f17363dca7ebef",
      "serviceTypes": [
        "ManagementNetwork"
      ]
    }
  ],
  "total": 1
}}
名字 类型 描述 起始版本
total Long 统计结果总数 4.7.11
success boolean 成功 4.7.11
serviceTypeStatistics List 详情参考serviceTypeStatistics 4.7.11
error ErrorCode 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error 4.7.11
#serviceTypeStatistics
名字 类型 描述 起始版本
interfaceUuid String 网卡UUID 4.7.11
interfaceName String 网卡名 4.7.11
vlanId Integer vlan接口ID 4.7.11
serviceTypes List 网络类型集 4.7.11
hostUuid String 物理机UUID 4.7.11
hostName String 物理机名称 4.7.11
hostIp String 物理机IP 4.7.11
clusterUuid String 集群UUID 4.7.11
clusterName String 集群名称 4.7.11
zoneUuid String 区域UUID 4.7.11
createDate Timestamp 创建时间 4.7.11
#error
名字 类型 描述 起始版本
code String 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 4.7.11
description String 错误的概要描述 4.7.11
details String 错误的详细信息 4.7.11
elaboration String 保留字段，默认为null 4.7.11
opaque LinkedHashMap 保留字段，默认为null 4.7.11
cause ErrorCode 根错误，引发当前错误的源错误，若无原错误，该字段为null 4.7.11

SDK示例

Java SDK
GetInterfaceServiceTypeStatisticAction action = new GetInterfaceServiceTypeStatisticAction();
action.interfaceUuid = "d8797841479d3951bcb698164b56bd9e";
action.interfaceType = "All";
action.sortBy = "CreateDate";
action.sortDirection = "asc";
action.start = 0;
action.limit = 20;
action.replyWithCount = false;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetInterfaceServiceTypeStatisticAction.Result res = action.call();
Python SDK
GetInterfaceServiceTypeStatisticAction action = GetInterfaceServiceTypeStatisticAction()
action.interfaceUuid = "d8797841479d3951bcb698164b56bd9e"
action.interfaceType = "All"
action.sortBy = "CreateDate"
action.sortDirection = "asc"
action.start = 0
action.limit = 20
action.replyWithCount = false
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetInterfaceServiceTypeStatisticAction.Result res = action.call()
上一篇SAN存储相关接口下一篇SDN设备相关接口
开发手册 | 5.4.12 | ZStack Cloud · ZCF | ZStack 资源中心