更新物理机IPMI信息(UpdateHostIpmi)
API请求
URLs
PUT zstack/v1/hosts/ipmi/{uuid}/actionsHeaders
Authorization: OAuth the-session-uuidBody
{
"updateHostIpmi": {
"ipmiAddress": "127.0.0.10",
"ipmiUsername": "admin",
"ipmiPassword": "password",
"ipmiPort": 623
},
"systemTags": [],
"userTags": []
}Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \-X PUT -d '{"updateHostIpmi":{"ipmiAddress":"127.0.0.10","ipmiUsername":"admin","ipmiPassword":"password","ipmiPort":623}}' \
http://localhost:8080/zstack/v1/hosts/ipmi/6cbd75f1a7cb3805b47a8dca8871c1c6/actions参数列表
| 名字 | 类型 | 位置 | 描述 | 可选值 | 起始版本 |
|---|---|---|---|---|---|
| uuid | String | url | 资源的UUID，唯一标示该资源 | 4.7.0 | |
| ipmiAddress (可选) | String | body(包含在updateHostIpmi结构中) | IPMI地址 | 4.7.0 | |
| ipmiUsername (可选) | String | body(包含在updateHostIpmi结构中) | IPMI用户名 | 4.7.0 | |
| ipmiPassword (可选) | String | body(包含在updateHostIpmi结构中) | IPMI密码 | 4.7.0 | |
| ipmiPort (可选) | int | body(包含在updateHostIpmi结构中) | IPMI端口 | 4.7.0 | |
| systemTags (可选) | List | body | 系统标签 | 4.7.0 | |
| userTags (可选) | List | body | 用户标签 | 4.7.0 |
API返回
返回示例
{
"hostIpmiInventory": {
"ipmiAddress": "192.168.0.1",
"ipmiUsername": "admin",
"ipmiPort": 623,
"ipmiPassword": "password"
}
}| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| success | boolean | 4.7.0 | |
| hostIpmiInventory | HostIpmiInventory | 详情参考hostIpmiInventory | 4.7.0 |
| error | ErrorCode | 错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error | 4.7.0 |
#hostIpmiInventory
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID，唯一标示该资源 | 4.7.0 |
| ipmiAddress | String | IPMI地址 | 4.7.0 |
| ipmiUsername | String | IPMI用户名 | 4.7.0 |
| ipmiPort | int | IPMI端口 | 4.7.0 |
| ipmiPowerStatus | String | IPMI电源状态 | 4.7.0 |
#error
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| code | String | 错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001 | 4.7.0 |
| description | String | 错误的概要描述 | 4.7.0 |
| details | String | 错误的详细信息 | 4.7.0 |
| elaboration | String | 保留字段，默认为null | 4.7.0 |
| opaque | LinkedHashMap | 保留字段，默认为null | 4.7.0 |
| cause | ErrorCode | 根错误，引发当前错误的源错误，若无原错误，该字段为null | 4.7.0 |
SDK示例
Java
SDK
UpdateHostIpmiAction action = new UpdateHostIpmiAction();
action.uuid = "6cbd75f1a7cb3805b47a8dca8871c1c6";
action.ipmiAddress = "127.0.0.10";
action.ipmiUsername = "admin";
action.ipmiPassword = "password";
action.ipmiPort = 623;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateHostIpmiAction.Result res = action.call();Python
SDK
UpdateHostIpmiAction action = UpdateHostIpmiAction()
action.uuid = "6cbd75f1a7cb3805b47a8dca8871c1c6"
action.ipmiAddress = "127.0.0.10"
action.ipmiUsername = "admin"
action.ipmiPassword = "password"
action.ipmiPort = 623
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateHostIpmiAction.Result res = action.call()