获取物理网口网络类型信息

GET/zstack/v1/hosts/hosts-network-interfaces/service-type-statistic

Request

cURL

curl --request GET \
  --url '/v1/hosts/hosts-network-interfaces/service-type-statistic'

{
  "status": "ok",
  "method": "GET",
  "path": "/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()