跳转到主要内容
API Explorer|API Explorer
系统全局相关/查询可用资源相关接口
GETAvailable Resource Query起始版本 0.6同步需要认证

获取CPU和内存容量

获取CPU和内存容量

调试可用性

在线调试

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

查询参数

请求参数

查询参数

  • zoneUuidsList

    数据中心的UUID

  • clusterUuidsList

    集群的UUID。用于挂载网络、存储等

  • hostUuidsList

    主机的UUID。用于添加、删除host等

  • allboolean

    all默认为false，此时数据中心UUID，集群UUID,主机UUID必须有一个不为空，或者全部都填写 all设置为true时，数据中心UUID、集群UUID、主机UUID均可不填

  • hypervisorTypeString

    暂无描述。

响应状态

200 OK

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

  • totalCpulong必填

    cpu总数

  • availableCpulong必填

    可用cpu数量

  • totalMemorylong必填

    内存总量

  • availableMemorylong必填

    可用内存

  • managedCpuNumlong必填

    受管理的物理CPU数量

  • resourceTypeString必填

    所查资源的类型（主机、集群、数据中心）

  • successboolean必填

    成功

  • errorErrorCode必填

    详情参考error

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • capacityDataList必填

    详情参考capacityData

    • resourceUuidString必填

      资源UUID

    • totalCpulong必填

      CPU总数

    • availableCpulong必填

      可用CPU数量

    • totalMemorylong必填

      内存总量

    • availableMemorylong必填

      可用内存

    • managedCpuNumlong必填

      受管理的物理CPU数量

  • errorErrorCode必填

    详情参考error

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

请求地址

GET/zstack/v1/hosts/capacities/cpu-memory

/zstack/v1/hosts/capacities/cpu-memory

操作 ID

GetCpuMemoryCapacity

永久链接

请求示例

curl -X GET 'http://{host}/zstack/v1/hosts/capacities/cpu-memory?zoneUuids=<zoneUuids>&clusterUuids=<clusterUuids>&hostUuids=<hostUuids>&all=True&hypervisorType=<hypervisorType>&systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

响应示例

200
{ "totalCpu": 4.0, "availableCpu": 2.0, "totalMemory": 8.0, "availableMemory": 4.0, "managedCpuNum": 4.0, "capacityData": [ { "resourceUuid": "db558260b0b53e36aa8ebf7e40c7c9c6", "totalCpu": 4.0, "availableCpu": 2.0, "totalMemory": 8.0, "availableMemory": 4.0, "managedCpuNum": 4.0 } ], "resourceType": "HostVO" }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史