跳转到主要内容
API Explorer|API Explorer
裸金属管理/裸金属主机相关接口
GETBare Metal Instance Related Interfaces起始版本 0.6同步需要认证

查询裸金属主机

查询裸金属主机

调试可用性

在线调试

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

请求参数

此接口无需请求参数。

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

  • inventoriesList必填

    详情参考inventories

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • zoneUuidString必填

      数据中心UUID

    • clusterUuidString必填

      集群UUID

    • pxeServerUuidString必填

      暂无描述。

    • chassisUuidString必填

      裸机设备UUID

    • imageUuidString必填

      镜像UUID

    • platformString必填

      系统平台

    • stateString必填

      当前状态。

    • statusString必填

      状态信息。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • bmNicsList必填

      详情参考bmNics

      • uuidString必填

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

      • baremetalInstanceUuidString必填

        裸机实例UUID

      • l3NetworkUuidString必填

        分布式端口组UUID

      • baremetalBondingUuidString必填

        暂无描述。

      • macString必填

        网卡MAC

      • ipString必填

        IP地址

      • netmaskString必填

        子网掩码

      • gatewayString必填

        网关

      • metadataString必填

        附加元数据。

      • pxeBoolean必填

        是否PXE启动网卡

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

GET/zstack/v1/baremetal/instances

/zstack/v1/baremetal/instances

操作 ID

QueryBaremetalInstance

永久链接

请求示例

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

响应示例

200
{ "inventories": [ { "uuid": "9d3a2dd0d48c3220a40a66a33874f25a", "name": "BM-1", "description": "This is a baremetal instance.", "zoneUuid": "4d1bf4f2ab113292808be87ad9ff553b", "clusterUuid": "e24ee969ccc83aa287713ec2dca4e8e0", "chassisUuid": "da16af4bb6c43b8fba2b5ba918e0cdbb", "imageUuid": "70ff9f3ae5863fcfab60999afdf55219", "platform": "Linux", "state": "Running", "status": "Provisioned", "createDate": "Nov 14, 2017 2:20:57 PM", "lastOpDate": "Nov 14, 2017 2:20:57 PM", "bmNics": [ { "uuid": "8fb718abb0bd3ce99215d446cd6dba1d", "baremetalInstanceUuid": "9d3a2dd0d48c3220a40a66a33874f25a", "l3NetworkUuid": "8b40c2c7a19e3c96b4bca63b56909898", "mac": "6c:b3:11:1b:0b:1e", "ip": "192.168.0.10", "netmask": "255.255.255.0", "gateway": "192.168.0.1", "pxe": false } ] } ] }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史