批量添加裸金属设备(BatchCreateBaremetalChassis)
API请求
URLs
POST zstack/v1/baremetal/chassis/from-file
Headers
Authorization: OAuth the-session-uuid
Body
{
"params": {
"baremetalChassisInfo": "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":{"baremetalChassisInfo":"FILE CONTENT ENCODE BY BASE64"}}' http://localhost:8080/zstack/v1/baremetal/chassis/from-file
参数列表
名字 | 类型 | 位置 | 描述 | 可选值 | 起始版本 |
---|---|---|---|---|---|
baremetalChassisInfo | String | body(包含在params结构中) | 经过base64编码的裸金属设备信息 | 3.1.1 | |
longJobName (可选) | String | body(包含在params结构中) | 长任务名称 | 3.1.1 | |
longJobDescription (可选) | String | body(包含在params结构中) | 长任务简介 | 3.1.1 | |
resourceUuid (可选) | String | body(包含在params结构中) | 资源UUID | 3.1.1 | |
systemTags (可选) | List | body | 系统标签 | 3.1.1 | |
userTags (可选) | List | body | 用户标签 | 3.1.1 |
API返回
返回示例
{
"inventory": {
"uuid": "cec9662c5cc534779833c89d8104aa7d",
"name": "APIBatchCreateBaremetalChassisMsg",
"apiId": "85ef8b327b0a3c71a53827b30892f327",
"jobName": "APIBatchCreateBaremetalChassisMsg",
"jobData": "{\"createMessages\":[]",
"jobResult": "",
"state": "Succeeded",
"managementNodeUuid": "31c1228477b6310b9eb28a75e892b046"
}
}
名字 | 类型 | 描述 | 起始版本 |
---|---|---|---|
error | ErrorCode | 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error | 3.1.1 |
inventory | LongJobInventory | 详情参考inventory | 3.1.1 |
#error
名字 | 类型 | 描述 | 起始版本 |
---|---|---|---|
code | String | 错误码号,错误的全局唯一标识,例如SYS.1000, HOST.1001 | 3.1.1 |
description | String | 错误的概要描述 | 3.1.1 |
details | String | 错误的详细信息 | 3.1.1 |
elaboration | String | 保留字段,默认为null | 3.1.1 |
opaque | LinkedHashMap | 保留字段,默认为null | 3.1.1 |
cause | ErrorCode | 根错误,引发当前错误的源错误,若无原错误,该字段为null | 3.1.1 |
#inventory
名字 | 类型 | 描述 | 起始版本 |
---|---|---|---|
uuid | String | 资源的UUID,唯一标示该资源 | 3.1.1 |
name | String | 资源名称 | 3.1.1 |
description | String | 资源的详细描述 | 3.1.1 |
apiId | String | 用于关联TaskProgress的APIID | 3.1.1 |
jobName | String | 任务名称 | 3.1.1 |
jobData | String | 任务数据 | 3.1.1 |
jobResult | String | 任务结果 | 3.1.1 |
targetResourceUuid | String | 目标资源UUID | 3.1.1 |
managementNodeUuid | String | 管理节点UUID | 3.1.1 |
createDate | Timestamp | 创建时间 | 3.1.1 |
lastOpDate | Timestamp | 最后一次修改时间 | 3.1.1 |
state | LongJobState | 详情参考state | 3.1.1 |
#state
名字 | 类型 | 描述 | 起始版本 |
---|---|---|---|
name | String | 资源名称 | 3.1.1 |
ordinal | int | 3.1.1 |
SDK示例
Java
SDK
BatchCreateBaremetalChassisAction action = new BatchCreateBaremetalChassisAction();
action.baremetalChassisInfo = "FILE CONTENT ENCODE BY BASE64";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
BatchCreateBaremetalChassisAction.Result res = action.call();
Python
SDK
BatchCreateBaremetalChassisAction action = BatchCreateBaremetalChassisAction()
action.baremetalChassisInfo = "FILE CONTENT ENCODE BY BASE64"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
BatchCreateBaremetalChassisAction.Result res = action.call()