跳转到主要内容
API Explorer|API Explorer
资源中心/硬件设施/物理机相关接口
PUTHost Operations起始版本 4.7.0同步需要认证

获取物理机最新电源状态

获取物理机最新电源状态

调试可用性

在线调试

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

路径参数

请求参数

路径参数

  • uuidString必填

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

请求体字段

  • gethostpowerstatusObject必填

    gethostpowerstatus 请求体结构

    • methodString

      获取物理机电源状态方式

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successString必填

    操作是否成功。

  • inventoryString必填

    详情参考inventory

    • uuidString必填

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

    • ipmiAddressString必填

      IPMI地址

    • ipmiUsernameString必填

      IPMI用户名

    • ipmiPortint必填

      IPMI端口

    • ipmiPowerStatusString必填

      IPMI电源状态

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

请求地址

PUT/zstack/v1/hosts/power/{uuid}/actions

/zstack/v1/hosts/power/{uuid}/actions

操作 ID

GetHostPowerStatus

永久链接

请求示例

curl -X PUT 'http://{host}/zstack/v1/hosts/power/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"gethostpowerstatus":{"method":"<method>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "ipmiAddress": "192.168.0.1", "ipmiUsername": "admin", "ipmiPort": 623, "ipmiPassword": "password", "ipmiPowerStatus": "POWER_ON" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史