跳转到主要内容
API Explorer|API Explorer
资源中心/网络资源/路由资源相关接口
GETRoute Resource Operations起始版本 0.6同步需要认证

查询服务云主机

查询服务云主机

调试可用性

在线调试

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

请求参数

此接口无需请求参数。

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoriesList必填

    详情参考inventories

    • applianceVmTypeString必填

      设备云主机类型。

    • managementNetworkUuidString必填

      暂无描述。

    • defaultRouteL3NetworkUuidString必填

      暂无描述。

    • statusString必填

      状态信息。

    • agentPortInteger必填

      代理端口。

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • zoneUuidString必填

      区域UUID

    • clusterUuidString必填

      集群UUID

    • imageUuidString必填

      镜像UUID

    • hostUuidString必填

      物理机UUID

    • lastHostUuidString必填

      最近一次主机UUID。

    • instanceOfferingUuidString必填

      计算规格UUID

    • rootVolumeUuidString必填

      根云盘UUID

    • platformString必填

      平台。

    • defaultL3NetworkUuidString必填

      暂无描述。

    • typeString必填

      类型。

    • hypervisorTypeString必填

      暂无描述。

    • memorySizeLong必填

      内存大小。

    • cpuNumInteger必填

      暂无描述。

    • cpuSpeedLong必填

      暂无描述。

    • allocatorStrategyString必填

      暂无描述。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • stateString必填

      当前状态。

    • vmNicsList必填

      详情参考vmNics

      • uuidString必填

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

      • vmInstanceUuidString必填

        云主机UUID

      • l3NetworkUuidString必填

        三层网络UUID

      • ipString必填

        来源IP地址。

      • macString必填

        暂无描述。

      • netmaskString必填

        暂无描述。

      • gatewayString必填

        暂无描述。

      • metaDataString必填

        元数据。

      • deviceIdInteger必填

        设备ID。

      • 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必填

        状态信息。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

      • isShareableBoolean必填

        是否可分享。

请求地址

GET/zstack/v1/vm-instances/appliances

/zstack/v1/vm-instances/appliances

操作 ID

QueryApplianceVm

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/vm-instances/appliances' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "inventories": [ { "uuid": "f71a399a79794ab8a41e26a601ac7387", "name": "Test-VM", "description": "Appliance VM", "zoneUuid": "4cf173a14e67440c9349c1e236a56c37", "clusterUuid": "07412e72791c474fa240b75da1b210c5", "imageUuid": "7bc33ed9760f424a9b9ff21fc0bbb48e", "hostUuid": "0cbed62c52bc407e994c966f246363bd", "lastHostUuid": "08921382c4f44705bae7cba6414c811d", "instanceOfferingUuid": "e056c84995cb4d68ac78dbcc30af3f4f", "rootVolumeUuid": "2557a6f997ee457fad526e179a76e8c0", "platform": "Linux", "defaultL3NetworkUuid": "748fc87b7fcb456cbea47432e52b377d", "type": "UserVm", "hypervisorType": "KVM", "memorySize": 8.589934592E9, "cpuNum": 1.0, "allocatorStrategy": "LastHostPreferredAllocatorStrategy", "createDate": "Jun 7, 2017 9:20:39 PM", "lastOpDate": "Jun 7, 2017 9:20:39 PM", "state": "Running", "vmNics": [ { "uuid": "d2dfc67ddf28431bb64cc90fe0e113f6", "vmInstanceUuid": "f71a399a79794ab8a41e26a601ac7387", "usedIpUuid": "f654374b78534f5fb9b75873084932a3", "l3NetworkUuid": "748fc87b7fcb456cbea47432e52b377d", "ip": "192.168.1.10", "mac": "00:0c:29:bd:99:fc", "netmask": "255.255.255.0", "gateway": "192.168.1.1", "deviceId": 0.0, "createDate": "Jun 7, 2017 9:20:39 PM", "lastOpDate": "Jun 7, 2017 9:20:39 PM" } ], "allVolumes": [ { "uuid": "2557a6f997ee457fad526e179a76e8c0", "name": "Root-Volume-For-VM-f71a399a79794ab8a41e26a601ac7387", "primaryStorageUuid": "d00057b39df9494bbaf00d047dd04825", "vmInstanceUuid": "f71a399a79794ab8a41e26a601ac7387", "diskOfferingUuid": "20346d1b6643492fbc4da8d6baf4b6d2", "rootImageUuid": "7bc33ed9760f424a9b9ff21fc0bbb48e", "installPath": "/Cloud_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-2557a6f997ee457fad526e179a76e8c0/2557a6f997ee457fad526e179a76e8c0.qcow2", "type": "Root", "format": "qcow2", "size": 1.073741824E11, "actualSize": 2.147483648E10, "deviceId": 0.0, "state": "Enabled", "status": "Ready", "createDate": "Jun 7, 2017 9:20:39 PM", "lastOpDate": "Jun 7, 2017 9:20:39 PM" } ] } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史