跳转到主要内容
API Explorer|API Explorer
资源中心/网络服务/网络服务相关接口/负载均衡相关接口
GETLoad Balancing Operations起始版本 5.1.0同步需要认证

查询SLB实例

查询SLB实例

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

此接口无需请求参数。

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    操作是否成功。

  • inventoriesList必填

    详情参考inventories

    • slbGroupUuidString必填

      暂无描述。

    • configVersionLong必填

      配置版本。

    • publicNetworkUuidString必填

      暂无描述。

    • virtualRouterVipsList必填

      暂无描述。

    • applianceVmTypeString必填

      设备云主机类型。

    • managementNetworkUuidString必填

      暂无描述。

    • defaultRouteL3NetworkUuidString必填

      暂无描述。

    • statusString必填

      状态信息。

      • PendingSlbVmInstanceConfigTaskStatus必填

        待处理。

      • StartingSlbVmInstanceConfigTaskStatus必填

        启动中。

      • SuccessSlbVmInstanceConfigTaskStatus必填

        成功。

      • FailedSlbVmInstanceConfigTaskStatus必填

        失败。

    • agentPortInteger必填

      代理端口。

    • haStatusString必填

      HA状态。

    • uuidString必填

      资源的UUID，唯一标示该资源

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • zoneUuidString必填

      区域UUID

    • clusterUuidString必填

      集群UUID

    • imageUuidString必填

      镜像UUID

    • hostUuidString必填

      物理机UUID

    • lastHostUuidString必填

      最近一次主机UUID。

    • instanceOfferingUuidString必填

      计算规格UUID

    • rootVolumeUuidString必填

      根云盘UUID

    • platformString必填

      平台。

    • architectureString必填

      暂无描述。

    • defaultL3NetworkUuidString必填

      暂无描述。

    • typeString必填

      类型。

    • hypervisorTypeString必填

      暂无描述。

    • memorySizeLong必填

      内存大小。

    • reservedMemorySizeLong必填

      已预留内存大小。

    • cpuNumInteger必填

      暂无描述。

    • cpuSpeedString必填

      暂无描述。

    • allocatorStrategyLong必填

      暂无描述。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • stateString必填

      当前状态。

    • guestOsTypeString必填

      暂无描述。

    • configTasksList必填

      详情参考configTasks

      • vmInstanceUuidString必填

        云主机UUID

      • configVersionlong必填

        配置版本。

      • taskNameString必填

        任务名称。

      • taskDataString必填

        任务数据。

      • retryNumberlong必填

        重试数量。

      • lastFailedReasonString必填

        最近一次失败原因。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

      • statusSlbVmInstanceConfigTaskStatus必填

        详情参考status

        • PendingSlbVmInstanceConfigTaskStatus必填

          待处理。

        • StartingSlbVmInstanceConfigTaskStatus必填

          启动中。

        • SuccessSlbVmInstanceConfigTaskStatus必填

          成功。

        • FailedSlbVmInstanceConfigTaskStatus必填

          失败。

    • vmNicsList必填

      详情参考vmNics

      • uuidString必填

        资源的UUID，唯一标示该资源

      • vmInstanceUuidString必填

        云主机UUID

      • l3NetworkUuidString必填

        三层网络UUID

      • ipString必填

        来源IP地址。

      • macString必填

        暂无描述。

      • hypervisorTypeString必填

        暂无描述。

      • netmaskString必填

        暂无描述。

      • gatewayString必填

        暂无描述。

      • metaDataString必填

        元数据。

      • ipVersionString必填

        IP版本。

      • driverTypeString必填

        暂无描述。

      • internalNameString必填

        内部名称。

      • deviceIdString必填

        设备ID。

      • typeString必填

        类型。

      • stateString必填

        网卡状态

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

      • usedIpsList必填

        详情参考usedIps

        • uuidString必填

          资源的UUID，唯一标示该资源

        • ipRangeUuidString必填

          IP段UUID

        • l3NetworkUuidString必填

          三层网络UUID

        • ipVersionInteger必填

          IP版本。

        • ipString必填

          来源IP地址。

        • netmaskString必填

          暂无描述。

        • gatewayString必填

          暂无描述。

        • usedForString必填

          已使用用于。

        • ipInLonglong必填

          暂无描述。

        • vmNicUuidString必填

          云主机网卡UUID

        • createDateTimestamp必填

          创建时间

        • lastOpDateTimestamp必填

          最后一次修改时间

    • allVolumesList必填

      详情参考allVolumes

      • uuidString必填

        资源的UUID，唯一标示该资源

      • nameString必填

        资源名称

      • descriptionString必填

        资源的详细描述

      • primaryStorageUuidString必填

        主存储UUID

      • vmInstanceUuidString必填

        云主机UUID

      • diskOfferingUuidString必填

        云盘规格UUID

      • rootImageUuidString必填

        根镜像UUID。

      • installPathString必填

        安装路径。

      • typeString必填

        类型。

      • formatString必填

        数据格式或导出格式。

      • sizeLong必填

        返回记录数。

      • actualSizeLong必填

        实际大小。

      • deviceIdInteger必填

        设备ID。

      • stateString必填

        当前状态。

      • statusString必填

        状态信息。

        • PendingSlbVmInstanceConfigTaskStatus必填

          待处理。

        • StartingSlbVmInstanceConfigTaskStatus必填

          启动中。

        • SuccessSlbVmInstanceConfigTaskStatus必填

          成功。

        • FailedSlbVmInstanceConfigTaskStatus必填

          失败。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

      • isShareableBoolean必填

        是否可分享。

      • volumeQosString必填

        暂无描述。

      • lastDetachDateTimestamp必填

        最近一次detach时间。

      • lastVmInstanceUuidString必填

        最近一次云主机实例UUID。

    • vmCdRomsList必填

      详情参考vmCdRoms

      • uuidString必填

        资源的UUID，唯一标示该资源

      • vmInstanceUuidString必填

        云主机UUID

      • deviceIdInteger必填

        设备ID。

      • isoUuidString必填

        暂无描述。

      • isoInstallPathString必填

        iso安装路径。

      • nameString必填

        资源名称

      • descriptionString必填

        资源的详细描述

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

请求地址

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

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

操作 ID

QuerySlbVmInstance

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/load-balancers/slb/instances' -H 'Authorization: OAuth {sessionUuid}'

响应示例

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

变更历史

此 API 暂无变更历史记录。

查看全部变更历史