更新裸金属节点信息(UpdateBareMetal2Chassis)
API请求
URLs
PUT zstack/v1/baremetal2/chassis/{uuid}/actionsHeaders
Authorization: OAuth the-session-uuidBody
{
"updateBareMetal2Chassis": {
"name": "NEW_BM_CHASSIS",
"description": "This is a new bare metal chassis."
},
"systemTags": [],
"userTags": []
}Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。
Curl示例
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateBareMetal2Chassis":{"name":"NEW_BM_CHASSIS","description":"This is a new bare metal chassis."}}' http://localhost:8080/zstack/v1/baremetal2/chassis/4e99972d89a63a9fa061971a3267374f/actions参数列表
| 名字 | 类型 | 位置 | 描述 | 可选值 | 起始版本 |
|---|---|---|---|---|---|
| uuid | String | url | 资源的UUID,唯一标示该资源 | 4.0.0 | |
| name (可选) | String | body(包含在updateBaremetalChassis结构中) | 资源名称 | 4.0.0 | |
| description (可选) | String | body(包含在updateBaremetalChassis结构中) | 资源的详细描述 | 4.0.0 | |
| systemTags (可选) | List | body | 系统标签 | 4.0.0 | |
| userTags (可选) | List | body | 用户标签 | 4.0.0 |
API返回
返回示例
{
"inventory": {
"uuid": "ff9c61a4323b429eb53552098b3582e5",
"name": "BM_CHASSIS",
"description": "This is a bare metal chassis.",
"zoneUuid": "6324e249a6434599867f0bdc4166f89d",
"clusterUuid": "4569c6fc1b4e453691bfa3bed90d66d2",
"chassisOfferingUuid": "dfd1ef44f65f49a8b788a31727eeea17",
"type": "IPMI",
"state": "Enabled",
"status": "Available",
"powerStatus": "POWER_ON",
"createDate": "Nov 14, 2017 10:20:57 PM",
"lastOpDate": "Nov 14, 2017 10:20:57 PM"
}
}| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| success | boolean | 4.3.6 | |
| error | ErrorCode | 错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error | 4.0.0 |
| inventory | BaremetalChassisInventory | 详情参考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 |
| zoneUuid | String | 区域UUID | 4.0.0 |
| clusterUuid | String | 集群UUID | 4.0.0 |
| chassisOfferingUuid | String | 裸金属节点规格UUID | 4.0.0 |
| type | String | 类型 | 4.0.0 |
| state | String | 启用状态 | 4.0.0 |
| status | String | 分配状态 | 4.0.0 |
| powerStatus | String | 电源状态 | 4.0.0 |
| createDate | Timestamp | 创建时间 | 4.0.0 |
| lastOpDate | Timestamp | 最后一次修改时间 | 4.0.0 |
| chassisNics | List | 详情参考chassisNics | 4.0.0 |
| chassisDisks | List | 详情参考chassisDisks | 4.0.0 |
| chassisOffering | BareMetal2ChassisOfferingInventory | 详情参考chassisOffering | 4.0.0 |
#chassisNics
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID,唯一标示该资源 | 4.0.0 |
| chassisUuid | String | 裸金属节点UUID | 4.0.0 |
| mac | String | 网卡MAC | 4.0.0 |
| speed | String | 网卡速率 | 4.0.0 |
| isProvisionNic | Boolean | 是否为部署网卡 | 4.0.0 |
| createDate | Timestamp | 创建时间 | 4.0.0 |
| lastOpDate | Timestamp | 最后一次修改时间 | 4.0.0 |
#chassisDisks
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID,唯一标示该资源 | 4.0.0 |
| chassisUuid | String | 裸金属节点UUID | 4.0.0 |
| diskSize | Long | 磁盘空间(以字节为单位) | 4.0.0 |
| type | String | 磁盘类型 | 4.0.0 |
| createDate | Timestamp | 创建时间 | 4.0.0 |
| lastOpDate | Timestamp | 最后一次修改时间 | 4.0.0 |
#chassisOffering
| 名字 | 类型 | 描述 | 起始版本 |
|---|---|---|---|
| uuid | String | 资源的UUID,唯一标示该资源 | 4.0.0 |
| name | String | 资源名称 | 4.0.0 |
| description | String | 资源的详细描述 | 4.0.0 |
| architecture | String | CPU架构 | 4.0.0 |
| cpuModelName | String | CPU型号 | 4.0.0 |
| cpuNum | Integer | CPU核数 | 4.0.0 |
| memorySize | Long | 内存容量 | 4.0.0 |
| bootMode | String | 启动模式 | 4.0.0 |
| state | String | 状态 | 4.0.0 |
| createDate | Timestamp | 创建时间 | 4.0.0 |
| lastOpDate | Timestamp | 最后一次修改时间 | 4.0.0 |
SDK示例
Java
SDK
UpdateBareMetal2ChassisAction action = new UpdateBareMetal2ChassisAction();
action.uuid = "4e99972d89a63a9fa061971a3267374f";
action.name = "NEW_BM_CHASSIS";
action.description = "This is a new bare metal chassis.";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateBareMetal2ChassisAction.Result res = action.call();Python
SDK
UpdateBareMetal2ChassisAction action = UpdateBareMetal2ChassisAction()
action.uuid = "4e99972d89a63a9fa061971a3267374f"
action.name = "NEW_BM_CHASSIS"
action.description = "This is a new bare metal chassis."
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateBareMetal2ChassisAction.Result res = action.call()