平台资源统计

2.5.1查询系统健康度

接口地址

GET  /NSphere/api/dc-resource/health

接口描述

查询系统健康度，参数使用顺序hpId，clusterId，hostId。

请求数据类型

application/x-www-form-urlencoded

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
hpId	数据中心ID。	query	false	integer(int64)
clusterId	集群ID。	query	false	integer(int64)
hostId	主机ID。	query	false	integer(int64)

响应状态

状态码	说明	schema
200	OK	ApiResponseApiHealthInfoVO

响应参数

参数名称	参数说明	类型	schema
state	状态码 0: 成功, 1: 失败, 2: 部分成功	integer(int32)	integer(int32)
errorCode	错误码 当不为0表示业务发生错误	integer(int32)	integer(int32)
successMessage	成功消息	string
failureMessage	错误消息，失败或者部分成功时有效.	string
data	响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据	ApiHealthInfoVO	ApiHealthInfoVO
cvmHealth	系统健康度	integer(int32)
cvkhealthInfoList	主机系统健康度信息实体。	array	ApiCvkHealthInfoVO
id	主机ID。	integer(int64)
name	主机名称。	string
status	主机状态 0：为不正常，1：为正常。	integer(int32)
cpuRate	CPU利用率。（单位：%）	number(double)
memRate	内存利用率。（单位：%）	number(double)
storageRate	存储利用率。（单位：%）	number(double)
netIo	网络吞吐量。（最大IO网卡的吞吐量，单位：Mbps）	number(double)
cpuHealth	主机CPU健康度。	integer(int32)
memHealth	主机内存健康度。	integer(int32)
storageHealth	主机存储健康度。	integer(int32)
netHealth	主机网络健康度。	integer(int32)
cvkHealth	主机健康度。	integer(int32)
bandwidthStat	主机所有虚拟交换机的带宽和。（单位：Mbps）	number(double)

响应示例

{

"state": 0,

"errorCode": 0,

"successMessage": null,

"failureMessage": null,

"data": {

"cvmHealth": null,

"cvkhealthInfoList": [

{

"id": null,

"name": null,

"status": null,

"cpuRate": null,

"memRate": null,

"storageRate": null,

"netIo": null,

"cpuHealth": null,

"memHealth": null,

"storageHealth": null,

"netHealth": null,

"cvkHealth": null,

"bandwidthStat": null

}

]

}

}

2.5.2查询网络存储统资源统计

接口地址

GET  /NSphere/api/dc-resource/statistics/block-storage-resource

接口描述

查询网络存储统资源统计。

请求数据类型

application/x-www-form-urlencoded

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
offset	偏移量。指定从第几条记录开始返回。	query	false	integer(int32)
limit	每页返回的最大记录数。	query	false	integer(int32)
sortDir	排序类型，0：不排序，1：升序，2：降序，sortField不为空时生效。	query	false	integer(int32)
sortField	只支持字段：title，storageType，hostName。	query	false	string
hostPoolId	数据中心ID。	query	false	integer(int64)
clusterId	集群ID。	query	false	integer(int64)
hostId	主机ID。	query	false	integer(int64)

响应状态

状态码	说明	schema
200	OK	ApiResponseApiPagingListResultApiBlockStorageResourceVO

响应参数

参数名称	参数说明	类型	schema
state	状态码 0: 成功, 1: 失败, 2: 部分成功	integer(int32)	integer(int32)
errorCode	错误码 当不为0表示业务发生错误	integer(int32)	integer(int32)
successMessage	成功消息	string
failureMessage	错误消息，失败或者部分成功时有效.	string
data	响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据	ApiPagingListResultApiBlockStorageResourceVO	ApiPagingListResultApiBlockStorageResourceVO
data	网络存储资源统计信息实体。	array	ApiBlockStorageResourceVO
hostName	主机名称。	string
usedCapacity	已分配容量。（单位：MB）	string
actualAvailCapacity	实际可用容量。（单位：MB）	string
hostId	主机ID。	string
storageType	存储类型。iscsi：iSCSI网络存储，fc：FC网络存储，nvme-of：NVMe-oF网络存储。	string
title	显示名称。	string
user	使用者。	string
capacity	总容量。（单位：MB）	string
status	状态。0：活动，1：不活动，2：异常。	string
offset	偏移量。指定从第几条记录开始返回。	integer(int32)
size	当前返回的记录数。	integer(int32)
total	数据总量	integer(int64)

响应示例

{

"state": 0,

"errorCode": 0,

"successMessage": null,

"failureMessage": null,

"data": {

"data": [

{

"hostName": "node62186",

"usedCapacity": 5120,

"actualAvailCapacity": 0,

"hostId": 1,

"storageType": "iscsi",

"title": "dd",

"user": "test_block_vm",

"capacity": 5120,

"status": 0

}

],

"offset": null,

"size": null,

"total": null

}

}

2.5.3查询集群资源统计

接口地址

GET  /NSphere/api/dc-resource/statistics/cluster-resource

接口描述

查询集群资源统计。E0930版本接口新增返回属性。

请求数据类型

application/x-www-form-urlencoded

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
offset	偏移量。指定从第几条记录开始返回。	query	false	integer(int32)
limit	每页返回的最大记录数。	query	false	integer(int32)
sortDir	排序类型，0：不排序，1：升序，2：降序，sortField不为空时生效。	query	false	integer(int32)
sortField	排序字段。支持字段：name。	query	false	string
clusterName	集群名称，支持模糊查询。	query	false	string
clusterId	集群ID。	query	false	integer(int64)
hostPoolId	数据中心ID。	query	false	integer(int64)

响应状态

状态码	说明	schema
200	OK	ApiResponseApiPagingListResultApiClusterResourceVO

响应参数

参数名称	参数说明	类型	schema
state	状态码 0: 成功, 1: 失败, 2: 部分成功	integer(int32)	integer(int32)
errorCode	错误码 当不为0表示业务发生错误	integer(int32)	integer(int32)
successMessage	成功消息	string
failureMessage	错误消息，失败或者部分成功时有效.	string
data	响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据	ApiPagingListResultApiClusterResourceVO	ApiPagingListResultApiClusterResourceVO
data	集群资源统计信息实体。	array	ApiClusterResourceVO
name	集群名称。	string
id	集群ID。	integer(int64)
hostNum	主机数量。	integer(int32)
vmTotal	虚拟机总数量。 E0930版本新增属性。	integer(int32)
runningNum	运行状态虚拟机数量。	integer(int32)
shutoffNum	关机状态虚拟机数量。	integer(int32)
otherNum	其他状态虚拟机数量。	integer(int32)
summary	虚拟机数量概览。（运行数量/关机数量/其他数量）	string
vmDensity	虚拟机密度。	number(double)
cpuNum	CPU总核数。	integer(int32)
memory	总内存。（单位：MB）	integer(int64)
diskProgress	本地存储已用百分比。（单位：%）(请手动执行连接主机更新数据)	number(double)
availableStorage	本地存储可用容量（带单位）。 E0930版本新增属性。	string
cpuRate	CPU分配比。（带单位）	string
cpuAllocRatio	CPU分配比。（不带单位）	string
memRate	内存分配比。（带单位）	string
memAllocRatio	内存分配比。（不带单位）	string
shareFileStorage	共享存储实际使用和总容量。（带单位）	string
lunNum	共享LUN数量。	integer(int32)
haStatus	HA状态。 启用/未启用。	string
lbStatus	计算资源DRS状态。 启用/未启用。	string
slbStatus	存储资源DRS状态。 启用/未启用。	string
cpuProgress	CPU利用率。（单位：%）	number(double)
memProgress	内存利用率。（单位：%）	number(double)
monthAvgMem	最近一个月内内存平均利用率。（单位：%）	number(double)
monthAvgCpu	最近一个月内CPU平均利用率。（单位：%）	number(double)
storage	总存储，带单位格式，单位范围：MB、GB、TB。 E0930版本新增属性。	string
storageRate	存储使用率。（带单位） E0930版本新增属性。	string
storageAllocRatio	存储使用率。（不带单位） E0930版本新增属性。	number(double)
allocatedCpu	已分配CPU核心数量。 E0930版本新增属性。	integer(int32)
allocatedMem	已分配内存，带单位格式，单位范围：MB、GB、TB。 E0930版本新增属性。	string
sensitivity	HA敏感度级别， 0：低级，1：中级，2：高级，3:自定义。	integer(int32)
enableHA	是否启用HA（高可靠性） 0:不启用HA 1:启用HA。 E0930版本新增属性。	integer(int32)
enableLB	是否开启计算资源DRS（动态资源调度）， 0:不开启 1:开启。 E0930版本新增属性。	integer(int32)
enableIPM	是否启用电源智能管理 0:不启用电源智能管理 1:启用电源智能管理。 E0930版本新增属性。	integer(int32)
enableSLB	是否开启存储资源DRS 0:不开启 1:开启。 E0930版本新增属性。	integer(int32)
description	集群描述。 E0930版本新增属性。	string
offset	偏移量。指定从第几条记录开始返回。	integer(int32)
size	当前返回的记录数。	integer(int32)
total	数据总量	integer(int64)

响应示例

{

"state": 0,

"errorCode": 0,

"successMessage": null,

"failureMessage": null,

"data": {

"data": [

{

"name": "cluster",

"id": 34,

"hostNum": 1,

"vmTotal": 15,

"runningNum": 10,

"shutoffNum": 5,

"otherNum": 0,

"summary": "10/5/0",

"vmDensity": 15,

"cpuNum": 16,

"memory": 64044,

"diskProgress": 5,

"availableStorage": "5.00GB",

"cpuRate": "93.75%",

"cpuAllocRatio": 93.75,

"memRate": "23.18%",

"memAllocRatio": 23.18,

"shareFileStorage": "26.72GB/50.00GB",

"lunNum": 1,

"haStatus": null,

"lbStatus": null,

"slbStatus": null,

"cpuProgress": 6.4,

"memProgress": 37.57,

"monthAvgMem": 35.58,

"monthAvgCpu": 7.81,

"storage": "1.28TB",

"storageRate": "9.8%",

"storageAllocRatio": 9.8,

"allocatedCpu": 1,

"allocatedMem": "1.23GB",

"sensitivity": 1,

"enableHA": 0,

"enableLB": 0,

"enableIPM": 0,

"enableSLB": 0,

"description": null

}

],

"offset": null,

"size": null,

"total": null

}

}

2.5.4查询主机资源统计

接口地址

GET  /NSphere/api/dc-resource/statistics/host-resource

接口描述

查询主机资源统计。

请求数据类型

application/x-www-form-urlencoded

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
offset	偏移量。指定从第几条记录开始返回。	query	false	integer(int32)
limit	每页返回的最大记录数。	query	false	integer(int32)
sortDir	排序类型，0：不排序，1：升序，2：降序，sortField不为空时生效。	query	false	integer(int32)
sortField	排序字段。支持字段：name。	query	false	string
hostId	主机ID。	query	false	integer(int64)
hostName	主机名称，支持模糊查询。	query	false	string
clusterId	集群ID。	query	false	integer(int64)
hostPoolId	数据中心ID。	query	false	integer(int64)

响应状态

状态码	说明	schema
200	OK	ApiResponseApiPagingListResultApiHostResourceVO

响应参数

参数名称	参数说明	类型	schema
state	状态码 0: 成功, 1: 失败, 2: 部分成功	integer(int32)	integer(int32)
errorCode	错误码 当不为0表示业务发生错误	integer(int32)	integer(int32)
successMessage	成功消息	string
failureMessage	错误消息，失败或者部分成功时有效.	string
data	响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据	ApiPagingListResultApiHostResourceVO	ApiPagingListResultApiHostResourceVO
data	主机资源统计信息实体。	array	ApiHostResourceVO
id	主机ID。	integer(int64)
clusterId	集群ID。	integer(int64)
name	主机名称。	string
ipAddr	主机IP地址。	string
status	主机状态。（0：不正常，1：正常，2：不在HA，3和4：维护模式（4是本地存储故障），5：隔离模式，6：存储网隔离）	integer(int32)
storage	本地磁盘容量。（单位：MB）	integer(int64)
platform	主机平台版本。	string
cpu	CPU核数。	integer(int32)
memory	内存容量。（单位：MB）	integer(int64)
provider	主机型号。	string
cpuModel	CPU型号。	string
runningNum	运行状态虚拟机数量。	integer(int32)
shutoffNum	关机状态虚拟机数量。	integer(int32)
otherNum	其他状态虚拟机数量。	integer(int32)
summary	运行和关机虚拟机数量和。	integer(int32)
memRunningVm	运行状态虚拟机内存和。（单位：MB）	integer(int32)
cpuRate	最近一小时内CPU使用的平均利用率。（单位：%）	number(double)
memRate	最近一小时内内存使用的平均利用率。（单位：%）	number(double)
systemTime	系统运行时间。 例如：24天1时47分9秒。	string
diskRate	主机存储使用率统计。（vms分区，单位：%）	number(double)
topCpuRate	最近一小时内CPU使用的最高利用率。（单位：%）	number(double)
topMemRate	最近一小时内内存使用的最高利用率。（单位：%）	number(double)
monthAvgCpu	最近一个月内CPU使用的平均利用率。（单位：%）	number(double)
monthAvgMem	最近一个月内内存使用的平均利用率。（单位：%）	number(double)
monthTopCpu	最近一个月内CPU使用的最高利用率。（单位：%）	number(double)
monthTopMem	最近一个月内内存使用的最高利用率。（单位：%）	number(double)
cpuAlloc	已经分配给虚拟机的CPU核数。	integer(int64)
memAlloc	已经分配给虚拟机的内存容量。（单位：MB）	integer(int64)
memAllocRatio	内存分配比。（单位：%）	number(double)
cpuAllocRatio	CPU分配比。（单位：%）	number(double)
devName	存储设备名称。	string
iops	存储设备IO吞吐量情况。（单位：KBps）	string
mac	MAC地址信息。	string
portFlow	网络吞吐量情况。（单位：Mbps）	string
hostType	以16进制表示，右边第一位表示CPU架构，0：x86，1：ARM；第二位表示操作系统，0：Ubuntu，1：CentOS，2：NingOS，3：TOS。	integer(int32)
offset	偏移量。指定从第几条记录开始返回。	integer(int32)
size	当前返回的记录数。	integer(int32)
total	数据总量	integer(int64)

响应示例

{

"state": 0,

"errorCode": 0,

"successMessage": null,

"failureMessage": null,

"data": {

"data": [

{

"id": 1,

"clusterId": 34,

"name": "node62186",

"ipAddr": "192.0.2.196",

"status": 1,

"storage": 227714,

"platform": "CVK 9.0 (E0920)",

"cpu": 16,

"memory": 64044,

"provider": "QEMU Standard PC (i440FX + PIIX, 1996)",

"cpuModel": "Intel(R) Xeon(R) Silver 4214 CPU @ 2.20GHz",

"runningNum": 10,

"shutoffNum": 5,

"otherNum": 0,

"summary": 15,

"memRunningVm": 10240,

"cpuRate": 10.43,

"memRate": 37.22,

"systemTime": null,

"diskRate": 41,

"topCpuRate": 26.94,

"topMemRate": 37.92,

"monthAvgCpu": 7.83,

"monthAvgMem": 35.64,

"monthTopCpu": 64.19,

"monthTopMem": 38.5,

"cpuAlloc": 15,

"memAlloc": 14848,

"memAllocRatio": 23.18,

"cpuAllocRatio": 93.75,

"devName": "share_xx \nvda \n",

"iops": "share_xx-读:26,share_xx-写:0 \nvda-读:0,vda-写:14 \n",

"mac": "0c:da:41:1d:03:34 \n",

"portFlow": "0c:da:41:1d:03:34-接收:0.89,0c:da:41:1d:03:34-发送:0.12 \n",

"hostType": 32

}

],

"offset": null,

"size": null,

"total": null

}

}

2.5.5查询主机状态统计

接口地址

GET  /NSphere/api/dc-resource/statistics/host-status

接口描述

查询主机状态统计。

请求数据类型

application/x-www-form-urlencoded

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
hpId	数据中心ID。	query	false	integer(int64)
clusterId	集群ID。	query	false	integer(int64)

响应状态

状态码	说明	schema
200	OK	ApiResponseApiHostStatusCountVO

响应参数

参数名称	参数说明	类型	schema
state	状态码 0: 成功, 1: 失败, 2: 部分成功	integer(int32)	integer(int32)
errorCode	错误码 当不为0表示业务发生错误	integer(int32)	integer(int32)
successMessage	成功消息	string
failureMessage	错误消息，失败或者部分成功时有效.	string
data	响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据	ApiHostStatusCountVO	ApiHostStatusCountVO
total	主机总数。	integer(int32)
normal	正常状态主机数。	integer(int32)
closed	异常状态主机数。	integer(int32)
maintain	维护状态主机数。	integer(int32)
quarantine	隔离状态主机数。	integer(int32)

响应示例

{

"state": 0,

"errorCode": 0,

"successMessage": null,

"failureMessage": null,

"data": {

"total": null,

"normal": null,

"closed": null,

"maintain": null,

"quarantine": null

}

}

2.5.6查询IP分配统计

接口地址

GET  /NSphere/api/dc-resource/statistics/ip

接口描述

查询IP分配统计。

请求数据类型

application/x-www-form-urlencoded

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
offset	偏移量。指定从第几条记录开始返回。	query	false	integer(int32)
limit	每页返回的最大记录数。	query	false	integer(int32)
sortDir	排序类型，0：不排序，1：升序，2：降序，sortField不为空时生效。	query	false	integer(int32)
sortField	排序字段。支持字段：title，desc，mac，ip。	query	false	string
title	虚拟机显示名称，支持模糊查询。	query	false	string
hostId	主机ID。	query	false	integer(int64)
clusterId	集群ID。	query	false	integer(int64)
hostPoolId	数据中心ID。	query	false	integer(int64)
ip	IP地址，支持模糊查询。	query	false	string

响应状态

状态码	说明	schema
200	OK	ApiResponseApiPagingListResultApiIpResourceVO

响应参数

参数名称	参数说明	类型	schema
state	状态码 0: 成功, 1: 失败, 2: 部分成功	integer(int32)	integer(int32)
errorCode	错误码 当不为0表示业务发生错误	integer(int32)	integer(int32)
successMessage	成功消息	string
failureMessage	错误消息，失败或者部分成功时有效.	string
data	响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据	ApiPagingListResultApiIpResourceVO	ApiPagingListResultApiIpResourceVO
data	IP资源统计信息实体。	array	ApiIpResourceVO
id	虚拟机ID。	integer(int64)
title	虚拟机显示名称。	string
desc	虚拟机描述。	string
os	虚拟机安装的操作系统。	string
tools	NSpheretool状态。0：未运行 1：运行。	integer(int32)
mac	MAC地址。	string
ip	IP地址。	string
toolsVersion	NSpheretool版本。	string
offset	偏移量。指定从第几条记录开始返回。	integer(int32)
size	当前返回的记录数。	integer(int32)
total	数据总量	integer(int64)

响应示例

{

"state": 0,

"errorCode": 0,

"successMessage": null,

"failureMessage": null,

"data": {

"data": [

{

"id": 58,

"title": "centos_6",

"desc": "desc info",

"os": "CentOS release 6.4 (Final)",

"tools": 1,

"mac": "0c:da:41:1d:03:57",

"ip": "1.1.1.24",

"toolsVersion": "9.2.0.0.0.0"

}

],

"offset": null,

"size": null,

"total": null

}

}

2.5.7查询专用VLAN分配统计

接口地址

GET  /NSphere/api/dc-resource/statistics/pvlan

接口描述

查询专用VLAN分配统计。

请求数据类型

application/x-www-form-urlencoded

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
offset	偏移量。指定从第几条记录开始返回。	query	false	integer(int32)
limit	每页返回的最大记录数。	query	false	integer(int32)
sortDir	排序类型，0：不排序，1：升序，2：降序，sortField不为空时生效。	query	false	integer(int32)
sortField	排序字段。支持字段：title，desc，mac，ip。	query	false	string
vlanId	专用VLAN ID	query	false	integer(int64)

响应状态

状态码	说明	schema
200	OK	ApiResponseApiPagingListResultApiPvlanResourceVO

响应参数

参数名称	参数说明	类型	schema
state	状态码 0: 成功, 1: 失败, 2: 部分成功	integer(int32)	integer(int32)
errorCode	错误码 当不为0表示业务发生错误	integer(int32)	integer(int32)
successMessage	成功消息	string
failureMessage	错误消息，失败或者部分成功时有效.	string
data	响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据	ApiPagingListResultApiPvlanResourceVO	ApiPagingListResultApiPvlanResourceVO
data	专用VLAN资源统计信息实体。	array	ApiPvlanResourceVO
id	虚拟机ID。	integer(int64)
domainName	虚拟机名称。	string
title	虚拟机显示名称。	string
desc	虚拟机描述。	string
os	虚拟机安装的操作系统。	string
mac	MAC地址。	string
pvlanRule	专用vlan规则详情。	string
ip	IP地址。	string
toolsVersion	NSpheretool版本。	string
offset	偏移量。指定从第几条记录开始返回。	integer(int32)
size	当前返回的记录数。	integer(int32)
total	数据总量	integer(int64)

响应示例

{

"state": 0,

"errorCode": 0,

"successMessage": null,

"failureMessage": null,

"data": {

"data": [

{

"id": 3,

"domainName": "backup-test-001",

"title": "backup_test_001",

"desc": null,

"os": "CentOS release 6.4 (Final)",

"mac": "0c:da:41:1d:03:57",

"pvlanRule": null,

"ip": "1.1.1.24",

"toolsVersion": "9.2.0.0.0.0"

}

],

"offset": null,

"size": null,

"total": null

}

}

2.5.8查询共享文件系统资源统计

接口地址

GET  /NSphere/api/dc-resource/statistics/share-storage-resource

接口描述

查询共享文件系统资源统计。E0930版本接口新增返回属性。

请求数据类型

application/x-www-form-urlencoded

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
offset	偏移量。指定从第几条记录开始返回。	query	false	integer(int32)
limit	每页返回的最大记录数。	query	false	integer(int32)
sortDir	排序类型，0：不排序，1：升序，2：降序，sortField不为空时生效。	query	false	integer(int32)
sortField	只支持字段：title，storageType，targetPath。	query	false	string
hostPoolId	数据中心ID。	query	false	integer(int64)
clusterId	集群ID。	query	false	integer(int64)
hostId	主机ID。	query	false	integer(int64)

响应状态

状态码	说明	schema
200	OK	ApiResponseApiPagingListResultApiShareStorageResourceVO

响应参数

参数名称	参数说明	类型	schema
state	状态码 0: 成功, 1: 失败, 2: 部分成功	integer(int32)	integer(int32)
errorCode	错误码 当不为0表示业务发生错误	integer(int32)	integer(int32)
successMessage	成功消息	string
failureMessage	错误消息，失败或者部分成功时有效.	string
data	响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据	ApiPagingListResultApiShareStorageResourceVO	ApiPagingListResultApiShareStorageResourceVO
data	共享文件系统资源统计信息实体。	array	ApiShareStorageResourceVO
usedCapacity	已分配容量。（单位：MB）	string
actualAvailCapacity	实际可用容量。（单位：MB）	string
targetPath	目标路径。	string
storageType	类型。1：iSCSI共享文件系统，2：FC共享文件系统，3：NVMe-oF共享文件系统，5：iSER共享文件系统。	string
utilization	磁盘利用率。（单位：%）	number(double)
id	共享文件系统ID。	string
title	显示名称。	string
capacity	总容量。（单位：MB）	string
rdReq	读IOPS（单位：次/秒）。 E0930版本新增属性。	number(double)
wrReq	写IOPS（单位：次/秒）。 E0930版本新增属性。	number(double)
rdStat	读吞吐量（单位：KBps）。 E0930版本新增属性。	number(double)
wrStat	写吞吐量（单位：KBps）。 E0930版本新增属性。	number(double)
offset	偏移量。指定从第几条记录开始返回。	integer(int32)
size	当前返回的记录数。	integer(int32)
total	数据总量	integer(int64)

响应示例

{

"state": 0,

"errorCode": 0,

"successMessage": null,

"failureMessage": null,

"data": {

"data": [

{

"usedCapacity": 85059,

"actualAvailCapacity": 27356,

"targetPath": "/vms/share_xx",

"storageType": 1,

"utilization": 46.57,

"id": 1,

"title": "share_xx",

"capacity": 51200,

"rdReq": 50,

"wrReq": 0,

"rdStat": 204.21,

"wrStat": 0

}

],

"offset": null,

"size": null,

"total": null

}

}

2.5.9查询虚拟化资源统计

接口地址

GET  /NSphere/api/dc-resource/statistics/virtualized-resource

接口描述

查询虚拟化资源统计

请求数据类型

application/x-www-form-urlencoded

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
clusterId	集群ID。	query	false	integer(int64)

响应状态

状态码	说明	schema
200	OK	ApiResponseApiVirtualizedResourceVO

响应参数

参数名称	参数说明	类型	schema
state	状态码 0: 成功, 1: 失败, 2: 部分成功	integer(int32)	integer(int32)
errorCode	错误码 当不为0表示业务发生错误	integer(int32)	integer(int32)
successMessage	成功消息	string
failureMessage	错误消息，失败或者部分成功时有效.	string
data	响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据	ApiVirtualizedResourceVO	ApiVirtualizedResourceVO
cpuCount	主机CPU总核数。	integer(int64)
memCount	主机内存总容量。（已经格式显示，带单位）	string
countMemoryPic	主机内存总容量。（已经格式显示，不带单位）	string
vmCpuCount	虚拟机使用CPU核数。	integer(int64)
vmMemCount	已经分配给虚拟机的内存容量。（已经格式显示，带单位）	string
cpuRate	已经分配给虚拟机的CPU核数占主机CPU总核数的比例。（单位：%）	string
memRate	已经分配给虚拟机的内存容量占主机总内存的比例。（单位：%）	string
countStoragePic	共享存储总容量。（已经格式显示，不带单位）	string
totalStorage	共享存储总容量。（已经格式显示，带单位）	string
usedStorage	共享存储已用容量。（已经格式显示，带单位）	string
remainStorage	共享存储可用容量。（已经格式显示，带单位）	string
storageRate	共享存储已分配的容量占总容量的比例。（单位：%）	string
cpuUsedRate	实际使用CPU核数占CPU总核数的比例。（单位：%）	string
memUsedRate	实际使用内存占总内存的比例。（单位：%）	string
storageUsedRate	实际使用共享存储占总共享存储的比例。（单位：%）	string

响应示例

{

"state": 0,

"errorCode": 0,

"successMessage": null,

"failureMessage": null,

"data": {

"cpuCount": 384,

"memCount": "2.21TB",

"countMemoryPic": 2.21,

"vmCpuCount": 6,

"vmMemCount": "11.00GB",

"cpuRate": 1.56,

"memRate": 0.49,

"countStoragePic": 1.64,

"totalStorage": "1.64TB",

"usedStorage": "41.86GB",

"remainStorage": "1.60TB",

"storageRate": 3.27,

"cpuUsedRate": 2.63,

"memUsedRate": 12.87,

"storageUsedRate": 2.49

}

}

2.5.10查询VLAN分配统计

接口地址

GET  /NSphere/api/dc-resource/statistics/vlan

接口描述

查询VLAN分配统计。E0930版本接口新增参数。

请求数据类型

application/x-www-form-urlencoded

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
offset	偏移量。指定从第几条记录开始返回。	query	false	integer(int32)
limit	每页返回的最大记录数。为0时表示查询所有数据。	query	false	integer(int32)
sortDir	排序类型，0：不排序，1：升序，2：降序，limit为0且sortField不为空时生效。E0930版本新增参数。	query	false	integer(int32)
sortField	排序字段。支持字段：domainName，title，desc，os，mac，vlanId，ip，toolsVersion。E0930版本新增参数。	query	false	string
vlanId	VLAN ID。	query	false	integer(int32)

响应状态

状态码	说明	schema
200	OK	ApiResponseApiPagingListResultApiVlanResourceVO

响应参数

参数名称	参数说明	类型	schema
state	状态码 0: 成功, 1: 失败, 2: 部分成功	integer(int32)	integer(int32)
errorCode	错误码 当不为0表示业务发生错误	integer(int32)	integer(int32)
successMessage	成功消息	string
failureMessage	错误消息，失败或者部分成功时有效.	string
data	响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据	ApiPagingListResultApiVlanResourceVO	ApiPagingListResultApiVlanResourceVO
data	VLAN资源统计信息实体。	array	ApiVlanResourceVO
id	虚拟机ID。	integer(int64)
domainName	虚拟机名称。	string
title	虚拟机显示名称。	string
desc	虚拟机描述。	string
os	虚拟机安装的操作系统。	string
mac	MAC地址。	string
vlanId	VLAN ID。	integer(int32)
ip	IP地址。	string
toolsVersion	NSpheretool版本。	string
offset	偏移量。指定从第几条记录开始返回。	integer(int32)
size	当前返回的记录数。	integer(int32)
total	数据总量	integer(int64)

响应示例

{

"state": 0,

"errorCode": 0,

"successMessage": null,

"failureMessage": null,

"data": {

"data": [

{

"id": 3,

"domainName": "backup-test-001",

"title": "backup_test_001",

"desc": null,

"os": "CentOS release 6.4 (Final)",

"mac": "0c:da:41:1d:03:57",

"vlanId": 1,

"ip": "1.1.1.24",

"toolsVersion": "9.2.0.0.0.0"

}

],

"offset": null,

"size": null,

"total": null

}

}

2.5.11查询虚拟机磁盘资源统计

接口地址

GET  /NSphere/api/dc-resource/statistics/vm-disk-resource

接口描述

查询虚拟机磁盘资源统计。

请求数据类型

application/x-www-form-urlencoded

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
offset	偏移量。指定从第几条记录开始返回。	query	false	integer(int32)
limit	每页返回的最大记录数。	query	false	integer(int32)
sortDir	排序类型，0：不排序，1：升序，2：降序，sortField不为空时生效。	query	false	integer(int32)
sortField	排序字段。支持字段：domainTitle，status，hostName，capacity。	query	false	string
domainTitle	虚拟机显示名称，支持模糊查询。	query	false	string
hostPoolId	数据中心ID。	query	false	integer(int64)
clusterId	集群ID。	query	false	integer(int64)
hostId	主机ID。	query	false	integer(int64)

响应状态

状态码	说明	schema
200	OK	ApiResponseApiPagingListResultApiVmDiskResourceVO

响应参数

参数名称	参数说明	类型	schema
state	状态码 0: 成功, 1: 失败, 2: 部分成功	integer(int32)	integer(int32)
errorCode	错误码 当不为0表示业务发生错误	integer(int32)	integer(int32)
successMessage	成功消息	string
failureMessage	错误消息，失败或者部分成功时有效.	string
data	响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据	ApiPagingListResultApiVmDiskResourceVO	ApiPagingListResultApiVmDiskResourceVO
data	虚拟机磁盘资源统计信息实体。	array	ApiVmDiskResourceVO
id	磁盘ID。	integer(int64)
devName	磁盘名称。	string
fileName	磁盘路径。	string
poolPath	存储路径。	string
domainId	虚拟机ID。	integer(int64)
domainName	虚拟机名称。	string
domainTitle	虚拟机显示名称。	string
status	虚拟机的状态。shutOff：关闭，unknown：未知，ha_exception：ha异常，running：运行中，paused：暂停，sleeping：休眠。	string
hostId	主机ID。	integer(int64)
hostName	主机名称。	string
capacity	磁盘容量。（单位：MB）	number(double)
capacityStr	磁盘容量，转换为字符串。（单位：MB）	string
availableStr	磁盘可用容量。（单位：MB）	string
utilizationStr	磁盘利用率。（单位：%）	number(double)
backingFileName	基础镜像路径。	string
offset	偏移量。指定从第几条记录开始返回。	integer(int32)
size	当前返回的记录数。	integer(int32)
total	数据总量	integer(int64)

响应示例

{

"state": 0,

"errorCode": 0,

"successMessage": null,

"failureMessage": null,

"data": {

"data": [

{

"id": 3,

"devName": "vda",

"fileName": "/vms/share_xx/dfdfd",

"poolPath": "/vms/share_xx",

"domainId": 3,

"domainName": "backup-test-001",

"domainTitle": "backup_test_001",

"status": "running",

"hostId": 1,

"hostName": "node62186",

"capacity": 1024,

"capacityStr": 1024,

"availableStr": 1023.2832,

"utilizationStr": 0.07,

"backingFileName": "/vms/share_xx/dfdfd_base_1"

}

],

"offset": null,

"size": null,

"total": null

}

}

2.5.12查询虚拟机资源统计

接口地址

GET  /NSphere/api/dc-resource/statistics/vm-resource

接口描述

查询虚拟机资源统计。

请求数据类型

application/x-www-form-urlencoded

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
offset	偏移量。指定从第几条记录开始返回。	query	false	integer(int32)
limit	每页返回的最大记录数。	query	false	integer(int32)
sortDir	排序类型，0：不排序，1：升序，2：降序，sortField不为空时生效。	query	false	integer(int32)
sortField	排序字段。支持字段：title。	query	false	string
title	虚拟机显示名称，支持模糊查询。	query	false	string
hostId	主机ID。	query	false	integer(int64)
clusterId	集群ID。	query	false	integer(int64)
hostPoolId	数据中心ID。	query	false	integer(int64)

响应状态

状态码	说明	schema
200	OK	ApiResponseApiPagingListResultApiVmResourceVO

响应参数

参数名称	参数说明	类型	schema
state	状态码 0: 成功, 1: 失败, 2: 部分成功	integer(int32)	integer(int32)
errorCode	错误码 当不为0表示业务发生错误	integer(int32)	integer(int32)
successMessage	成功消息	string
failureMessage	错误消息，失败或者部分成功时有效.	string
data	响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据	ApiPagingListResultApiVmResourceVO	ApiPagingListResultApiVmResourceVO
data	虚拟机资源统计信息实体。	array	ApiVmResourceVO
id	虚拟机ID。	integer(int64)
name	虚拟机名称。	string
host	主机名称。	string
title	虚拟机显示名称。	string
computerName	计算机名称。	string
desc	虚拟机描述。	string
hostId	主机ID。	integer(int64)
clusterId	集群ID。	integer(int64)
clusterName	集群名称。	string
hostPoolId	数据中心ID。	integer(int64)
templateId	通过模板部署的虚拟机模板ID。	integer(int64)
enable	虚拟机类型。1：虚拟机，2：模板，3：删除的虚拟机，4：创建中，5:OVF模板。	integer(int32)
hostBinding	绑定主机情况。0:表示普通虚拟机，1：表示和主机绑定虚拟机，比如山石虚拟机。	integer(int32)
status	虚拟机的状态。shutOff：关闭，unknown：未知，ha_exception：ha异常，running：运行中，paused：暂停，sleeping：休眠。	string
cpuRate	CPU利用率。（单位：%）	number(double)
memRate	内存利用率。（单位：%）	number(double)
cpu	CPU核数。	integer(int32)
mem	内存容量。（单位：MB）	integer(int64)
system	虚拟机安装的操作系统。	string
sysInt	虚拟机安装的操作系统。0：Windows，1：Linux，2：BSD。	integer(int32)
haStatus	HA状态。0：正常，1：未加入HA，2：已加入HA，配置文件不同步。	integer(int32)
haManage	虚拟机被HA管理状态。0：未被HA管理，1：被HA管理。	integer(int32)
uuid	虚拟机UUID。	string
protectModel	虚拟机是否启用保护模式。 1：启用，0：不启用。	integer(int32)
nspheretools	NSpheretool状态，结合虚拟机状态判定。noRunning：未运行 running：运行 --：未知。	string
nspheretoolsStatus	NSpheretool状态。0：未运行 1：运行。	integer(int32)
nspheretoolsVersion	NSpheretool版本。	string
uptime	当前虚拟机的运行时间，单位分钟，-1表示未知。	integer(int32)
vmType	低位2字节表示虚拟机分类： 默认为1 1 普通虚拟机 101~200由VDI自定义 高位2字节表示虚拟机类型： 从低位到高位为0到31，高位2字节从16到31，使用第17，16位，00 正常虚拟机(界面显示为普通虚拟机)，01 灾备机 10 容灾恢复机，其余位未使用	integer(int32)
lastOffTime	最后关机时间。	integer(int64)
antivirusConfig	虚拟机是否启用防病毒配置。1：启用，0：不启用。	integer(int32)
createTime	创建时间。	string(date-time)
enableUltra	虚拟机是否启Ultra模式。1：启用，0或空为不启用。	integer(int32)
ipData	key为mac地址，value为具体网络信息。	ApiIpData	ApiIpData
mac	MAC地址。	string
ipAddr	IP地址。	string
mask	掩码。	string
ipv6Data	key为mac地址，value为具体网络信息。	ApiIpv6Data	ApiIpv6Data
mac	MAC地址。	string
ipAddr	IP地址。	string
mask	掩码。	string
mac	MAC地址信息。	string
ipv6	IPv6信息。	string
ipv4	IPv4信息。	string
ipv4Attributes	第一个IPv4地址。	string
ipv6Attributes	第一个IPv6地址。	string
diskInfo	磁盘设备名称。 如果磁盘为空则使用“-”代替，使用“ \n”作为分隔符。	string
capacity	磁盘容量，带单位。 如果磁盘为空则使用“-”代替，使用“ \n”作为分隔符。	string
useage	磁盘利用率，带单位。 如果磁盘为空则使用“-”代替，使用“ \n”作为分隔符。	string
autoMemStatus	内存复用状态。0:关闭，1:开启。	integer(int32)
haRealStatus	HA真实状态，根据集群HA状态和虚拟机被HA管理状态计算得到。 0:关闭 1:开启。	integer(int32)
offset	偏移量。指定从第几条记录开始返回。	integer(int32)
size	当前返回的记录数。	integer(int32)
total	数据总量	integer(int64)

响应示例

{

"state": 0,

"errorCode": 0,

"successMessage": null,

"failureMessage": null,

"data": {

"data": [

{

"id": 3,

"name": "backup-test-001",

"host": "node62186",

"title": "backup_test_001",

"computerName": null,

"desc": null,

"hostId": 1,

"clusterId": 34,

"clusterName": "cluster",

"hostPoolId": 1,

"templateId": 2,

"enable": 1,

"hostBinding": 0,

"status": "running",

"cpuRate": 1,

"memRate": 7.19,

"cpu": 8,

"mem": 1024,

"system": "Red Hat Enterprise Linux 8(64-bit)",

"sysInt": 1,

"haStatus": 0,

"haManage": 1,

"uuid": "a76b426c-f44a-45c3-8dc6-1e02261b8605",

"protectModel": 0,

"nspheretools": "noRunning",

"nspheretoolsStatus": 0,

"nspheretoolsVersion": "9.2.0.0.0.0",

"uptime": -1,

"vmType": 1,

"lastOffTime": 0,

"antivirusConfig": 0,

"createTime": "2025-11-13T08:37:49.000+00:00",

"enableUltra": 0,

"ipData": {

"additionalProperties1": [

{

"mac": "0c:da:41:1d:03:30",

"ipAddr": "20.2.1.1",

"mask": "255.255.0.0"

}

]

},

"ipv6Data": {

"additionalProperties1": [

{

"mac": "0c:da:41:1d:03:30",

"ipAddr": "20::1",

"mask": 64

}

]

},

"mac": "0c:da:41:1d:f2:7b \n\n0c:da:41:1d:a6:cc \n\n0c:da:41:1d:bf:20",

"ipv6": "172:20::3a:252 \n\n",

"ipv4": "20.3.1.1 \n\n\n20.2.1.1 \n\n\n20.1.1.1 \n\n\n",

"ipv4Attributes": "20.3.1.1",

"ipv6Attributes": "172:20::3a:252",

"diskInfo": "vda \n",

"capacity": "1.00GB \n",

"useage": "11.87% \n",

"autoMemStatus": 0,

"haRealStatus": 1

}

],

"offset": null,

"size": null,

"total": null

}

}

2.5.13查询虚拟机关机时间统计

接口地址

GET  /NSphere/api/dc-resource/statistics/vm-shutdown-time

接口描述

查询虚拟机关机时间统计

请求数据类型

application/x-www-form-urlencoded

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
offset	偏移量。指定从第几条记录开始返回。	query	false	integer(int32)
limit	每页返回的最大记录数。	query	false	integer(int32)
sortDir	排序类型，0：不排序，1：升序，2：降序，sortField不为空时生效。	query	false	integer(int32)
sortField	只支持字段：sumTime。	query	false	string
startTime	统计周期的开始时间。如果设置了截至时间，需要不大于开始时间。	query	false	string
endTime	统计周期的截止时间。如果设置了开始时间，必须不小于开始时间。	query	false	string

响应状态

状态码	说明	schema
200	OK	ApiResponseApiPagingListResultApiVmOffTimeVO

响应参数

参数名称	参数说明	类型	schema
state	状态码 0: 成功, 1: 失败, 2: 部分成功	integer(int32)	integer(int32)
errorCode	错误码 当不为0表示业务发生错误	integer(int32)	integer(int32)
successMessage	成功消息	string
failureMessage	错误消息，失败或者部分成功时有效.	string
data	响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据	ApiPagingListResultApiVmOffTimeVO	ApiPagingListResultApiVmOffTimeVO
data	虚拟机关机时间统计信息实体。	array	ApiVmOffTimeVO
id	虚拟机关机时间ID。	integer(int64)
vmId	虚拟机ID。	integer(int64)
vmName	虚拟机名称。	string
vmTitle	虚拟机显示名称。	string
hostId	主机ID。	integer(int64)
hostName	主机名称。	string
osDesc	操作系统。	string
vmStatus	虚拟机的状态。shutOff：关闭，unknown：未知，ha_exception：ha异常，running：运行中，paused：暂停，sleeping：休眠。	string
offTime	关机时间。Unix 毫秒级时间戳。	integer(int64)
runningTime	开机时间。Unix 毫秒级时间戳。	integer(int64)
offPeriod	关机时长。单位：毫秒。	integer(int64)
sumTime	关机总时长。单位：毫秒。	integer(int64)
offset	偏移量。指定从第几条记录开始返回。	integer(int32)
size	当前返回的记录数。	integer(int32)
total	数据总量	integer(int64)

响应示例

{

"state": 0,

"errorCode": 0,

"successMessage": null,

"failureMessage": null,

"data": {

"data": [

{

"id": 3,

"vmId": 3,

"vmName": "backup-test-001",

"vmTitle": "backup_test_001",

"hostId": 1,

"hostName": "node62186",

"osDesc": "Red Hat Enterprise Linux 8(64-bit)",

"vmStatus": "running",

"offTime": 1765782240004,

"runningTime": 1765782240004,

"offPeriod": 1303044633,

"sumTime": 1303044633

}

],

"offset": null,

"size": null,

"total": null

}

}

2.5.14查询虚拟机状态统计

接口地址

GET  /NSphere/api/dc-resource/statistics/vm-status

接口描述

查询虚拟机状态统计。

请求数据类型

application/x-www-form-urlencoded

响应数据类型

application/json

请求参数

参数名称	参数说明	请求类型	必须	数据类型	schema
hpId	数据中心ID。	query	false	integer(int64)
clusterId	集群ID。	query	false	integer(int64)
hostId	主机ID。	query	false	integer(int64)

响应状态

状态码	说明	schema
200	OK	ApiResponseApiVmStatusCountVO

响应参数

参数名称	参数说明	类型	schema
state	状态码 0: 成功, 1: 失败, 2: 部分成功	integer(int32)	integer(int32)
errorCode	错误码 当不为0表示业务发生错误	integer(int32)	integer(int32)
successMessage	成功消息	string
failureMessage	错误消息，失败或者部分成功时有效.	string
data	响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据	ApiVmStatusCountVO	ApiVmStatusCountVO
total	虚拟机总数。	integer(int32)
running	正常状态虚拟机数。	integer(int32)
shutOff	关闭状态虚拟机数。	integer(int32)
unknown	异常状态虚拟机数。	integer(int32)

响应示例

{

"state": 0,

"errorCode": 0,

"successMessage": null,

"failureMessage": null,

"data": {

"total": null,

"running": null,

"shutOff": null,

"unknown": null

}

}