Check SCSI LUN Cluster Connection Status

PUT/zstack/v1/storage-devices/scsi-lun/{uuid}/cluster/{clusterUuid}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "checkScsiLunClusterStatus": {},
  "systemTags": [],
  "userTags": []
}

In the example above, systemTags and userTags fields can be omitted. They are listed to indicate that the body can contain these two fields.

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"checkScsiLunClusterStatus":{}}' \
http://localhost:8080/zstack/v1/storage-devices/scsi-lun/abe6bf1e763739f88f97055c14246245/cluster/5415c2beb8a93447a27f69c109cdfb23

Parameter List

NameTypeLocationDescriptionAllowed ValuesStarting Version
uuidStringurlUUID of the resource. Uniquely identifies the resource. 3.1.0
clusterUuidStringurlCluster UUID 3.1.0
systemTags (Optional)Listbody  3.1.0
userTags (Optional)Listbody  3.1.0

API Response

Response Example

{
  "inventory": {
    "attachedHosts": [
      {
        "zoneUuid": "5899ac6fab7d3951acae1d43c4fd7f97",
        "name": "example",
        "uuid": "161616a23a4834cfbe3dd7000a75ef51",
        "clusterUuid": "b886a9367ff9362d8955443cc5065fab",
        "description": "example",
        "managementIp": "192.168.0.1",
        "hypervisorType": "KVM",
        "state": "Enabled",
        "status": "Connected",
        "totalCpuCapacity": 4,
        "availableCpuCapacity": 2,
        "totalMemoryCapacity": 4,
        "availableMemoryCapacity": 4
      }
    ],
    "unattachedHosts": [
      {
        "zoneUuid": "ee802d3432203cc99a9711b3d26e047d",
        "name": "example",
        "uuid": "0d28db87cedc3c729300bcc7f426f9b6",
        "clusterUuid": "5d5325e38b4331c28efe5367dc583110",
        "description": "example",
        "managementIp": "192.168.0.2",
        "hypervisorType": "KVM",
        "state": "Enabled",
        "status": "Connected",
        "totalCpuCapacity": 4,
        "availableCpuCapacity": 2,
        "totalMemoryCapacity": 4,
        "availableMemoryCapacity": 4
      }
    ],
    "isAllHostsAttached": false
  }
}
NameTypeDescriptionStarting Version
successboolean 0.6
errorErrorCodeError code. If not null, the operation failed. If null, the operation succeeded. See error for details3.1.0
inventoryScsiLunClusterStatusInventorySee inventory for details3.1.0

error

NameTypeDescriptionStarting Version
codeStringError code number. Globally unique identifier of the error, for example SYS.1000, HOST.1001.0.6
descriptionStringBrief error description0.6
detailsStringDetailed error information0.6
elaborationStringReserved field, defaults to null0.6
opaqueLinkedHashMapReserved field, defaults to null0.6
causeErrorCodeRoot cause error. The error that caused the current error. If there is no original error, this field is null.0.6

inventory

NameTypeDescriptionStarting Version
isAllHostsAttachedBooleanWhether the SCSI LUN is connected to all hosts in the cluster3.1.0
attachedHostsListSee attachedHosts for details3.1.0
unattachedHostsListSee unattachedHosts for details3.1.0

attachedHosts

NameTypeDescriptionStarting Version
zoneUuidStringData Center UUID0.6
nameStringResource name0.6
uuidStringUUID of the resource. Uniquely identifies the resource.0.6
clusterUuidStringCluster UUID0.6
descriptionStringResource description0.6
managementIpString 0.6
hypervisorTypeString 0.6
stateString 0.6
statusString 0.6
totalCpuCapacityLong 0.6
availableCpuCapacityLong 0.6
cpuSocketsIntegerNumber of physical CPU sockets0.6
totalMemoryCapacityLong 0.6
availableMemoryCapacityLong 0.6
cpuNumIntegerNumber of logical CPUs0.6
ipmiAddressStringIPMI address0.6
ipmiUsernameStringIPMI username0.6
ipmiPortIntegerIPMI port0.6
ipmiPowerStatusStringIPMI power status0.6
architectureString 0.6
nqnStringNVMe Qualified Namezsv 4.10.6
createDateTimestampCreate time0.6
lastOpDateTimestampLast update time0.6
cpuStatusHwMonitorStatusSee cpuStatus for details4.10.0
memoryStatusHwMonitorStatusSee memoryStatus for details4.10.0
diskStatusHwMonitorStatusSee diskStatus for details4.10.0
nicStatusHwMonitorStatusSee nicStatus for details4.10.0
gpuStatusHwMonitorStatusSee gpuStatus for details4.10.0
powerSupplyStatusHwMonitorStatusSee powerSupplyStatus for details4.10.0
fanStatusHwMonitorStatusSee fanStatus for details4.10.0
raidStatusHwMonitorStatusSee raidStatus for details4.10.0
temperatureStatusHwMonitorStatusSee temperatureStatus for details4.10.0

cpuStatus

NameTypeDescriptionStarting Version
NormalHwMonitorStatusNormal4.10.0
ErrorHwMonitorStatusError4.10.0
UnknownHwMonitorStatusUnknown4.10.0

memoryStatus

NameTypeDescriptionStarting Version
NormalHwMonitorStatusNormal4.10.0
ErrorHwMonitorStatusError4.10.0
UnknownHwMonitorStatusUnknown4.10.0

diskStatus

NameTypeDescriptionStarting Version
NormalHwMonitorStatusNormal4.10.0
ErrorHwMonitorStatusError4.10.0
UnknownHwMonitorStatusUnknown4.10.0

nicStatus

NameTypeDescriptionStarting Version
NormalHwMonitorStatusNormal4.10.0
ErrorHwMonitorStatusError4.10.0
UnknownHwMonitorStatusUnknown4.10.0

gpuStatus

NameTypeDescriptionStarting Version
NormalHwMonitorStatusNormal4.10.0
ErrorHwMonitorStatusError4.10.0
UnknownHwMonitorStatusUnknown4.10.0

powerSupplyStatus

NameTypeDescriptionStarting Version
NormalHwMonitorStatusNormal4.10.0
ErrorHwMonitorStatusError4.10.0
UnknownHwMonitorStatusUnknown4.10.0

fanStatus

NameTypeDescriptionStarting Version
NormalHwMonitorStatusNormal4.10.0
ErrorHwMonitorStatusError4.10.0
UnknownHwMonitorStatusUnknown4.10.0

raidStatus

NameTypeDescriptionStarting Version
NormalHwMonitorStatusNormal4.10.0
ErrorHwMonitorStatusError4.10.0
UnknownHwMonitorStatusUnknown4.10.0

temperatureStatus

NameTypeDescriptionStarting Version
NormalHwMonitorStatusNormal4.10.0
ErrorHwMonitorStatusError4.10.0
UnknownHwMonitorStatusUnknown4.10.0

unattachedHosts

NameTypeDescriptionStarting Version
zoneUuidStringData Center UUID0.6
nameStringResource name0.6
uuidStringUUID of the resource. Uniquely identifies the resource.0.6
clusterUuidStringCluster UUID0.6
descriptionStringResource description0.6
managementIpString 0.6
hypervisorTypeString 0.6
stateString 0.6
statusString 0.6
totalCpuCapacityLong 0.6
availableCpuCapacityLong 0.6
cpuSocketsIntegerNumber of physical CPU sockets0.6
totalMemoryCapacityLong 0.6
availableMemoryCapacityLong 0.6
cpuNumIntegerNumber of logical CPUs0.6
ipmiAddressStringIPMI address0.6
ipmiUsernameStringIPMI username0.6
ipmiPortIntegerIPMI port0.6
ipmiPowerStatusStringIPMI power status0.6
architectureString 0.6
nqnStringNVMe Qualified Namezsv 4.10.6
createDateTimestampCreate time0.6
lastOpDateTimestampLast update time0.6
cpuStatusHwMonitorStatusSee cpuStatus for details4.10.0
memoryStatusHwMonitorStatusSee memoryStatus for details4.10.0
diskStatusHwMonitorStatusSee diskStatus for details4.10.0
nicStatusHwMonitorStatusSee nicStatus for details4.10.0
gpuStatusHwMonitorStatusSee gpuStatus for details4.10.0
powerSupplyStatusHwMonitorStatusSee powerSupplyStatus for details4.10.0
fanStatusHwMonitorStatusSee fanStatus for details4.10.0
raidStatusHwMonitorStatusSee raidStatus for details4.10.0
temperatureStatusHwMonitorStatusSee temperatureStatus for details4.10.0

cpuStatus

NameTypeDescriptionStarting Version
NormalHwMonitorStatusNormal4.10.0
ErrorHwMonitorStatusError4.10.0
UnknownHwMonitorStatusUnknown4.10.0

memoryStatus

NameTypeDescriptionStarting Version
NormalHwMonitorStatusNormal4.10.0
ErrorHwMonitorStatusError4.10.0
UnknownHwMonitorStatusUnknown4.10.0

diskStatus

NameTypeDescriptionStarting Version
NormalHwMonitorStatusNormal4.10.0
ErrorHwMonitorStatusError4.10.0
UnknownHwMonitorStatusUnknown4.10.0

nicStatus

NameTypeDescriptionStarting Version
NormalHwMonitorStatusNormal4.10.0
ErrorHwMonitorStatusError4.10.0
UnknownHwMonitorStatusUnknown4.10.0

gpuStatus

NameTypeDescriptionStarting Version
NormalHwMonitorStatusNormal4.10.0
ErrorHwMonitorStatusError4.10.0
UnknownHwMonitorStatusUnknown4.10.0

powerSupplyStatus

NameTypeDescriptionStarting Version
NormalHwMonitorStatusNormal4.10.0
ErrorHwMonitorStatusError4.10.0
UnknownHwMonitorStatusUnknown4.10.0

fanStatus

NameTypeDescriptionStarting Version
NormalHwMonitorStatusNormal4.10.0
ErrorHwMonitorStatusError4.10.0
UnknownHwMonitorStatusUnknown4.10.0

raidStatus

NameTypeDescriptionStarting Version
NormalHwMonitorStatusNormal4.10.0
ErrorHwMonitorStatusError4.10.0
UnknownHwMonitorStatusUnknown4.10.0

temperatureStatus

NameTypeDescriptionStarting Version
NormalHwMonitorStatusNormal4.10.0
ErrorHwMonitorStatusError4.10.0
UnknownHwMonitorStatusUnknown4.10.0

SDK Examples

Java SDK

CheckScsiLunClusterStatusAction action = new CheckScsiLunClusterStatusAction();
action.uuid = "abe6bf1e763739f88f97055c14246245";
action.clusterUuid = "5415c2beb8a93447a27f69c109cdfb23";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
CheckScsiLunClusterStatusAction.Result res = action.call();

Python SDK

CheckScsiLunClusterStatusAction action = CheckScsiLunClusterStatusAction()
action.uuid = "abe6bf1e763739f88f97055c14246245"
action.clusterUuid = "5415c2beb8a93447a27f69c109cdfb23"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
CheckScsiLunClusterStatusAction.Result res = action.call()