QuerySlbVmInstance

GET/zstack/v1/load-balancers/slb/instances

GET/zstack/v1/load-balancers/slb/instances/{uuid}

Operation ID

QuerySlbVmInstance

Since

5.1.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Query Parameters

q
String
Query conditions.

Responses

200 OK

On success, this API returns the following response structure.

success
booleanRequired
Whether the operation succeeded.
inventories
ListRequired
See
- slbGroupUuid
  StringRequired
  The slb group UUID.
- configVersion
  LongRequired
  The config version.
- publicNetworkUuid
  StringRequired
  The public network UUID.
- virtualRouterVips
  ListRequired
  The virtual router vips.
- applianceVmType
  StringRequired
  The appliance VM instance type.
- managementNetworkUuid
  StringRequired
  The management network UUID.
- defaultRouteL3NetworkUuid
  StringRequired
  The default route L3 network UUID.
- status
  StringRequired
  The resource status.
  Pending
  SlbVmInstanceConfigTaskStatusRequired
  The Pending value.
  Starting
  SlbVmInstanceConfigTaskStatusRequired
  The Starting value.
  Success
  SlbVmInstanceConfigTaskStatusRequired
  The Success value.
  Failed
  SlbVmInstanceConfigTaskStatusRequired
  The Failed value.
- agentPort
  IntegerRequired
  The agent port.
- haStatus
  StringRequired
  The HA status.
- uuid
  StringRequired
  The resource UUID.
- name
  StringRequired
  The resource name.
- description
  StringRequired
  The detailed description of the resource.
- zoneUuid
  StringRequired
  The zone UUID.
- clusterUuid
  StringRequired
  The cluster UUID.
- imageUuid
  StringRequired
  The image UUID.
- hostUuid
  StringRequired
  The host UUID.
- lastHostUuid
  StringRequired
  The last host UUID.
- instanceOfferingUuid
  StringRequired
  The instance offering UUID.
- rootVolumeUuid
  StringRequired
  The root volume UUID.
- platform
  StringRequired
  The platform.
- architecture
  StringRequired
  The architecture.
- defaultL3NetworkUuid
  StringRequired
  The default L3 network UUID.
- type
  StringRequired
  The resource type.
- hypervisorType
  StringRequired
  The hypervisor type.
- memorySize
  LongRequired
  The memory size.
- reservedMemorySize
  LongRequired
  The reserved memory size.
- cpuNum
  IntegerRequired
  The number of CPUs.
- cpuSpeed
  StringRequired
  The CPU speed.
- allocatorStrategy
  LongRequired
  The allocator strategy.
- createDate
  TimestampRequired
  The creation date.
- lastOpDate
  TimestampRequired
  The last operation date.
- state
  StringRequired
  The resource state.
- guestOsType
  StringRequired
  The guest OS type.
- configTasks
  ListRequired
  See configTasks.
  vmInstanceUuid
  StringRequired
  The VM instance UUID.
  configVersion
  longRequired
  The config version.
  taskName
  StringRequired
  The task name.
  taskData
  StringRequired
  The task data.
  retryNumber
  longRequired
  The number of retry.
  lastFailedReason
  StringRequired
  The last failed reason.
  createDate
  TimestampRequired
  The creation date.
  lastOpDate
  TimestampRequired
  The last operation date.
  status
  SlbVmInstanceConfigTaskStatusRequired
  See status
  Pending
  SlbVmInstanceConfigTaskStatusRequired
  The Pending value.
  Starting
  SlbVmInstanceConfigTaskStatusRequired
  The Starting value.
  Success
  SlbVmInstanceConfigTaskStatusRequired
  The Success value.
  Failed
  SlbVmInstanceConfigTaskStatusRequired
  The Failed value.
- vmNics
  ListRequired
  See vmNics.
  uuid
  StringRequired
  The resource UUID.
  vmInstanceUuid
  StringRequired
  The VM instance UUID.
  l3NetworkUuid
  StringRequired
  The L3 network UUID
  ip
  StringRequired
  The IP address.
  mac
  StringRequired
  The MAC address.
  hypervisorType
  StringRequired
  The hypervisor type.
  netmask
  StringRequired
  The netmask.
  gateway
  StringRequired
  The gateway IP address.
  metaData
  StringRequired
  The metadata.
  ipVersion
  StringRequired
  The IP version.
  driverType
  StringRequired
  The driver type.
  internalName
  StringRequired
  The internal name.
  deviceId
  StringRequired
  The device ID.
  type
  StringRequired
  The resource type.
  state
  StringRequired
  The vmNic state.
  createDate
  TimestampRequired
  The creation date.
  lastOpDate
  TimestampRequired
  The last operation date.
  usedIps
  ListRequired
  See usedIps.
  uuid
  StringRequired
  The resource UUID.
  ipRangeUuid
  StringRequired
  The ip range UUID
  l3NetworkUuid
  StringRequired
  The L3 network UUID.
  ipVersion
  IntegerRequired
  The IP version.
  ip
  StringRequired
  The IP address.
  netmask
  StringRequired
  The netmask.
  gateway
  StringRequired
  The gateway IP address.
  usedFor
  StringRequired
  The intended use.
  ipInLong
  longRequired
  The IP address represented as a long integer.
  vmNicUuid
  StringRequired
  The vmNic UUID.
  createDate
  TimestampRequired
  The creation date.
  lastOpDate
  TimestampRequired
  The last operation date.
- allVolumes
  ListRequired
  See allVolumes.
  uuid
  StringRequired
  The resource UUID.
  name
  StringRequired
  The resource name.
  description
  StringRequired
  The detailed description of the resource.
  primaryStorageUuid
  StringRequired
  The primary storage UUID.
  vmInstanceUuid
  StringRequired
  The VM instance UUID.
  diskOfferingUuid
  StringRequired
  The disk offering UUID.
  rootImageUuid
  StringRequired
  The root image UUID.
  installPath
  StringRequired
  The installation path.
  type
  StringRequired
  The resource type.
  format
  StringRequired
  The format.
  size
  LongRequired
  The size.
  actualSize
  LongRequired
  The actual size.
  deviceId
  IntegerRequired
  The device ID.
  state
  StringRequired
  The resource state.
  status
  StringRequired
  The resource status.
  Pending
  SlbVmInstanceConfigTaskStatusRequired
  The Pending value.
  Starting
  SlbVmInstanceConfigTaskStatusRequired
  The Starting value.
  Success
  SlbVmInstanceConfigTaskStatusRequired
  The Success value.
  Failed
  SlbVmInstanceConfigTaskStatusRequired
  The Failed value.
  createDate
  TimestampRequired
  The creation date.
  lastOpDate
  TimestampRequired
  The last operation date.
  isShareable
  BooleanRequired
  Whether the resource is shareable.
  volumeQos
  StringRequired
  The volume QoS.
  lastDetachDate
  TimestampRequired
  The last detach date.
  lastVmInstanceUuid
  StringRequired
  The last VM instance UUID.
- vmCdRoms
  ListRequired
  See vmCdRoms.
  uuid
  StringRequired
  The resource UUID.
  vmInstanceUuid
  StringRequired
  The VM instance UUID.
  deviceId
  IntegerRequired
  The device ID.
  isoUuid
  StringRequired
  The ISO UUID.
  isoInstallPath
  StringRequired
  The ISO install path.
  name
  StringRequired
  The resource name.
  description
  StringRequired
  The detailed description of the resource.
  createDate
  TimestampRequired
  The creation date.
  lastOpDate
  TimestampRequired
  The last operation date.
error
ErrorCodeRequired
The error code. If not null, the operation fails, or vice versa. For more information, see error.
- code
  StringRequired
  The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.
- description
  StringRequired
  The brief description of the error.
- details
  StringRequired
  The details about the error.
- elaboration
  StringRequired
  The reserved field. Default value: null.
- opaque
  LinkedHashMapRequired
  The reserved field. Default value: null.
- cause
  ErrorCodeRequired
  The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

Request Example

curl -X GET '{host}/zstack/v1/load-balancers/slb/instances?q={q}' \
  -H 'Authorization: Bearer {token}'

Response Example

{
  "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"
        }
      ]
    }
  ]
}

VM Instance Operations

Volume Operations

Image Operations

Affinity Group Operations

VM Scheduling Rule Group Operations

Instance Offering Operations

Disk Offering Operations

Auto-Scaling Group Operations

Snapshot Group Operations

SSH Key Operations

Zone Operations

Cluster Operations

Host Operations

GPU Device Operations

Primary Storage Operations

Backup Storage Operations

SAN Storage Operations

Physical Network Operations

PCI Device Operations

USB Redirection Operations

USB Pass-through Operations

SR-IOV Operations

Loongarch SE Operations

Hygon SE Operations

Local Storage Operations

NFS Primary Storage Operations

Shared Mount Point Primary Storage Operations

Ceph Primary Storage Operations

Shared Block Primary Storage Operations

XStor Block Primary Storage Operations

ImageStore Backup Storage Operations

Ceph Backup Storage Operations

iSCSI Server Operations

FC Storage Operations

NVMe Storage Operations

Hardware SDN Controller Operations

L2 Network Operations

L3 Network Operations

Route Resource Operations

VPC Operations

OSPF Operations

Multicast Routing Operations

Policy Routing Operations

vRouter Route Table Operations

Network Service Operations

VPC Firewall Operations

Security Group Operations

VIP Operations

EIP Operations

Port Forwarding Operations

Load Balancing Operations

IPsec Operations

NetFlow APIs

Port Mirroring APIs

Shared Bandwidth Operations

Network Security Policy Schedule Operations

CloudFormation Operations

Bare Metal Management Operations

Installation Service Operations

Elastic Bare Metal Management(Plus)

vCenter Operations

Capacity Management Operations

SNS Operations

Metric Operations

Event Operations

Alarm Operations

Event Subscription Operations

Text Template Operations

Audit Operations

CBT Operations

Backup Service Operations

CDP Operations

Script Library

XML Hook

Job Scheduling APIs

Tag Operations

Migration Service Operations

Organization Operations

Project Operations

Ticket Operations