跳转到主要内容
API Explorer|API Explorer
计算管理/虚拟机相关接口
GETVM Related Interfaces起始版本 0.6同步需要认证

获取目的地列表

获取目的地列表

调试可用性

在线调试

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

查询参数

请求参数

查询参数

  • instanceOfferingUuidString

    计算规格UUID

  • imageUuidString必填

    镜像UUID

  • l3NetworkUuidsList必填

    分布式端口组列表

  • rootDiskOfferingUuidString

    根硬盘规格。仅在imageUuid指定的镜像是ISO时需要指定

  • dataDiskOfferingUuidsList

    硬盘规格列表

响应状态

200 OK

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

  • successboolean必填

    操作是否成功

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • zonesList必填

    详情参考zones

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • stateString必填

      当前状态。

    • typeString必填

      类型。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

  • clustersList必填

    详情参考clusters

    • nameString必填

      资源名称

    • uuidString必填

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

    • descriptionString必填

      资源的详细描述

    • stateString必填

      集群状态

    • hypervisorTypeString必填

      虚拟机管理程序类型

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • zoneUuidString必填

      数据中心UUID

    • typeString必填

      保留域

  • hostsList必填

    详情参考hosts

    • zoneUuidString必填

      数据中心UUID

    • nameString必填

      资源名称

    • uuidString必填

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

    • clusterUuidString必填

      集群UUID

    • descriptionString必填

      资源的详细描述

    • managementIpString必填

      管理IP。

    • hypervisorTypeString必填

      暂无描述。

    • stateString必填

      当前状态。

    • statusString必填

      状态信息。

    • totalCpuCapacityLong必填

      总CPU容量。

    • availableCpuCapacityLong必填

      可用CPU容量。

    • cpuSocketsInteger必填

      物理CPU插槽数量

    • totalMemoryCapacityLong必填

      总内存容量。

    • availableMemoryCapacityLong必填

      可用内存容量。

    • cpuNumInteger必填

      逻辑CPU数量

    • ipmiAddressString必填

      IPMI地址

    • ipmiUsernameString必填

      IPMI用户名

    • ipmiPortInteger必填

      IPMI端口

    • ipmiPowerStatusString必填

      IPMI电源状态

    • architectureString必填

      暂无描述。

    • nqnString必填

      NVMe 限定名称

    • hostnameString必填

      主机名

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • cpuStatusHwMonitorStatus必填

      详情参考cpuStatus

      • NormalHwMonitorStatus必填

        正常

      • ErrorHwMonitorStatus必填

        异常

      • UnknownHwMonitorStatus必填

        未知

    • memoryStatusHwMonitorStatus必填

      详情参考memoryStatus

      • NormalHwMonitorStatus必填

        正常

      • ErrorHwMonitorStatus必填

        异常

      • UnknownHwMonitorStatus必填

        未知

    • diskStatusHwMonitorStatus必填

      详情参考diskStatus

      • NormalHwMonitorStatus必填

        正常

      • ErrorHwMonitorStatus必填

        异常

      • UnknownHwMonitorStatus必填

        未知

    • nicStatusHwMonitorStatus必填

      详情参考nicStatus

      • NormalHwMonitorStatus必填

        正常

      • ErrorHwMonitorStatus必填

        异常

      • UnknownHwMonitorStatus必填

        未知

    • gpuStatusHwMonitorStatus必填

      详情参考gpuStatus

      • NormalHwMonitorStatus必填

        正常

      • ErrorHwMonitorStatus必填

        异常

      • UnknownHwMonitorStatus必填

        未知

    • powerSupplyStatusHwMonitorStatus必填

      详情参考powerSupplyStatus

      • NormalHwMonitorStatus必填

        正常

      • ErrorHwMonitorStatus必填

        异常

      • UnknownHwMonitorStatus必填

        未知

    • fanStatusHwMonitorStatus必填

      详情参考fanStatus

      • NormalHwMonitorStatus必填

        正常

      • ErrorHwMonitorStatus必填

        异常

      • UnknownHwMonitorStatus必填

        未知

    • raidStatusHwMonitorStatus必填

      详情参考raidStatus

      • NormalHwMonitorStatus必填

        正常

      • ErrorHwMonitorStatus必填

        异常

      • UnknownHwMonitorStatus必填

        未知

    • temperatureStatusHwMonitorStatus必填

      详情参考temperatureStatus

      • NormalHwMonitorStatus必填

        正常

      • ErrorHwMonitorStatus必填

        异常

      • UnknownHwMonitorStatus必填

        未知

请求地址

GET/zstack/v1/vm-instances/candidate-destinations

/zstack/v1/vm-instances/candidate-destinations

操作 ID

GetCandidateZonesClustersHostsForCreatingVm

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/vm-instances/candidate-destinations?instanceOfferingUuid=<instanceOfferingUuid>&imageUuid=<imageUuid>&l3NetworkUuids=<l3NetworkUuids>&rootDiskOfferingUuid=<rootDiskOfferingUuid>&dataDiskOfferingUuids=<dataDiskOfferingUuids>&zoneUuid=<zoneUuid>&clusterUuid=<clusterUuid>&defaultL3NetworkUuid=<defaultL3NetworkUuid>&cpuNum=1&memorySize=1&systemTags=<systemTags>&userTags=<userTags>&rootDiskSize=1' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "zones": [ { "uuid": "88a4f663c5c63a80b74cb8d1bf54a5a5", "name": "zone", "isDefault": false } ], "clusters": [ { "name": "cluster1", "uuid": "779ab0160e9734f8b2de0f75612f794f", "hypervisorType": "KVM", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM", "zoneUuid": "cb1001af731e3500a07269049e695eaa" } ], "hosts": [ { "zoneUuid": "88a4f663c5c63a80b74cb8d1bf54a5a5", "name": "example", "uuid": "dee308ca7bf931edbc1adc31735cd9c8", "clusterUuid": "0ea74049ad863b3185465ca2e9b7ae06", "description": "example", "managementIp": "192.168.0.1", "hypervisorType": "KVM", "state": "Enabled", "status": "Connected", "totalCpuCapacity": 4, "availableCpuCapacity": 2, "totalMemoryCapacity": 4, "availableMemoryCapacity": 4, "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史