集群
2.4.1集群详情
接口地址
GET /NSphere/api/cluster-resource
接口描述
id和clusterName两个参数必须要传其中一个，如果两个参数都传，则以id为准。E0930版本接口新增返回属性。
请求数据类型
application/x-www-form-urlencoded
响应数据类型
application/json
请求参数
参数名称 | 参数说明 | 请求类型 | 必须 | 数据类型 | schema |
id | 集群ID（集群ID与集群名称需至少提供一项。若同时提供，系统将以集群ID为准） | query | false | integer(int64) | |
clusterName | 集群名称（集群ID与集群名称需至少提供一项。若同时提供，系统将以集群ID为准） | query | false | string |
响应状态
状态码 | 说明 | schema |
200 | OK | ApiResponseApiGetClusterDetailVO |
响应参数
参数名称 | 参数说明 | 类型 | schema |
state | 状态码 0: 成功, 1: 失败, 2: 部分成功 | integer(int32) | integer(int32) |
errorCode | 错误码 当不为0表示业务发生错误 | integer(int32) | integer(int32) |
successMessage | 成功消息 | string | |
failureMessage | 错误消息，失败或者部分成功时有效. | string | |
data | 响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据 | ApiGetClusterDetailVO | ApiGetClusterDetailVO |
id | 集群ID。 | integer(int64) | |
hostPoolId | 数据中心ID。 | integer(int64) | |
hostPoolName | 数据中心名称。 E0930版本新增属性。 | string | |
name | 集群名称。 | string | |
description | 集群描述。 | string | |
enableHA | 是否启用HA（高可靠性） 0:不启用HA 1:启用HA。 | integer(int32) | |
priority | 启动优先级（高可靠性） 0:低级 1:中级 2:高级。 | integer(int32) | |
sensitivity | 主机亚健康敏感度级别。0：低级；1：中级；2：高级；3：自定义。 | integer(int32) | |
enableLB | 是否开启计算资源DRS（动态资源调度）， 0:不开启 1:开启。 | integer(int32) | |
enableIntelligent | 是否启用智能DRS。取值范围：0：不启用，1：启用。 | integer(int32) | |
persistTime | （计算资源DRS）持续时间，单位：分钟。 | integer(int32) | |
checkInterval | （计算资源DRS）检查间隔，单位：分钟。 | integer(int32) | |
enableIPM | 是否启用电源智能管理 0:不启用电源智能管理 1:启用电源智能管理。 | integer(int32) | |
persistTimeIPM | （电源智能管理）持续时间，单位：分钟。 | integer(int32) | |
ipmLowerMonitorId | （电源智能管理）主机回收监控策略ID。 | integer(int64) | |
ipmLowerMonitorName | （电源智能管理）主机回收监控策略名称。 | string | |
ipmUpperMonitorId | （电源智能管理）主机唤醒策略ID。 | integer(int64) | |
ipmUpperMonitorName | （电源智能管理）主机唤醒策略名称。 | string | |
checkIntervalIPM | （电源智能管理）检查间隔，单位：分钟。 | integer(int32) | |
drsEnableTime | 集群DRS启用的时间段，高位2字节表示开始时间，低位2字节表示截止时间。表示时间的2字节，高位表示时，低位表示分。（示例：开始时间：01:10，截止时间：16:40，字段值为：0x010a1028） | integer(int32) | |
enableDrsEnableTime | 是否启用DRS功能生效时间段（0：关闭 ，1：启用） | integer(int32) | |
ipmEnableTime | 集群IPM启用的时间段，高位2字节表示开始时间，低位2字节表示截止时间。表示时间的2字节，高位表示时，低位表示分。（示例：开始时间：01:10，截止时间：16:40，字段值为：0x010a1028） | integer(int32) | |
enableIPMEnableTime | 是否启用电源功能生效时间段（0：关闭 ，1：启用） | integer(int32) | |
operatorGroupCode | 操作员组编码。 | string | |
broadcastAddr | 组播地址。 | string | |
broadcastPort | 组播端口。 | integer(int32) | |
lbMonitorId | 计算资源DRS监控策略ID。 | integer(int64) | |
lbMonitorName | 计算资源DRS监控策略名称。 | string | |
haMinHost | HA接入控制的生效最小节点数，如果集群内正常运行的主机数量小于该参数时，虚拟机将无法进行HA故障迁移。（只有haControlStrategy字段为1时该字段才有效，haMinHost为-1表示不采用生效最小节点数策略） | integer(int32) | |
enableSLB | 是否开启存储资源DRS 0:不开启 1:开启。 | integer(int32) | |
slbPersistTime | 存储资源DRS持续时间，单位：分钟。 | integer(int32) | |
slbCheckInterval | 存储资源DRS检查间隔，单位：分钟。 | integer(int32) | |
slbMonitorId | 存储资源DRS监控策略ID | integer(int64) | |
slbMonitorName | 存储资源DRS监控策略名称 | string | |
enableStorageHA | 是否启用本地存储高可靠性 0:不启用HA 1:启用HA | integer(int32) | |
haControlStrategy | HA接入控制策略。0：关闭HA接入控制策略；1：使用生效最小节点数策略，如果集群内正常运行的主机数量小于该参数时，虚拟机将无法进行HA故障迁移；2：使用HA资源预留策略，为HA保留一定比例的资源（CPU或内存）以保证HA更稳定的工作。当集群剩余的资源不足设置的比例时，则不能再启动集群内的虚拟机、将虚拟机还原到运行/6682停状态、迁入运行状态的虚拟机；3：使用故障切换主机策略，当集群HA内出现故障虚拟机需要自动迁移时，优先从指定的主机组内选择迁移目的主机，指定的主机组仅用于故障迁移，不能作为增加、迁移虚拟机的目的主机。 | integer(int32) | |
haCpuRetain | HA CPU资源预留（单位：%），只有haControlStrategy字段为2时该字段才有效。 | integer(int32) | |
haMemRetain | HA 内存资源预留（单位：%），只有haControlStrategy字段为2时该字段才有效。 | integer(int32) | |
enableBusinessHA | 是否启用业务网HA 0:关闭 ，1:启用。 | integer(int32) | |
proactiveHA | 主动HA。0关闭，1开启。 | integer(int32) | |
containerCluster | 是否是容器集群 0:普通集群 ，1:容器集群。 | integer(int32) | |
localDiskHa | 启用/禁用本地磁盘HA 1为开启，0为关闭。 | integer(int32) | |
localDiskTime | 本地磁盘故障检测周期，秒。 | integer(int32) | |
strategyDelayTime | 策略超时（主机存储故障处理策略延迟时间，单位：分钟），默认值：12000。 | integer(int32) | |
cpuMode | 虚拟机CPU工作模式：0-兼容模式; 1-主机匹配模式;2-直通模式;3-EMC模式。 | integer(int32) | |
emcType | EMC模式（0：intel EMC，1：AMD EMC），cpuMode为3时该字段才有效。 | integer(int32) | |
emcCpuModel | 具体的CPU型号（可选值如下：10 Conroe, 20 Penryn, 30 Nehalem, 40 Westmere, 50 SandyBridge, 60 IvyBridge, 70 Haswell, 80 Broadwell, 90 Skylake-Client, 100 Skylake-Server, 110 Cascadelake-Server, 120 Icelake-Client, 130 Icelake-Server, 10010 Opteron_G1, 10020 Opteron_G2, 10030 phenom, 10040 Opteron_G3, 10050 Opteron_G4, 10060 Opteron_G5, 10070 EPYC），cpuMode为3时该字段才有效。 | integer(int32) | |
type | 标识集群内主机的CPU架构、内核。以16进制表示，右边第一位表示CPU架构，0：x86，1：ARM；第二位表示操作系统，0：Ubuntu，1：CentOS，2：NingOS，3：TOS。 | integer(int32) | |
enableStretched | 集群延伸配置开关。0:集群关闭延伸配置 ，1:集群启用延伸配置。 | integer(int32) | |
proactiveHAParams | 主动HA规则。 | array | ProactiveHAParamVO |
id | 主动HA规则ID | integer(int64) | |
clusterId | 主动HA规则所属的集群ID | integer(int64) | |
type | 类型（cpuTemperature：CPU温度过高，diskFault：系统盘故障，ramError：内存CE错误频率，ramIsolation：内存CE错误页隔离占比，diskLifeOver：主机系统盘寿命将尽（SSD），powerModuleFault：主机仅剩一个电源模块、raidFault：RAID卡故障） | string | |
threshold | 阈值。超过阈值时，并且时间达到persistTime字段设置的持续时间时，会触发主动HA（只有以下几项有此配置：CPU温度过高、内存CE错误频率、内存CE错误页隔离占比、主机系统盘寿命将尽时的磁盘磨损度（SSD），其他主动HA配置项是固定值0） | integer(int32) | |
persistTime | 持续时间。超过阈值时，并且持续时间达到该项的设置的值时，会触发主动HA（只有CPU温度过高有此配置，其他主动HA配置项是固定值1） | integer(int32) | |
responseMode | 响应方式（主动HA响应方式只有这几种 2：智能热迁移，3：主机隔离，4：主机进入维护模式） | integer(int32) | |
enable | 是否启用这个主动HA规则（0：不启用，1：启用） | integer(int32) | |
faultHAParams | 故障HA规则。 | array | FaultHAParamVO |
type | 故障HA类型（hostFault：主机故障，vmFault：虚拟机故障，businessNetFault：业务网故障，hostStorageFault：主机存储故障） | string | |
enable | 是否启用故障HA规则（0：不启用，1：启用） | integer(int32) | |
threshold | 阈值（只有主机存储故障有该配置，内容为超时时间，单位：分钟） | integer(int32) | |
triggerAction | 响应方式（1：故障迁移，2：不处理，3：I/O转移，4：在线迁移） | integer(int32) |
响应示例
{
"state": 0,
"errorCode": 0,
"successMessage": null,
"failureMessage": null,
"data": {
"id": null,
"hostPoolId": null,
"hostPoolName": null,
"name": null,
"description": null,
"enableHA": null,
"priority": null,
"sensitivity": null,
"enableLB": null,
"enableIntelligent": null,
"persistTime": null,
"checkInterval": null,
"enableIPM": null,
"persistTimeIPM": null,
"ipmLowerMonitorId": null,
"ipmLowerMonitorName": null,
"ipmUpperMonitorId": null,
"ipmUpperMonitorName": null,
"checkIntervalIPM": null,
"drsEnableTime": null,
"enableDrsEnableTime": null,
"ipmEnableTime": null,
"enableIPMEnableTime": null,
"operatorGroupCode": null,
"broadcastAddr": null,
"broadcastPort": null,
"lbMonitorId": null,
"lbMonitorName": null,
"haMinHost": null,
"enableSLB": null,
"slbPersistTime": null,
"slbCheckInterval": null,
"slbMonitorId": null,
"slbMonitorName": null,
"enableStorageHA": null,
"haControlStrategy": null,
"haCpuRetain": null,
"haMemRetain": null,
"enableBusinessHA": null,
"proactiveHA": null,
"containerCluster": null,
"localDiskHa": null,
"localDiskTime": null,
"strategyDelayTime": null,
"cpuMode": null,
"emcType": null,
"emcCpuModel": null,
"type": null,
"enableStretched": null,
"proactiveHAParams": [
{
"id": null,
"clusterId": null,
"type": null,
"threshold": null,
"persistTime": null,
"responseMode": null,
"enable": null
}
],
"faultHAParams": [
{
"type": null,
"enable": null,
"threshold": null,
"triggerAction": null
}
]
}
}
2.4.2增加集群
接口地址
POST /NSphere/api/cluster-resource
接口描述
请求数据类型
application/json
响应数据类型
application/json
请求示例
{
"name": "",
"description": null,
"enableHA": 0,
"priority": 1,
"sensitivity": 1,
"hostPoolId": 0,
"haControlStrategy": 0,
"haCpuRetain": null,
"haMemRetain": null,
"cpuMode": 0,
"emcType": null,
"emcCpuModel": null,
"haMinHost": null
}
请求参数
参数名称 | 参数说明 | 请求类型 | 必须 | 数据类型 | schema |
apiAddClusterDTO | ApiAddClusterDTO | body | true | ApiAddClusterDTO | ApiAddClusterDTO |
name | 集群名称。最小长度为1，最大长度为32。只允许输入汉字、字母、数字、减号、下划线、空格及点，且不能全部为空格。 | true | string | ||
description | 集群描述。 | false | string | ||
enableHA | 是否启用HA（高可靠性） 0:不启用HA 1:启用HA。 | true | integer(int32) | ||
priority | 启动优先级（高可靠性） 0:低级 1:中级 2:高级。 | false | integer(int32) | ||
sensitivity | HA敏感度。启用HA时，此项才生效。取值范围：0：低级，1：中级，2：高级。默认值为1。低级敏感度会关闭业务网故障HA，关闭所有主动HA，不上报亚健康问题，实现最小化干预的监控模式。中级敏感度会关闭业务网故障HA，启用所有主动HA，上报亚健康问题，并触发主机隔离，实现业务连续性的平衡防护。高级敏感度会关闭业务网故障HA，启用所有主动HA，上报主机亚健康问题，并触发智能热迁移，确保高可用并减少业务中断。 | false | integer(int32) | ||
hostPoolId | 数据中心ID。 | true | integer(int64) | ||
haControlStrategy | HA接入控制策略。0：关闭HA接入控制策略；1：使用生效最小节点数策略，如果集群内正常运行的主机数量小于该参数时，虚拟机将无法进行HA故障迁移；2：使用HA资源预留策略，为HA保留一定比例的资源（CPU或内存）以保证HA更稳定的工作。当集群剩余的资源不足设置的比例时，则不能再启动集群内的虚拟机、将虚拟机还原到运行/6682停状态、迁入运行状态的虚拟机；3：使用故障切换主机策略，当集群HA内出现故障虚拟机需要自动迁移时，优先从指定的主机组内选择迁移目的主机，指定的主机组仅用于故障迁移，不能作为增加、迁移虚拟机的目的主机。 | true | integer(int32) | ||
haCpuRetain | HA CPU资源预留（单位：%），只有haControlStrategy字段为2时该字段才有效。 | false | integer(int32) | ||
haMemRetain | HA 内存资源预留（单位：%），只有haControlStrategy字段为2时该字段才有效。 | false | integer(int32) | ||
cpuMode | 虚拟机CPU工作模式：0-兼容模式; 1-主机匹配模式;2-直通模式;3-EMC模式。 | false | integer(int32) | ||
emcType | EMC模式（0：intel EMC，1：AMD EMC），cpuMode为3时该字段才有效。 | false | integer(int32) | ||
emcCpuModel | 具体的CPU型号（可选值如下：10 Conroe, 20 Penryn, 30 Nehalem, 40 Westmere, 50 SandyBridge, 60 IvyBridge, 70 Haswell, 80 Broadwell, 90 Skylake-Client, 100 Skylake-Server, 110 Cascadelake-Server, 120 Icelake-Client, 130 Icelake-Server, 10010 Opteron_G1, 10020 Opteron_G2, 10030 phenom, 10040 Opteron_G3, 10050 Opteron_G4, 10060 Opteron_G5, 10070 EPYC），cpuMode为3时该字段才有效。 | false | integer(int32) | ||
haMinHost | HA接入控制的生效最小节点数，如果集群内正常运行的主机数量小于该参数时，虚拟机将无法进行HA故障迁移。（只有haControlStrategy字段为1时该字段才有效，haMinHost为-1表示不采用生效最小节点数策略） | false | integer(int32) |
响应状态
状态码 | 说明 | schema |
200 | OK | ApiResponseVoid |
响应参数
参数名称 | 参数说明 | 类型 | schema |
state | 状态码 0: 成功, 1: 失败, 2: 部分成功 | integer(int32) | integer(int32) |
errorCode | 错误码 当不为0表示业务发生错误 | integer(int32) | integer(int32) |
successMessage | 成功消息 | string | |
failureMessage | 错误消息，失败或者部分成功时有效. | string | |
data | 响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据 | string |
响应示例
{
"state": 0,
"errorCode": 0,
"successMessage": null,
"failureMessage": null,
"data": {}
}
2.4.3修改集群名称
接口地址
PUT /NSphere/api/cluster-resource/{id}
接口描述
修改集群名称。超融合集群不支持修改集群名称。
请求数据类型
application/json
响应数据类型
application/json
请求示例
{
"name": ""
}
请求参数
参数名称 | 参数说明 | 请求类型 | 必须 | 数据类型 | schema |
id | 集群ID。 | path | true | integer(int64) | |
apiModifyClusterDTO | ApiModifyClusterDTO | body | true | ApiModifyClusterDTO | ApiModifyClusterDTO |
name | 集群名称。最小长度为1，最大长度为32。只允许输入汉字、字母、数字、减号、下划线、空格及点，且不能全部为空格。 | true | string |
响应状态
状态码 | 说明 | schema |
200 | OK | ApiResponseVoid |
响应参数
参数名称 | 参数说明 | 类型 | schema |
state | 状态码 0: 成功, 1: 失败, 2: 部分成功 | integer(int32) | integer(int32) |
errorCode | 错误码 当不为0表示业务发生错误 | integer(int32) | integer(int32) |
successMessage | 成功消息 | string | |
failureMessage | 错误消息，失败或者部分成功时有效. | string | |
data | 响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据 | string |
响应示例
{
"state": 0,
"errorCode": 0,
"successMessage": null,
"failureMessage": null,
"data": {}
}
2.4.4删除集群
接口地址
DELETE /NSphere/api/cluster-resource/{id}
接口描述
请求数据类型
application/x-www-form-urlencoded
响应数据类型
application/json
请求参数
参数名称 | 参数说明 | 请求类型 | 必须 | 数据类型 | schema |
id | 集群ID。 | path | true | integer(int64) |
响应状态
状态码 | 说明 | schema |
200 | OK | ApiResponseApiTaskMsgVO |
响应参数
参数名称 | 参数说明 | 类型 | schema |
state | 状态码 0: 成功, 1: 失败, 2: 部分成功 | integer(int32) | integer(int32) |
errorCode | 错误码 当不为0表示业务发生错误 | integer(int32) | integer(int32) |
successMessage | 成功消息 | string | |
failureMessage | 错误消息，失败或者部分成功时有效. | string | |
data | 响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据 | ApiTaskMsgVO | ApiTaskMsgVO |
msgId | 消息ID，可用于查询任务进度。 | integer(int64) | |
targetId | 任务执行对象ID | integer(int64) | |
targetName | 任务执行对象名称 | string |
响应示例
{
"state": 0,
"errorCode": 0,
"successMessage": null,
"failureMessage": null,
"data": {
"msgId": 0,
"targetId": null,
"targetName": null
}
}
2.4.5集群列表
接口地址
GET /NSphere/api/cluster-resource/list
接口描述
集群列表。E0930版本接口新增参数。
请求数据类型
application/x-www-form-urlencoded
响应数据类型
application/json
请求参数
参数名称 | 参数说明 | 请求类型 | 必须 | 数据类型 | schema |
offset | 偏移量。指定从第几条记录开始返回。 | query | false | integer(int32) | |
limit | 每页返回的最大记录数。 | query | false | integer(int32) | |
sortField | 排序字段。支持字段：name。 | query | false | string | |
sortDir | 排序类型，0：不排序，1：升序，2：降序，sortField不为空时默认不排序。 | query | false | integer(int32) | |
ids | 集群ID列表，传参示例ids=1&ids=2&ids=3 | query | false | array | integer |
clusterName | 集群名称。E0930版本新增参数。 | query | false | string | |
hpId | 数据中心ID | query | false | integer(int64) |
响应状态
状态码 | 说明 | schema |
200 | OK | ApiResponseApiPagingListResultApiGetClusterVO |
响应参数
参数名称 | 参数说明 | 类型 | schema |
state | 状态码 0: 成功, 1: 失败, 2: 部分成功 | integer(int32) | integer(int32) |
errorCode | 错误码 当不为0表示业务发生错误 | integer(int32) | integer(int32) |
successMessage | 成功消息 | string | |
failureMessage | 错误消息，失败或者部分成功时有效. | string | |
data | 响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据 | ApiPagingListResultApiGetClusterVO | ApiPagingListResultApiGetClusterVO |
data | 集群信息。 | array | ApiGetClusterVO |
id | 集群ID。 | integer(int64) | |
name | 集群名称。 | string | |
description | 集群描述。 | string | |
hostPoolId | 数据中心ID。 | integer(int64) | |
enableHA | 是否启用HA（高可靠性） 0:不启用HA 1:启用HA。 | integer(int32) | |
priority | 启动优先级（高可靠性） 0:低级 1:中级 2:高级。 | integer(int32) | |
sensitivity | 主机亚健康敏感度级别。0：低级；1：中级；2：高级；3：自定义。 | integer(int32) | |
enableLB | 是否开启计算资源DRS（动态资源调度）， 0:不开启 1:开启。 | integer(int32) | |
enableIntelligent | 是否启用智能DRS。取值范围：0：不启用，1：启用。 | integer(int32) | |
persistTime | （计算资源DRS）持续时间，单位：分钟。 | integer(int32) | |
checkInterval | （计算资源DRS）检查间隔，单位：分钟。 | integer(int32) | |
enableIPM | 是否启用电源智能管理 0:不启用电源智能管理 1:启用电源智能管理。 | integer(int32) | |
enableIPMEnableTime | 是否启用电源功能生效时间段（0：关闭 ，1：启用） | integer(int32) | |
persistTimeIPM | （电源智能管理）持续时间，单位：分钟。 | integer(int32) | |
ipmLowerMonitorId | （电源智能管理）主机回收监控策略ID。 | integer(int64) | |
ipmUpperMonitorId | （电源智能管理）主机唤醒策略ID。 | integer(int64) | |
checkIntervalIPM | （电源智能管理）检查间隔，单位：分钟。 | integer(int32) | |
drsEnableTime | 集群DRS启用的时间段，高位2字节表示开始时间，低位2字节表示截止时间。表示时间的2字节，高位表示时，低位表示分。（示例：开始时间：01:10，截止时间：16:40，字段值为：0x010a1028） | integer(int32) | |
enableDrsEnableTime | 是否启用DRS功能生效时间段（0：关闭 ，1：启用） | integer(int32) | |
ipmEnableTime | 集群IPM启用的时间段，高位2字节表示开始时间，低位2字节表示截止时间。表示时间的2字节，高位表示时，低位表示分。（示例：开始时间：01:10，截止时间：16:40，字段值为：0x010a1028） | integer(int32) | |
operatorGroupId | 操作员组ID。 | integer(int64) | |
operatorGroupCode | 操作员组编码。 | string | |
lbMonitorId | 计算资源DRS监控策略ID。 | integer(int64) | |
haMinHost | HA接入控制的生效最小节点数，如果集群内正常运行的主机数量小于该参数时，虚拟机将无法进行HA故障迁移。（只有haControlStrategy字段为1时该字段才有效，haMinHost为-1表示不采用生效最小节点数策略） | integer(int32) | |
enableSLB | 是否开启存储资源DRS 0:不开启 1:开启。 | integer(int32) | |
slbPersistTime | 存储资源DRS持续时间，单位：分钟。 | integer(int32) | |
slbCheckInterval | 存储资源DRS检查间隔，单位：分钟。 | integer(int32) | |
slbMonitorId | 存储资源DRS监控策略ID | integer(int64) | |
enableStorageHA | 是否启用本地存储高可靠性 0:不启用HA 1:启用HA | integer(int32) | |
haControlStrategy | HA接入控制策略。0：关闭HA接入控制策略；1：使用生效最小节点数策略，如果集群内正常运行的主机数量小于该参数时，虚拟机将无法进行HA故障迁移；2：使用HA资源预留策略，为HA保留一定比例的资源（CPU或内存）以保证HA更稳定的工作。当集群剩余的资源不足设置的比例时，则不能再启动集群内的虚拟机、将虚拟机还原到运行/6682停状态、迁入运行状态的虚拟机；3：使用故障切换主机策略，当集群HA内出现故障虚拟机需要自动迁移时，优先从指定的主机组内选择迁移目的主机，指定的主机组仅用于故障迁移，不能作为增加、迁移虚拟机的目的主机。 | integer(int32) | |
haCpuRetain | HA CPU资源预留（单位：%），只有haControlStrategy字段为2时该字段才有效。 | integer(int32) | |
haMemRetain | HA 内存资源预留（单位：%），只有haControlStrategy字段为2时该字段才有效。 | integer(int32) | |
enableBusinessHA | 是否启用业务网HA 0:关闭 ，1:启用。 | integer(int32) | |
triggerAction | 主机存储故障处理策略（触发动作） 1:故障迁移 ，2:不处理，3:I/O转移。 | integer(int32) | |
containerCluster | 是否是容器集群 0:普通集群 ，1:容器集群。 | integer(int32) | |
localDiskHa | 启用/禁用本地磁盘HA 1为开启，0为关闭。 | integer(int32) | |
localDiskTime | 本地磁盘故障检测周期，秒。 | integer(int32) | |
strategyDelayTime | 策略超时（主机存储故障处理策略延迟时间，单位：分钟），默认值：12000。 | integer(int32) | |
cpuMode | 虚拟机CPU工作模式：0-兼容模式; 1-主机匹配模式;2-直通模式;3-EMC模式。 | integer(int32) | |
emcType | EMC模式（0：intel EMC，1：AMD EMC），cpuMode为3时该字段才有效。 | integer(int32) | |
emcCpuModel | 具体的CPU型号（可选值如下：10 Conroe, 20 Penryn, 30 Nehalem, 40 Westmere, 50 SandyBridge, 60 IvyBridge, 70 Haswell, 80 Broadwell, 90 Skylake-Client, 100 Skylake-Server, 110 Cascadelake-Server, 120 Icelake-Client, 130 Icelake-Server, 10010 Opteron_G1, 10020 Opteron_G2, 10030 phenom, 10040 Opteron_G3, 10050 Opteron_G4, 10060 Opteron_G5, 10070 EPYC），cpuMode为3时该字段才有效。 | integer(int32) | |
type | 标识集群内主机的CPU架构、内核。以16进制表示，右边第一位表示CPU架构，0：x86，1：ARM；第二位表示操作系统，0：Ubuntu，1：CentOS，2：NingOS，3：TOS。 | integer(int32) | |
enableStretched | 集群延伸配置开关。0:集群关闭延伸配置 ，1:集群启用延伸配置。 | integer(int32) | |
offset | 偏移量。指定从第几条记录开始返回。 | integer(int32) | |
size | 当前返回的记录数。 | integer(int32) | |
total | 数据总量 | integer(int64) |
响应示例
{
"state": 0,
"errorCode": 0,
"successMessage": null,
"failureMessage": null,
"data": {
"data": [
{
"id": null,
"name": null,
"description": null,
"hostPoolId": null,
"enableHA": null,
"priority": null,
"sensitivity": null,
"enableLB": null,
"enableIntelligent": null,
"persistTime": null,
"checkInterval": null,
"enableIPM": null,
"enableIPMEnableTime": null,
"persistTimeIPM": null,
"ipmLowerMonitorId": null,
"ipmUpperMonitorId": null,
"checkIntervalIPM": null,
"drsEnableTime": null,
"enableDrsEnableTime": null,
"ipmEnableTime": null,
"operatorGroupId": null,
"operatorGroupCode": null,
"lbMonitorId": null,
"haMinHost": null,
"enableSLB": null,
"slbPersistTime": null,
"slbCheckInterval": null,
"slbMonitorId": null,
"enableStorageHA": null,
"haControlStrategy": null,
"haCpuRetain": null,
"haMemRetain": null,
"enableBusinessHA": null,
"triggerAction": null,
"containerCluster": null,
"localDiskHa": null,
"localDiskTime": null,
"strategyDelayTime": null,
"cpuMode": null,
"emcType": null,
"emcCpuModel": null,
"type": null,
"enableStretched": null
}
],
"offset": null,
"size": null,
"total": null
}
}
2.4.6查询集群外挂存储一致性
接口地址
GET /NSphere/api/cluster-resource/shareFile/same
接口描述
查询集群外挂存储一致性。E0930版本新增接口。
请求数据类型
application/x-www-form-urlencoded
响应数据类型
application/json
请求参数
参数名称 | 参数说明 | 请求类型 | 必须 | 数据类型 | schema |
id | 集群ID（如果同时传入了集群ID和数据中心ID，系统将以集群ID为准） | query | false | integer(int64) | |
hpId | 数据中心ID（如果同时传入了集群ID和数据中心ID，系统将以集群ID为准） | query | false | integer(int64) |
响应状态
状态码 | 说明 | schema |
200 | OK | ApiResponseListApiShareFileSameVO |
响应参数
参数名称 | 参数说明 | 类型 | schema |
state | 状态码 0: 成功, 1: 失败, 2: 部分成功 | integer(int32) | integer(int32) |
errorCode | 错误码 当不为0表示业务发生错误 | integer(int32) | integer(int32) |
successMessage | 成功消息 | string | |
failureMessage | 错误消息，失败或者部分成功时有效. | string | |
data | 响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据 | array | ApiShareFileSameVO |
clusterId | 集群ID。 | integer(int64) | |
clusterName | 集群名称。 | string | |
consistency | 外挂存储一致性（true：一致，false：非一致）。 | string |
响应示例
{
"state": 0,
"errorCode": 0,
"successMessage": null,
"failureMessage": null,
"data": [
{
"clusterId": null,
"clusterName": null,
"consistency": null
}
]
}
2.4.7集群外挂存储
接口地址
GET /NSphere/api/cluster-resource/shareFile/stat
接口描述
集群外挂存储。E0930版本新增接口。
请求数据类型
application/x-www-form-urlencoded
响应数据类型
application/json
请求参数
参数名称 | 参数说明 | 请求类型 | 必须 | 数据类型 | schema |
hpId | 数据中心ID。 | query | false | integer(int64) | |
clusterId | 集群ID。 | query | false | integer(int64) |
响应状态
状态码 | 说明 | schema |
200 | OK | ApiResponseListApiShareFileStatVO |
响应参数
参数名称 | 参数说明 | 类型 | schema |
state | 状态码 0: 成功, 1: 失败, 2: 部分成功 | integer(int32) | integer(int32) |
errorCode | 错误码 当不为0表示业务发生错误 | integer(int32) | integer(int32) |
successMessage | 成功消息 | string | |
failureMessage | 错误消息，失败或者部分成功时有效. | string | |
data | 响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据 | array | ApiShareFileStatVO |
name | 存储名称。 | string | |
clusterId | 集群ID。 | integer(int64) | |
usage | 存储使用率，百分比。 | number(double) | |
rdStat | 读吞吐量：KBps。 | number(double) | |
wrStat | 写吞吐量：KBps。 | number(double) | |
rdReq | 读请求(每秒)。 | number(double) | |
wrReq | 写请求(每秒)。 | number(double) |
响应示例
{
"state": 0,
"errorCode": 0,
"successMessage": null,
"failureMessage": null,
"data": [
{
"name": null,
"clusterId": null,
"usage": null,
"rdStat": null,
"wrStat": null,
"rdReq": null,
"wrReq": null
}
]
}
2.4.8查询虚拟机组或主机组
接口地址
GET /NSphere/api/cluster-resource/vmHostGroup
接口描述
查询虚拟机组或主机组。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 | 排序字段。支持字段：flag，name，id。 | query | false | string | |
flag | 组的类型（1：虚拟机组，2：主机组，3：延展配置虚拟机组，4：延展配置主机组）。 | query | false | integer(int64) | |
ne_id | 不查询的虚拟机/主机组ID（不等于该ID的组） | query | false | integer(int64) | |
clusterId | 集群ID。 | query | false | integer(int64) | |
groupName | 虚拟机/主机组的名称。 | query | false | string |
响应状态
状态码 | 说明 | schema |
200 | OK | ApiResponseApiPagingListResultApiVMHostGroupVO |
响应参数
参数名称 | 参数说明 | 类型 | schema |
state | 状态码 0: 成功, 1: 失败, 2: 部分成功 | integer(int32) | integer(int32) |
errorCode | 错误码 当不为0表示业务发生错误 | integer(int32) | integer(int32) |
successMessage | 成功消息 | string | |
failureMessage | 错误消息，失败或者部分成功时有效. | string | |
data | 响应数据，如果状态码为0表示正常的数据返回，如果非0且非空则代表引起异常的必要数据 | ApiPagingListResultApiVMHostGroupVO | ApiPagingListResultApiVMHostGroupVO |
data | 虚拟机/主机组信息。 | array | ApiVMHostGroupVO |
flag | 组的类型（1：虚拟机组，2：主机组，3：延展配置虚拟机组，4：延展配置主机组）。 | integer(int32) | |
name | 虚拟机/主机组的名称。 | string | |
clusterId | 集群ID | integer(int64) | |
id | 虚拟机/主机组ID。 | integer(int64) | |
drsGroupVmHosts | 虚拟机/主机组中的虚拟机/主机信息。 | array | ApiVMHostGroupHostVO |
nspheretoolsVersion | nspheretools版本 | string | |
haStatus | HA异常状态（0：正常，1：未加入HA，2：已加入HA，配置文件不同步） | integer(int32) | |
nspheretoolsStatus | nspheretools状态（0：未运行，1：运行） | integer(int32) | |
hostIp | 主机IP | string | |
hostId | 虚拟机所在主机ID | integer(int64) | |
cpu | 虚拟机CPU个数 | integer(int32) | |
clusterId | 虚拟机所在集群ID | integer(int64) | |
title | 虚拟机显示名称（展示用，可修改） | string | |
enableUltra | 虚拟机是否启用Ultra模式（1：启用，0或空为不启用）。 | integer(int32) | |
uuid | 虚拟机UUID | string | |
hostPoolId | 虚拟机所在数据中心ID | integer(int64) | |
uptime | 虚拟机运行时间（单位：分钟，-1表示未知） | integer(int32) | |
system | 虚拟机操作系统版本信息 | string | |
mem | 虚拟机内存（单位：MB） | integer(int64) | |
antivirusConfig | 虚拟机是否启用防病毒配置（0：不启用，1：启用） | integer(int32) | |
enable | 虚拟机状态（1：虚拟机，2：模板，3：删除的虚拟机，4：创建中） | integer(int32) | |
protectModel | 虚拟机是否启用保护模式（1：启用，0：不启用） | integer(int32) | |
name | 虚拟机名称 | string | |
host | 虚拟机所在主机名称 | string | |
haManage | HA状态（0：未被HA管理，1：被HA管理） | integer(int32) | |
sysInt | 虚拟机安装的操作系统（0：Windows，1：Linux，2：BSD） | integer(int32) | |
id | 虚拟机ID | integer(int64) | |
desc | 虚拟机描述 | string | |
status | 虚拟机状态（字符串）：ha_exception（当虚拟机的haStatus不为0但有别的值时），unknown，running，shutoff，paused，sleeping。主机状态（字符串类型的数字）：维护模式时（3：维护模式，4：本地存储故障维护模式）；非维护模式时（2：主机非异常且主机在HA集群但主机未启用HA）；其他（0：异常，1：正常，5：隔离模式，等等）。 | string | |
offset | 偏移量。指定从第几条记录开始返回。 | integer(int32) | |
size | 当前返回的记录数。 | integer(int32) | |
total | 数据总量 | integer(int64) |
响应示例
{
"state": 0,
"errorCode": 0,
"successMessage": null,
"failureMessage": null,
"data": {
"data": [
{
"flag": null,
"name": null,
"clusterId": null,
"id": null,
"drsGroupVmHosts": [
{
"nspheretoolsVersion": null,
"haStatus": null,
"nspheretoolsStatus": null,
"hostIp": null,
"hostId": null,
"cpu": null,
"clusterId": null,
"title": null,
"enableUltra": null,
"uuid": null,
"hostPoolId": null,
"uptime": null,
"system": null,
"mem": null,
"antivirusConfig": null,
"enable": null,
"protectModel": null,
"name": null,
"host": null,
"haManage": null,
"sysInt": null,
"id": null,
"desc": null,
"status": null
}
]
}
],
"offset": null,
"size": null,
"total": null
}
}
2.4.9增加虚拟机组或主机组
接口地址
POST /NSphere/api/cluster-resource/vmHostGroup
接口描述
增加虚拟机组或主机组。E0930版本新增接口。
请求数据类型
application/json
响应数据类型
application/json
请求示例
{
"clusterId": 0,
"flag": 0,
"name": "",
"drsGroupDetailList": [
{
"entityId": 0,
"entityName": null
}
]
}
请求参数
参数名称 | 参数说明 | 请求类型 | 必须 | 数据类型 | schema |
apiAddVMHostGroupDTO | 增加虚拟机组或主机组请求实体 | body | true | ApiAddVMHostGroupDTO | ApiAddVMHostGroupDTO |
clusterId | 集群ID。 | true | integer(int64) | ||
flag | 组的类型（1：虚拟机组，2：主机组）。 | true | integer(int32) | ||
name | 组的名称，只允许输入汉字、字母、数字、减号、下划线、空格及点，且不能全部为空格。最大输入字符长度为64。 | true | string | ||
drsGroupDetailList | 虚拟机列表或主机列表实体 | true | array | VMHostGroupDetailDTO | |
entityId | 虚拟机ID或主机ID | true | integer(int64) | ||
entityName | 虚拟机名称或主机名称 | false | string |
响应状态
状态码 | 说明 | schema |
200 | OK | VmHostGroupApiResponseLong |
响应参数
参数名称 | 参数说明 | 类型 | schema |
state | 状态码 0: 成功, 1: 失败, 2: 部分成功 | integer(int32) | integer(int32) |
errorCode | 错误码 当不为0表示业务发生错误 | integer(int32) | integer(int32) |
successMessage | 成功消息 | string | |
failureMessage | 错误消息，失败或者部分成功时有效. | string | |
data | 虚拟机组ID或主机组ID | integer(int64) | integer(int64) |
响应示例
{
"state": 0,
"errorCode": 0,
"successMessage": null,
"failureMessage": null,
"data": null
}