DocsKnowledge BaseAPI Explorer
Documentation›Explore more›ZStack Cloud›RESTful API OverviewZCF
Document navigation

QuerySlbVmInstance

API Request

URLs
GET zstack/v1/load-balancers/slb/instances
GET zstack/v1/load-balancers/slb/instances/{uuid}
Headers
Authorization: OAuth the-session-uuid
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/load-balancers/slb/instances?q=uuid=76efa7d6d9033af6b8b85c0d4050f725
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/load-balancers/slb/instances/bebda93d772c3ea8a16242cf8fb85e64

Queryable Fields

You can check all queryable fields and resource names that can be queried across tables by using zstack-cli, entering QuerySlbVmInstance, and pressing the Tab key.

API Response

Sample Response
{
  "inventories": [
    {
      "slbGroupUuid": "0643d154403b3f668cd86e632b839751",
      "configTasks": [
        {
          "vmInstanceUuid": "b44f739da7d03d1e8d746992bf1d0511",
          "configVersion": 101,
          "taskName": "taskA",
          "taskData": "Data",
          "retryNumber": 2,
          "lastFailedReason": "failed",
          "status": "Failed"
        }
      ],
      "configVersion": 100,
      "uuid": "b44f739da7d03d1e8d746992bf1d0511",
      "name": "SLB",
      "description": "SLB Instance VM",
      "zoneUuid": "1ddfa48e92d432219525e71710872fed",
      "clusterUuid": "fe266a478f7a3ee791d60ec8bf515107",
      "imageUuid": "7b76ac4b5d5338f7aa534dd6d2f651de",
      "hostUuid": "d3d2f05490d93a548da3975b9aef2b02",
      "lastHostUuid": "458e298932f13bf8970a49ab37eef4b2",
      "instanceOfferingUuid": "2cb51561bace3d9cbe0e1537ed5c8d87",
      "rootVolumeUuid": "a258b546210239239b6b007257b534dd",
      "platform": "Linux",
      "defaultL3NetworkUuid": "75d6d9c236a63240ba3de52babcddb4e",
      "type": "ApplianceVm",
      "hypervisorType": "KVM",
      "memorySize": 8589934592,
      "cpuNum": 1,
      "allocatorStrategy": "LastHostPreferredAllocatorStrategy",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM",
      "state": "Running",
      "vmNics": [
        {
          "uuid": "e2ddf013a62d385f9ae7b3da274da83b",
          "vmInstanceUuid": "b44f739da7d03d1e8d746992bf1d0511",
          "usedIpUuid": "f190b722694839e2bbd1fa6f2cb1ded5",
          "l3NetworkUuid": "40ec403203343b738576fbf4b575bdec",
          "ip": "192.168.1.10",
          "mac": "00:0c:29:bd:99:fc",
          "hypervisorType": "KVM",
          "netmask": "255.255.255.0",
          "gateway": "192.168.1.1",
          "deviceId": 0,
          "state": "enable",
          "createDate": "Nov 14, 2017 10:20:57 PM",
          "lastOpDate": "Nov 14, 2017 10:20:57 PM"
        }
      ],
      "allVolumes": [
        {
          "uuid": "c5055efcc2323281add5f09787f73d15",
          "name": "Root-Volume-For-VM-b44f739da7d03d1e8d746992bf1d0511",
          "primaryStorageUuid": "9e0252991dcc3ae09e10b69aad9743be",
          "vmInstanceUuid": "b44f739da7d03d1e8d746992bf1d0511",
          "diskOfferingUuid": "17b973054ad83a9a99c2defce44731d2",
          "rootImageUuid": "7b76ac4b5d5338f7aa534dd6d2f651de",
          "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-fcdefa0ed8dc3cabbca631c8205d57cc/c63e2314a73f3182af05c14e7f3155c9.qcow2",
          "type": "Root",
          "format": "qcow2",
          "size": 107374182400,
          "actualSize": 21474836480,
          "deviceId": 0,
          "state": "Enabled",
          "status": "Ready",
          "createDate": "Nov 14, 2017 10:20:57 PM",
          "lastOpDate": "Nov 14, 2017 10:20:57 PM"
        }
      ]
    }
  ]
}
Name Type Description Starting Version
success boolean Whether the operation succeeded. 5.1.0
inventories List See 5.1.0
error ErrorCode The error code. If not null, the operation fails, or vice versa. For more information, see error. 5.1.0
#inventories
Name Type Description Starting Version
slbGroupUuid String The slb group UUID. 5.1.0
configVersion Long The config version. 5.1.0
publicNetworkUuid String The public network UUID. 5.1.0
virtualRouterVips List The virtual router vips. 5.1.0
applianceVmType String The appliance VM instance type. 5.1.0
managementNetworkUuid String The management network UUID. 5.1.0
defaultRouteL3NetworkUuid String The default route L3 network UUID. 5.1.0
status String The resource status. 5.1.0
agentPort Integer The agent port. 5.1.0
haStatus String The HA status. 5.1.0
uuid String The resource UUID. 5.1.0
name String The resource name. 5.1.0
description String The detailed description of the resource. 5.1.0
zoneUuid String The zone UUID. 5.1.0
clusterUuid String The cluster UUID. 5.1.0
imageUuid String The image UUID. 5.1.0
hostUuid String The host UUID. 5.1.0
lastHostUuid String The last host UUID. 5.1.0
instanceOfferingUuid String The instance offering UUID. 5.1.0
rootVolumeUuid String The root volume UUID. 5.1.0
platform String The platform. 5.1.0
architecture String The architecture. 5.1.0
defaultL3NetworkUuid String The default L3 network UUID. 5.1.0
type String The resource type. 5.1.0
hypervisorType String The hypervisor type. 5.1.0
memorySize Long The memory size. 5.1.0
reservedMemorySize Long The reserved memory size. 5.1.0
cpuNum Integer The number of CPUs. 5.1.0
cpuSpeed The CPU speed. 5.1.0
allocatorStrategy Long The allocator strategy. 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
state String The resource state. 5.1.0
guestOsType String The guest OS type. 5.1.0
configTasks List See configTasks. 5.1.0
vmNics List See vmNics. 5.1.0
allVolumes List See allVolumes. 5.1.0
vmCdRoms List See vmCdRoms. 5.1.0
#configTasks
Name Type Description Starting Version
vmInstanceUuid String The VM instance UUID. 5.1.0
configVersion long The config version. 5.1.0
taskName String The task name. 5.1.0
taskData String The task data. 5.1.0
retryNumber long The number of retry. 5.1.0
lastFailedReason String The last failed reason. 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
status SlbVmInstanceConfigTaskStatus See status 5.1.0
#status
Name Type Description Starting Version
Pending SlbVmInstanceConfigTaskStatus The Pending value. 5.1.0
Starting SlbVmInstanceConfigTaskStatus The Starting value. 5.1.0
Success SlbVmInstanceConfigTaskStatus The Success value. 5.1.0
Failed SlbVmInstanceConfigTaskStatus The Failed value. 5.1.0
#vmNics
Name Type Description Starting Version
uuid String The resource UUID. 5.1.0
vmInstanceUuid String The VM instance UUID. 5.1.0
l3NetworkUuid String The L3 network UUID 5.1.0
ip String The IP address. 5.1.0
mac String The MAC address. 5.1.0
hypervisorType String The hypervisor type. 5.1.0
netmask String The netmask. 5.1.0
gateway String The gateway IP address. 5.1.0
metaData String The metadata. 5.1.0
ipVersion The IP version. 5.1.0
driverType String The driver type. 5.1.0
internalName String The internal name. 5.1.0
deviceId The device ID. 5.1.0
type String The resource type. 5.1.0
state String The vmNic state. 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
usedIps List See usedIps. 5.1.0
#usedIps
Name Type Description Starting Version
uuid String The resource UUID. 5.1.0
ipRangeUuid String The ip range UUID 5.1.0
l3NetworkUuid String The L3 network UUID. 5.1.0
ipVersion Integer The IP version. 5.1.0
ip String The IP address. 5.1.0
netmask String The netmask. 5.1.0
gateway String The gateway IP address. 5.1.0
usedFor String The intended use. 5.1.0
ipInLong long The IP address represented as a long integer. 5.1.0
vmNicUuid String The vmNic UUID. 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
#allVolumes
Name Type Description Starting Version
uuid String The resource UUID. 5.1.0
name String The resource name. 5.1.0
description String The detailed description of the resource. 5.1.0
primaryStorageUuid String The primary storage UUID. 5.1.0
vmInstanceUuid String The VM instance UUID. 5.1.0
diskOfferingUuid String The disk offering UUID. 5.1.0
rootImageUuid String The root image UUID. 5.1.0
installPath String The installation path. 5.1.0
type String The resource type. 5.1.0
format String The format. 5.1.0
size Long The size. 5.1.0
actualSize Long The actual size. 5.1.0
deviceId Integer The device ID. 5.1.0
state String The resource state. 5.1.0
status String The resource status. 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
isShareable Boolean Whether the resource is shareable. 5.1.0
volumeQos String The volume QoS. 5.1.0
lastDetachDate Timestamp The last detach date. 5.1.0
lastVmInstanceUuid String The last VM instance UUID. 5.1.0
#vmCdRoms
Name Type Description Starting Version
uuid String The resource UUID. 5.1.0
vmInstanceUuid String The VM instance UUID. 5.1.0
deviceId Integer The device ID. 5.1.0
isoUuid String The ISO UUID. 5.1.0
isoInstallPath String The ISO install path. 5.1.0
name String The resource name. 5.1.0
description String The detailed description of the resource. 5.1.0
createDate Timestamp The creation date. 5.1.0
lastOpDate Timestamp The last operation date. 5.1.0
#error
Name Type Description Starting Version
code String The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. 5.1.0
description String The brief description of the error. 5.1.0
details String The details about the error. 5.1.0
elaboration String The reserved field. Default value: null. 5.1.0
opaque LinkedHashMap The reserved field. Default value: null. 5.1.0
cause ErrorCode The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. 5.1.0

SDK Sample

Java SDK
QuerySlbVmInstanceAction action = new QuerySlbVmInstanceAction();
action.conditions = asList("uuid=f6fba7cb05293adc9afb013d01b7ad5b");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QuerySlbVmInstanceAction.Result res = action.call();
Python SDK
action = QuerySlbVmInstanceAction()
action.conditions = ["uuid=2c88152e016f37838064f644e2225968"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()
PreviousChangeSlbGroupMonitorIpsNextCreateCertificate
API Reference | 5.5.38 | ZStack Cloud · ZCF | ZStack Resource Center