使用IPMI地址范围批量添加裸金属节点(BatchAddBareMetal2IpmiChassis)
API请求
URLs
POST zstack/v1/baremetal2/chassis/ipmi/from-fileHeaders
Authorization: OAuth the-session-uuidBody
{
"params": {
"chassisInfo": "FILE CONTENT ENCODE BY BASE64"
},
"systemTags": [],
"userTags": []
}Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"chassisInfo":"FILE CONTENT ENCODE BY BASE64"}}' http://localhost:8080/zstack/v1/baremetal2/chassis/ipmi/from-file参数列表
| 名字 | 类型 | 位置 | 描述 | 可选值 | 起始版本 |
|---|---|---|---|---|---|
| chassisInfo | String | body(包含在params结构中) | 经过base64编码的裸金属节点IPMI信息 | 4.0.0 | |
| longJobName (可选) | String | body(包含在params结构中) | 长任务名称 | 4.0.0 | |
| longJobDescription (可选) | String | body(包含在params结构中) | 长任务简介 | 4.0.0 | |
| resourceUuid (可选) | String | body(包含在params结构中) | 资源UUID | 4.0.0 | |
| tagUuids (可选) | List | body(包含在params结构中) | 标签UUID列表 | 4.0.0 | |
| systemTags (可选) | List | body | 系统标签 | 4.0.0 | |
| userTags (可选) | List | body | 用户标签 | 4.0.0 |
API返回
返回示例
{
"inventory": {
"uuid": "1a3e5b9ece0738f5b1ca785271dd7b34",
"name": "APIBatchAddBareMetal2ChassisEvent",
"apiId": "d22289087f32358ca7d06ed3c1969462",
"jobName": "APIBatchAddBareMetal2ChassisEvent",
"jobData": "{\"createMessages\":[]",
"jobResult": "",
"state": "Succeeded",
"managementNodeUuid": "a0b0f5b18c6e3cbb84b7d75e3eea991d"
}
}| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| success | boolean | 4.3.6 | |
| error | ErrorCode | 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error | 4.0.0 |
| inventory | LongJobInventory | 详情参考inventory | 4.0.0 |
#error
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| code | String | 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 | 4.0.0 |
| description | String | 错误的概要描述 | 4.0.0 |
| details | String | 错误的详细信息 | 4.0.0 |
| elaboration | String | 保留字段,默认为null | 4.0.0 |
| opaque | LinkedHashMap | 保留字段,默认为null | 4.0.0 |
| cause | ErrorCode | 根错误,引发当前错误的源错误,若无原错误,该字段为null | 4.0.0 |
#inventory
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID,唯一标示该资源 | 4.0.0 |
| name | String | 资源名称 | 4.0.0 |
| description | String | 资源的详细描述 | 4.0.0 |
| apiId | String | 用于关联TaskProgress的APIID | 4.0.0 |
| jobName | String | 任务名称 | 4.0.0 |
| jobData | String | 任务数据 | 4.0.0 |
| jobResult | String | 任务结果 | 4.0.0 |
| targetResourceUuid | String | 目标资源UUID | 4.0.0 |
| managementNodeUuid | String | 管理节点UUID | 4.0.0 |
| createDate | Timestamp | 创建时间 | 4.0.0 |
| lastOpDate | Timestamp | 最后一次修改时间 | 4.0.0 |
| state | LongJobState | 详情参考state | 4.0.0 |
#state
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| name | String | 资源名称 | 4.0.0 |
| ordinal | int | 4.0.0 |
SDK示例
Java
SDK
BatchAddBareMetal2IpmiChassisAction action = new BatchAddBareMetal2IpmiChassisAction();
action.chassisInfo = "FILE CONTENT ENCODE BY BASE64";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
BatchAddBareMetal2IpmiChassisAction.Result res = action.call();Python
SDK
BatchAddBareMetal2IpmiChassisAction action = BatchAddBareMetal2IpmiChassisAction()
action.chassisInfo = "FILE CONTENT ENCODE BY BASE64"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
BatchAddBareMetal2IpmiChassisAction.Result res = action.call()