Check SCSI LUN and 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, the 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
uuidStringurlResource UUID, 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.0,
        "availableCpuCapacity": 2.0,
        "totalMemoryCapacity": 4.0,
        "availableMemoryCapacity": 4.0
      }
    ],
    "unattachedHosts": [
      {
        "zoneUuid": "ee802d3432203cc99a9711b3d26e047d",
        "name": "example",
        "uuid": "0d28db87cedc3c729300bcc7f426f9b6",
        "clusterUuid": "5d5325e38b4331c28efe5367dc583110",
        "description": "example",
        "managementIp": "192.168.0.2",
        "hypervisorType": "KVM",
        "state": "Enabled",
        "status": "Connected",
        "totalCpuCapacity": 4.0,
        "availableCpuCapacity": 2.0,
        "totalMemoryCapacity": 4.0,
        "availableMemoryCapacity": 4.0
      }
    ],
    "isAllHostsAttached": false
  }
}
NameTypeDescriptionStarting Version
successboolean 0.6
errorErrorCodeError code. If not null, the operation failed. If null, the operation succeeded. For details, see error3.1.0
inventoryScsiLunClusterStatusInventoryFor details, see inventory3.1.0

error

NameTypeDescriptionStarting Version
codeStringError code number, globally unique identifier of the error, e.g. SYS.1000, HOST.10013.1.0
descriptionStringBrief description of the error3.1.0
detailsStringDetailed error information3.1.0
elaborationStringReserved field, defaults to null3.1.0
opaqueLinkedHashMapReserved field, defaults to null3.1.0
causeErrorCodeRoot cause. The error that caused the current error. If there is no original error, this field is null3.1.0

inventory

NameTypeDescriptionStarting Version
isAllHostsAttachedBooleanWhether the SCSI LUN is connected to all hosts in the cluster3.1.0
attachedHostsListFor details, see attachedHosts3.1.0
unattachedHostsListFor details, see unattachedHosts3.1.0

attachedHosts

NameTypeDescriptionStarting Version
zoneUuidStringData Center UUID3.1.0
nameStringResource name3.1.0
uuidStringResource UUID, uniquely identifies the resource3.1.0
clusterUuidStringCluster UUID3.1.0
descriptionStringResource description3.1.0
managementIpString 3.1.0
hypervisorTypeString 3.1.0
stateString 3.1.0
statusString 3.1.0
totalCpuCapacityLong 3.1.0
availableCpuCapacityLong 3.1.0
cpuSocketsIntegerNumber of physical CPU sockets0.6
totalMemoryCapacityLong 3.1.0
availableMemoryCapacityLong 3.1.0
cpuNumIntegerNumber of logical CPUs0.6
ipmiAddressStringIPMI address0.6
ipmiUsernameStringIPMI username0.6
ipmiPortIntegerIPMI port0.6
ipmiPowerStatusStringIPMI power status0.6
architectureString 0.6
nqnStringNVMe Qualified Name4.10.6
hostnameStringHostname4.10.20
createDateTimestampCreation time3.1.0
lastOpDateTimestampLast modification time3.1.0
cpuStatusHwMonitorStatusFor details, see cpuStatus4.10.0
memoryStatusHwMonitorStatusFor details, see memoryStatus4.10.0
diskStatusHwMonitorStatusFor details, see diskStatus4.10.0
nicStatusHwMonitorStatusFor details, see nicStatus4.10.0
gpuStatusHwMonitorStatusFor details, see gpuStatus4.10.0
powerSupplyStatusHwMonitorStatusFor details, see powerSupplyStatus4.10.0
fanStatusHwMonitorStatusFor details, see fanStatus4.10.0
raidStatusHwMonitorStatusFor details, see raidStatus4.10.0
temperatureStatusHwMonitorStatusFor details, see temperatureStatus4.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 UUID3.1.0
nameStringResource name3.1.0
uuidStringResource UUID, uniquely identifies the resource3.1.0
clusterUuidStringCluster UUID3.1.0
descriptionStringResource description3.1.0
managementIpString 3.1.0
hypervisorTypeString 3.1.0
stateString 3.1.0
statusString 3.1.0
totalCpuCapacityLong 3.1.0
availableCpuCapacityLong 3.1.0
cpuSocketsIntegerNumber of physical CPU sockets0.6
totalMemoryCapacityLong 3.1.0
availableMemoryCapacityLong 3.1.0
cpuNumIntegerNumber of logical CPUs0.6
ipmiAddressStringIPMI address0.6
ipmiUsernameStringIPMI username0.6
ipmiPortIntegerIPMI port0.6
ipmiPowerStatusStringIPMI power status0.6
architectureString 0.6
nqnStringNVMe Qualified Name4.10.6
hostnameStringHostname4.10.20
createDateTimestampCreation time3.1.0
lastOpDateTimestampLast modification time3.1.0
cpuStatusHwMonitorStatusFor details, see cpuStatus4.10.0
memoryStatusHwMonitorStatusFor details, see memoryStatus4.10.0
diskStatusHwMonitorStatusFor details, see diskStatus4.10.0
nicStatusHwMonitorStatusFor details, see nicStatus4.10.0
gpuStatusHwMonitorStatusFor details, see gpuStatus4.10.0
powerSupplyStatusHwMonitorStatusFor details, see powerSupplyStatus4.10.0
fanStatusHwMonitorStatusFor details, see fanStatus4.10.0
raidStatusHwMonitorStatusFor details, see raidStatus4.10.0
temperatureStatusHwMonitorStatusFor details, see temperatureStatus4.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

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