跳转到主要内容
API Explorer|API Explorer
资源中心/弹性裸金属管理(Plus)
GETElastic Bare Metal Management(Plus)起始版本 4.0.0同步需要认证

查询弹性裸金属实例

查询弹性裸金属实例

调试可用性

在线调试

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

请求参数

此接口无需请求参数。

响应状态

200 OK

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

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoriesList必填

    详情参考inventories

    • chassisUuidString必填

      裸金属节点UUID

    • lastChassisUuidString必填

      上次所在裸金属节点UUID

    • gatewayUuidString必填

      裸金属网关节点UUID

    • lastGatewayUuidString必填

      上次所在裸金属网关节点UUID

    • chassisOfferingUuidString必填

      裸金属节点规格UUID

    • gatewayAllocatorStrategyString必填

      裸金属网关节点分配策略

    • statusString必填

      连接状态

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • zoneUuidString必填

      区域UUID

    • clusterUuidString必填

      集群UUID

    • imageUuidString必填

      镜像UUID

    • rootVolumeUuidString必填

      根云盘UUID

    • platformString必填

      平台类型

    • defaultL3NetworkUuidString必填

      默认网络UUID

    • typeString必填

      类型

    • hypervisorTypeString必填

      虚拟化类型

    • memorySizeLong必填

      内存容量

    • cpuNumInteger必填

      CPU核数

    • cpuSpeedLong必填

      CPU速率

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • stateString必填

      运行状态

    • provisionNicBareMetal2InstanceProvisionNicInventory必填

      详情参考provisionNic

      • uuidString必填

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

      • networkUuidString必填

        裸金属部署网络UUID

      • interfaceNameString必填

        网卡名称

      • ipString必填

        IP地址

      • netmaskString必填

        子网掩码

      • gatewayString必填

        网关地址

      • metadataString必填

        附加元数据。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

    • vmNicsList必填

      详情参考vmNics

      • uuidString必填

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

      • vmInstanceUuidString必填

        云主机UUID

      • l3NetworkUuidString必填

        三层网络UUID

      • ipString必填

        IP地址

      • macString必填

        MAC地址

      • hypervisorTypeString必填

        虚拟化类型

      • netmaskString必填

        子网掩码

      • gatewayString必填

        网关

      • metaDataString必填

        元数据。

      • ipVersionInteger必填

        IP地址版本

      • deviceIdInteger必填

        设备ID

      • typeString必填

        网卡类型

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

        云盘状态

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

      • isShareableBoolean必填

        是否共享云盘

      • volumeQosString必填

        云盘Qos，格式如total=1048576

请求地址

GET/zstack/v1/baremetal2/bm-instances

/zstack/v1/baremetal2/bm-instances

操作 ID

QueryBareMetal2Instance

永久链接

请求示例

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

响应示例

200
{ "inventories": [ { "chassisUuid": "463018b125d742e8acb3d6a5412eb674", "lastChassisUuid": "5facc3e540e3464daef9dc123aae9f2b", "gatewayUuid": "2cdd33f2d2f14b599965b2b351c77c10", "lastGatewayUuid": "e96b15632b2d4975ae4252a8d33b3904", "chassisOfferingUuid": "db5d18b6551e4af492bda6cef97045e3", "status": "Connected", "uuid": "f6898853cff24b2a85c388f4c676d1a7", "name": "BM-1", "description": "This is a BareMetal2 Instance.", "zoneUuid": "8f741ad043a54c98a9729c3871cfc985", "clusterUuid": "1bf322359f0e41668a67e119fc2184d1", "imageUuid": "17ddfe24cce247f2a27a13ad78b1536a", "rootVolumeUuid": "e1551175153c4d4f89edfccf85e15fbe", "platform": "Linux", "type": "baremetal2", "memorySize": 8.589934592E9, "cpuNum": 8.0, "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM", "state": "Running" } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史