裸金属节点
裸金属节点列表
功能介绍
获取裸金属节点列表
URI
GET /v1/nodes/detail
请求消息
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
instance_uuid | string | 否 | 按裸金属节点对应的裸金属主机UUID过滤 |
maintenance | boolean | 否 | 按裸金属节点是否处于维护模式过滤 |
fault | string | 否 | 按裸金属节点 fault 类型过滤 |
associated | boolean | 否 | 按裸金属节点是否有裸金属主机过滤 |
provision_state | string | 否 | 按裸金属节点状态过滤 |
driver | string | 否 | 按裸金属节点驱动名称过滤 |
conductor_group | string | 否 | 按裸金属节点 conuctor group 过滤 |
conductor | string | 否 | 按裸金属节点所在 conductor 过滤 |
owner | string | 否 | 按裸金属节点拥有者过滤 |
description_contains | string | 否 | 按裸金属节点描述过滤 |
sort_key | string | 否 | 按裸金属节点属性排序 |
响应消息
参数 | 参数类型 | 描述 |
---|---|---|
uuid | string | 裸金属节点 UUID |
name | string | 裸金属节点名称 |
power_state | string | 裸金属节点电源状态 |
target_power_state | string | 裸金属节点目标电源状态 |
provision_state | string | 裸金属节点状态 |
target_provision_state | string | 裸金属节点目标状态 |
maintenance | boolean | 裸金属节点是否处于维护模式 |
maintenance_reason | string | 裸金属节点设置维护模式的原因 |
fault | string | 裸金属节点失败信息 |
last_error | string | 裸金属节点最后一次操作失败的信息 |
reservation | int | 获取了裸金属节点锁的 conductor 的信息 |
driver | string | 裸金属节点使用的驱动名称 |
driver_info | JSON | 裸金属节点驱动信息详情 |
driver_internal_info | JSON | 裸金属节点驱动内部信息详情,该字段只读 |
properites | JSON | 裸金属节点属性详情 |
instance_info | JSON | 裸金属节点对应的裸金属主机信息 |
instance_uuid | string | 裸金属节点对应的裸金属主机 UUID |
chassis_uuid | string | 裸金属节点基板 UUID |
extra | JSON | 裸金属节点额外信息 |
console_enabled | boolean | 裸金属节点是否开启了控制台功能 |
raid_config | JSON | 裸金属节点 RAID 配置信息 |
target_raid_config | JSON | 裸金属节点目标 RAID 配置信息 |
clean_step | string | 裸金属节点清理步骤信息 |
deploy_step | string | 裸金属节点部署步骤信息 |
links | array | 裸金属节点相关的链接 |
ports | array | 裸金属节点端口列表 |
portgroups | array | 裸金属节点端口组列表 |
states | array | 裸金属节点状态列表 |
resource_class | string | 裸金属节点 resoure class 信息 |
bios_interface | string | 裸金属节点 BIOS 接口 |
boot_interface | string | 裸金属节点启动接口。 例如 “pxe” |
console_interface | string | 裸金属节点控制台接口。 例如 “no-console” |
deploy_interface | string | 裸金属节点部署接口。 例如 “iscsi” |
inspect_interface | string | 裸金属节点硬件检查接口。 例如 “no-inspect” |
management_interface | string | 裸金属节点管理接口。 例如 “ipmitool” |
network_interface | string | 裸金属节点网络接口。 例如 “neutron” |
power_interface | string | 裸金属节点电源接口。 例如 “ipmitool” |
raid_interface | string | 裸金属节点 RAID 接口。 例如 “no-raid” |
rescue_interface | string | 裸金属节点救援接口。 例如 “no-rescue” |
storage_interface | string | 裸金属节点存储接口。 例如 “cinder” |
traits | array | 裸金属节点 traits 列表 |
vendor_interface | string | 裸金属节点厂商接口。 例如 “no-vendor” |
volume | array | 裸金属节点关联的云硬盘列表 |
conductor_group | string | 裸金属节点所在的 conductor group 名称 |
protected | boolean | 裸金属节点是否受保护 |
protected_reason | string | 裸金属节点进入保护原因 |
owner | string | 拥有该裸金属节点的租户的 UUID |
description | string | 裸金属节点描述 |
conductor | string | 裸金属节点所在的 conductor 节点 |
allocation_uuid | string | 裸金属节点关联的 allocation UUID |
正常响应示例
{
"nodes": [
{
"instance_uuid": null,
"links": [
{
"href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d",
"rel": "self"
},
{
"href": "http://127.0.0.1:6385/nodes/6d85703a-565d-469a-96ce-30b6de53079d",
"rel": "bookmark"
}
],
"maintenance": false,
"name": "test_node_classic",
"power_state": "power off",
"provision_state": "available",
"uuid": "6d85703a-565d-469a-96ce-30b6de53079d"
},
{
"instance_uuid": null,
"links": [
{
"href": "http://127.0.0.1:6385/v1/nodes/2b045129-a906-46af-bc1a-092b294b3428",
"rel": "self"
},
{
"href": "http://127.0.0.1:6385/nodes/2b045129-a906-46af-bc1a-092b294b3428",
"rel": "bookmark"
}
],
"maintenance": false,
"name": "test_node_dynamic",
"power_state": null,
"provision_state": "enroll",
"uuid": "2b045129-a906-46af-bc1a-092b294b3428"
}
]
}
正常响应代码
200
错误码
400,403,406
裸金属节点详情
功能介绍
获取裸金属节点详情
URI
GET /v1/nodes/{node_ident}
请求消息
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
node_ident | string | 是 | 裸金属节点 UUID |
fields | array | 否 | 返回的数据字段 |
响应消息
参数 | 参数类型 | 描述 |
---|---|---|
uuid | string | 裸金属节点 UUID |
name | string | 裸金属节点名称 |
power_state | string | 裸金属节点电源状态 |
target_power_state | string | 裸金属节点目标电源状态 |
provision_state | string | 裸金属节点状态 |
target_provision_state | string | 裸金属节点目标状态 |
maintenance | boolean | 裸金属节点是否处于维护模式 |
maintenance_reason | string | 裸金属节点设置维护模式的原因 |
fault | string | 裸金属节点失败信息 |
last_error | string | 裸金属节点最后一次操作失败的信息 |
reservation | int | 获取了裸金属节点锁的 conductor 的信息 |
driver | string | 裸金属节点使用的驱动名称 |
driver_info | JSON | 裸金属节点驱动信息详情 |
driver_internal_info | JSON | 裸金属节点驱动内部信息详情,该字段只读 |
properites | JSON | 裸金属节点属性详情 |
instance_info | JSON | 裸金属节点对应的裸金属主机信息 |
instance_uuid | string | 裸金属节点对应的裸金属主机 UUID |
chassis_uuid | string | 裸金属节点基板 UUID |
extra | JSON | 裸金属节点额外信息 |
console_enabled | boolean | 裸金属节点是否开启了控制台功能 |
raid_config | JSON | 裸金属节点 RAID 配置信息 |
target_raid_config | JSON | 裸金属节点目标 RAID 配置信息 |
clean_step | string | 裸金属节点清理步骤信息 |
deploy_step | string | 裸金属节点部署步骤信息 |
links | array | 裸金属节点相关的链接 |
ports | array | 裸金属节点端口列表 |
portgroups | array | 裸金属节点端口组列表 |
states | array | 裸金属节点状态列表 |
resource_class | string | 裸金属节点 resoure class 信息 |
bios_interface | string | 裸金属节点 BIOS 接口 |
boot_interface | string | 裸金属节点启动接口。 例如 “pxe” |
console_interface | string | 裸金属节点控制台接口。 例如 “no-console” |
deploy_interface | string | 裸金属节点部署接口。 例如 “iscsi” |
inspect_interface | string | 裸金属节点硬件检查接口。 例如 “no-inspect” |
management_interface | string | 裸金属节点管理接口。 例如 “ipmitool” |
network_interface | string | 裸金属节点网络接口。 例如 “neutron” |
power_interface | string | 裸金属节点电源接口。 例如 “ipmitool” |
raid_interface | string | 裸金属节点 RAID 接口。 例如 “no-raid” |
rescue_interface | string | 裸金属节点救援接口。 例如 “no-rescue” |
storage_interface | string | 裸金属节点存储接口。 例如 “cinder” |
traits | array | 裸金属节点 traits 列表 |
vendor_interface | string | 裸金属节点厂商接口。 例如 “no-vendor” |
volume | array | 裸金属节点关联的云硬盘列表 |
conductor_group | string | 裸金属节点所在的 conductor group 名称 |
protected | boolean | 裸金属节点是否受保护 |
protected_reason | string | 裸金属节点进入保护原因 |
owner | string | 拥有该裸金属节点的租户的 UUID |
description | string | 裸金属节点描述 |
conductor | string | 裸金属节点所在的 conductor 节点 |
allocation_uuid | string | 裸金属节点关联的 allocation UUID |
正常响应示例
{
"allocation_uuid": null,
"boot_interface": null,
"chassis_uuid": null,
"clean_step": {},
"conductor": "compute1.localdomain",
"conductor_group": "group-1",
"console_enabled": false,
"console_interface": null,
"created_at": "2016-08-18T22:28:48.643434+11:11",
"deploy_interface": null,
"deploy_step": {},
"description": null,
"driver": "fake",
"driver_info": {
"ipmi_password": "******",
"ipmi_username": "ADMIN"
},
"driver_internal_info": {
"clean_steps": null
},
"extra": {},
"inspect_interface": null,
"inspection_finished_at": null,
"inspection_started_at": null,
"instance_info": {},
"instance_uuid": null,
"last_error": null,
"lessee": null,
"links": [
{
"href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d",
"rel": "self"
},
{
"href": "http://127.0.0.1:6385/nodes/6d85703a-565d-469a-96ce-30b6de53079d",
"rel": "bookmark"
}
],
"maintenance": false,
"maintenance_reason": null,
"management_interface": null,
"name": "test_node_classic",
"network_interface": "flat",
"owner": null,
"portgroups": [
{
"href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d/portgroups",
"rel": "self"
},
{
"href": "http://127.0.0.1:6385/nodes/6d85703a-565d-469a-96ce-30b6de53079d/portgroups",
"rel": "bookmark"
}
],
"ports": [
{
"href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d/ports",
"rel": "self"
},
{
"href": "http://127.0.0.1:6385/nodes/6d85703a-565d-469a-96ce-30b6de53079d/ports",
"rel": "bookmark"
}
],
"power_interface": null,
"power_state": "power off",
"properties": {},
"protected": false,
"protected_reason": null,
"provision_state": "available",
"provision_updated_at": "2016-08-18T22:28:49.946416+00:00",
"raid_config": {},
"raid_interface": null,
"rescue_interface": null,
"reservation": null,
"resource_class": "bm-large",
"states": [
{
"href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d/states",
"rel": "self"
},
{
"href": "http://127.0.0.1:6385/nodes/6d85703a-565d-469a-96ce-30b6de53079d/states",
"rel": "bookmark"
}
],
"storage_interface": "noop",
"target_power_state": null,
"target_provision_state": null,
"target_raid_config": {},
"traits": [],
"updated_at": "2016-08-18T22:28:49.653974+00:00",
"uuid": "6d85703a-565d-469a-96ce-30b6de53079d",
"vendor_interface": null,
"volume": [
{
"href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d/volume",
"rel": "self"
},
{
"href": "http://127.0.0.1:6385/nodes/6d85703a-565d-469a-96ce-30b6de53079d/volume",
"rel": "bookmark"
}
]
}
正常响应代码
200
错误码
400,403,404,406
创建裸金属节点
功能介绍
创建裸金属节点
URI
POST /v1/nodes
请求消息
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
boot_interface | string | 否 | 裸金属节点启动接口。 默认值是”pxe” |
conductor_group | string | 是 | 裸金属节点所在的节点组。如果是default节点组,则传”” |
console_interface | string | 否 | 裸金属节点控制台接口。 默认值是”ipmitool-socat” |
deploy_interface | JSON | 否 | 裸金属节点部署接口。 默认值是”iscsi” |
driver_info | object | 是 | 裸金属节点驱动信息详情。参数包含IPMI地址ipmi_address,IPMI用户名ipmi_username,IPMI密码ipmi_password,控制台端口ipmi_terminal_port,IPMI端口ipmi_port(默认传”623”),部署内核镜像ID deploy_kernel,部署ramdisk镜像ID deploy_ramdisk,部署网络ID provisioning_network,清理网络ID cleaning_network,部署清理网络对应的子网ID subnet。如果是纳管裸金属节点部署网络ID、清理网络ID、子网ID不需要设置。 |
driver | string | 是 | 裸金属节点使用的驱动名称。默认传”ipmi” |
extra | JSON | 是 | 裸金属节点额外信息。参数包含可用区reserve_availability_zone,CPU型号cpu_model(可选),元数据键值(可选) |
inspect_interface | string | 否 | 裸金属节点硬件检查接口。 默认值是 “no-inspect” |
management_interface | string | 否 | 裸金属节点管理接口。 默认值是 “ipmitool” |
name | string | 是 | 裸金属节点名称 |
network_interface | string | 否 | 裸金属节点网络接口。 默认值是 “neutron” |
power_interface | string | 否 | 裸金属节点电源接口。 默认值是 “ipmitool” |
properties | JSON | 是 | 裸金属节点属性。参数包含CPU核数cpus,内存memory_mb(单位MB),系统盘local_gb(单位GB),CPU架构cpu_arch(x86传”x86_64”,arm传”aarch64”,loongarch传”mips64el”),启动模式capabilities(BIOS传”boot_mode:bios”,UEFI传”boot_mode:uefi”),如果是纳管裸金属节点需要设置management_type传”adopt” |
raid_interface | string | 否 | 裸金属节点 RAID 接口。 默认值是 “no-raid” |
rescue_interface | string | 否 | 裸金属节点救援模式接口。 默认值是 “no-rescue” |
resource_class | string | 否 | 裸金属节点 resource class 信息。默认值是”None” |
storage_interface | string | 否 | 裸金属节点存储接口。 默认值是 “cinder” |
uuid | string | 否 | 裸金属节点 UUID |
vendor_interface | string | 否 | 裸金属节点厂商接口。 默认值是 “ipmitool” |
owner | string | 否 | 拥有该裸金属节点的租户的 UUID。默认值是”None” |
description | string | 否 | 裸金属节点的描述。默认值是”None” |
响应消息
参数 | 参数类型 | 描述 |
---|---|---|
uuid | string | 裸金属节点 UUID |
name | string | 裸金属节点名称 |
power_state | string | 裸金属节点电源状态 |
target_power_state | string | 裸金属节点目标电源状态 |
provision_state | string | 裸金属节点状态 |
target_provision_state | string | 裸金属节点目标状态 |
maintenance | boolean | 裸金属节点是否处于维护模式 |
maintenance_reason | string | 裸金属节点设置维护模式的原因 |
fault | string | 裸金属节点失败信息 |
last_error | string | 裸金属节点最后一次操作失败的信息 |
reservation | int | 获取了裸金属节点锁的 conductor 的信息 |
driver | string | 裸金属节点使用的驱动名称 |
driver_info | JSON | 裸金属节点驱动信息详情 |
driver_internal_info | JSON | 裸金属节点驱动内部信息详情,该字段只读 |
properites | JSON | 裸金属节点属性详情 |
instance_info | JSON | 裸金属节点对应的裸金属主机信息 |
instance_uuid | string | 裸金属节点对应的裸金属主机 UUID |
chassis_uuid | string | 裸金属节点基板 UUID |
extra | JSON | 裸金属节点额外信息 |
console_enabled | boolean | 裸金属节点是否开启了控制台功能 |
raid_config | JSON | 裸金属节点 RAID 配置信息 |
target_raid_config | JSON | 裸金属节点目标 RAID 配置信息 |
clean_step | string | 裸金属节点清理步骤信息 |
deploy_step | string | 裸金属节点部署步骤信息 |
links | array | 裸金属节点相关的链接 |
ports | array | 裸金属节点端口列表 |
portgroups | array | 裸金属节点端口组列表 |
states | array | 裸金属节点状态列表 |
resource_class | string | 裸金属节点 resoure class 信息 |
bios_interface | string | 裸金属节点 BIOS 接口 |
boot_interface | string | 裸金属节点启动接口。 例如 “pxe” |
console_interface | string | 裸金属节点控制台接口。 例如 “no-console” |
deploy_interface | string | 裸金属节点部署接口。 例如 “iscsi” |
inspect_interface | string | 裸金属节点硬件检查接口。 例如 “no-inspect” |
management_interface | string | 裸金属节点管理接口。 例如 “ipmitool” |
network_interface | string | 裸金属节点网络接口。 例如 “neutron” |
power_interface | string | 裸金属节点电源接口。 例如 “ipmitool” |
raid_interface | string | 裸金属节点 RAID 接口。 例如 “no-raid” |
rescue_interface | string | 裸金属节点救援接口。 例如 “no-rescue” |
storage_interface | string | 裸金属节点存储接口。 例如 “cinder” |
traits | array | 裸金属节点 traits 列表 |
vendor_interface | string | 裸金属节点厂商接口。 例如 “no-vendor” |
volume | array | 裸金属节点关联的云硬盘列表 |
conductor_group | string | 裸金属节点所在的 conductor group 名称 |
protected | boolean | 裸金属节点是否受保护 |
protected_reason | string | 裸金属节点进入保护原因 |
owner | string | 拥有该裸金属节点的租户的 UUID |
description | string | 裸金属节点描述 |
conductor | string | 裸金属节点所在的 conductor 节点 |
allocation_uuid | string | 裸金属节点关联的 allocation UUID |
请求示例
{
"name": "test_node_dynamic",
"driver": "ipmi",
"driver_info": {
"ipmi_address": "10.100.0.254",
"ipmi_username": "ADMIN",
"ipmi_password": "password",
"ipmi_terminal_port": "30009",
"ipmi_port": "623",
"deploy_kernel": "52a26726-d080-434d-86fb-f7f6858e2f4c",
"deploy_ramdisk": "1026acc6-6899-425b-88dc-f9efdfb20526",
"provisioning_network": "6360ebaf-be0c-403c-b962-444815f44d0c",
"cleaning_network": "6360ebaf-be0c-403c-b962-444815f44d0c",
"subnet": "a658ef06-ef0e-42b7-a737-78b66d6b8856"
},
"conductor_group": "",
"extra": {
"cpu_model": "test",
"test": "test_data",
"reserve_availability_zone": "default-az"
},
"properties": {
"cpus": "1",
"memory_mb": "20480",
"local_gb": "100",
"cpu_arch": "x86_64",
"capabilities": "boot_mode:bios"
},
}
正常响应示例
{
"allocation_uuid": null,
"boot_interface": null,
"chassis_uuid": null,
"clean_step": {},
"conductor_group": "group-1",
"console_enabled": false,
"console_interface": null,
"created_at": "2016-08-18T22:28:48.643434+11:11",
"deploy_interface": null,
"deploy_step": {},
"description": null,
"driver": "agent_ipmitool",
"driver_info": {
"ipmi_password": "******",
"ipmi_username": "ADMIN"
},
"driver_internal_info": {},
"extra": {},
"inspect_interface": null,
"inspection_finished_at": null,
"inspection_started_at": null,
"instance_info": {},
"instance_uuid": null,
"last_error": null,
"lessee": null,
"links": [
{
"href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d",
"rel": "self"
},
{
"href": "http://127.0.0.1:6385/nodes/6d85703a-565d-469a-96ce-30b6de53079d",
"rel": "bookmark"
}
],
"maintenance": false,
"maintenance_reason": null,
"management_interface": null,
"name": "test_node_classic",
"network_interface": "flat",
"owner": null,
"portgroups": [
{
"href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d/portgroups",
"rel": "self"
},
{
"href": "http://127.0.0.1:6385/nodes/6d85703a-565d-469a-96ce-30b6de53079d/portgroups",
"rel": "bookmark"
}
],
"ports": [
{
"href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d/ports",
"rel": "self"
},
{
"href": "http://127.0.0.1:6385/nodes/6d85703a-565d-469a-96ce-30b6de53079d/ports",
"rel": "bookmark"
}
],
"power_interface": null,
"power_state": null,
"properties": {},
"protected": false,
"protected_reason": null,
"provision_state": "enroll",
"provision_updated_at": null,
"raid_config": {},
"raid_interface": null,
"rescue_interface": null,
"reservation": null,
"resource_class": "bm-large",
"states": [
{
"href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d/states",
"rel": "self"
},
{
"href": "http://127.0.0.1:6385/nodes/6d85703a-565d-469a-96ce-30b6de53079d/states",
"rel": "bookmark"
}
],
"storage_interface": "noop",
"target_power_state": null,
"target_provision_state": null,
"target_raid_config": {},
"traits": [],
"updated_at": null,
"uuid": "6d85703a-565d-469a-96ce-30b6de53079d",
"vendor_interface": null,
"volume": [
{
"href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d/volume",
"rel": "self"
},
{
"href": "http://127.0.0.1:6385/nodes/6d85703a-565d-469a-96ce-30b6de53079d/volume",
"rel": "bookmark"
}
]
}
正常响应代码
201
错误码
400,403,406
编辑裸金属节点
功能介绍
编辑裸金属节点信息
URI
PATCH /v1/nodes/{node_ident}
请求消息
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
node_ident | string | 是 | 裸金属节点 UUID |
响应消息
参数 | 参数类型 | 描述 |
---|---|---|
uuid | string | 裸金属节点 UUID |
name | string | 裸金属节点名称 |
power_state | string | 裸金属节点电源状态 |
target_power_state | string | 裸金属节点目标电源状态 |
provision_state | string | 裸金属节点状态 |
target_provision_state | string | 裸金属节点目标状态 |
maintenance | boolean | 裸金属节点是否处于维护模式 |
maintenance_reason | string | 裸金属节点设置维护模式的原因 |
fault | string | 裸金属节点失败信息 |
last_error | string | 裸金属节点最后一次操作失败的信息 |
reservation | int | 获取了裸金属节点锁的 conductor 的信息 |
driver | string | 裸金属节点使用的驱动名称 |
driver_info | JSON | 裸金属节点驱动信息详情 |
driver_internal_info | JSON | 裸金属节点驱动内部信息详情,该字段只读 |
properites | JSON | 裸金属节点属性详情 |
instance_info | JSON | 裸金属节点对应的裸金属主机信息 |
instance_uuid | string | 裸金属节点对应的裸金属主机 UUID |
chassis_uuid | string | 裸金属节点基板 UUID |
extra | JSON | 裸金属节点额外信息 |
console_enabled | boolean | 裸金属节点是否开启了控制台功能 |
raid_config | JSON | 裸金属节点 RAID 配置信息 |
target_raid_config | JSON | 裸金属节点目标 RAID 配置信息 |
clean_step | string | 裸金属节点清理步骤信息 |
deploy_step | string | 裸金属节点部署步骤信息 |
links | array | 裸金属节点相关的链接 |
ports | array | 裸金属节点端口列表 |
portgroups | array | 裸金属节点端口组列表 |
states | array | 裸金属节点状态列表 |
resource_class | string | 裸金属节点 resoure class 信息 |
bios_interface | string | 裸金属节点 BIOS 接口 |
boot_interface | string | 裸金属节点启动接口。 例如 “pxe” |
console_interface | string | 裸金属节点控制台接口。 例如 “no-console” |
deploy_interface | string | 裸金属节点部署接口。 例如 “iscsi” |
inspect_interface | string | 裸金属节点硬件检查接口。 例如 “no-inspect” |
management_interface | string | 裸金属节点管理接口。 例如 “ipmitool” |
network_interface | string | 裸金属节点网络接口。 例如 “neutron” |
power_interface | string | 裸金属节点电源接口。 例如 “ipmitool” |
raid_interface | string | 裸金属节点 RAID 接口。 例如 “no-raid” |
rescue_interface | string | 裸金属节点救援接口。 例如 “no-rescue” |
storage_interface | string | 裸金属节点存储接口。 例如 “cinder” |
traits | array | 裸金属节点 traits 列表 |
vendor_interface | string | 裸金属节点厂商接口。 例如 “no-vendor” |
volume | array | 裸金属节点关联的云硬盘列表 |
conductor_group | string | 裸金属节点所在的 conductor group 名称 |
protected | boolean | 裸金属节点是否受保护 |
protected_reason | string | 裸金属节点进入保护原因 |
owner | string | 拥有该裸金属节点的租户的 UUID |
description | string | 裸金属节点描述 |
conductor | string | 裸金属节点所在的 conductor 节点 |
allocation_uuid | string | 裸金属节点关联的 allocation UUID |
请求示例
[
{
"op": "replace",
"path": "/driver_info/ipmi_username",
"value": "OPERATOR"
},
{
"op": "add",
"path": "/driver_info/deploy_kernel",
"value": "http://127.0.0.1/images/kernel"
},
{
"op": "add",
"path": "/driver_info/deploy_ramdisk",
"value": "http://127.0.0.1/images/ramdisk"
}
]
正常响应示例
{
"allocation_uuid": null,
"boot_interface": null,
"chassis_uuid": null,
"clean_step": {},
"conductor": "compute1.localdomain",
"conductor_group": "group-1",
"console_enabled": false,
"console_interface": null,
"created_at": "2016-08-18T22:28:48.643434+11:11",
"deploy_interface": null,
"deploy_step": {},
"driver": "fake",
"driver_info": {
"deploy_kernel": "http://127.0.0.1/images/kernel",
"deploy_ramdisk": "http://127.0.0.1/images/ramdisk",
"ipmi_password": "******",
"ipmi_username": "OPERATOR"
},
"driver_internal_info": {
"clean_steps": null
},
"extra": {},
"inspect_interface": null,
"inspection_finished_at": null,
"inspection_started_at": null,
"instance_info": {},
"instance_uuid": null,
"last_error": null,
"lessee": null,
"links": [
{
"href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d",
"rel": "self"
},
{
"href": "http://127.0.0.1:6385/nodes/6d85703a-565d-469a-96ce-30b6de53079d",
"rel": "bookmark"
}
],
"maintenance": true,
"maintenance_reason": "Replacing the hard drive",
"management_interface": null,
"name": "test_node_classic",
"network_interface": "flat",
"owner": null,
"portgroups": [
{
"href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d/portgroups",
"rel": "self"
},
{
"href": "http://127.0.0.1:6385/nodes/6d85703a-565d-469a-96ce-30b6de53079d/portgroups",
"rel": "bookmark"
}
],
"ports": [
{
"href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d/ports",
"rel": "self"
},
{
"href": "http://127.0.0.1:6385/nodes/6d85703a-565d-469a-96ce-30b6de53079d/ports",
"rel": "bookmark"
}
],
"power_interface": null,
"power_state": "power off",
"properties": {},
"protected": false,
"protected_reason": null,
"provision_state": "available",
"provision_updated_at": "2016-08-18T22:28:49.946416+00:00",
"raid_config": {},
"raid_interface": null,
"rescue_interface": null,
"reservation": null,
"resource_class": null,
"states": [
{
"href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d/states",
"rel": "self"
},
{
"href": "http://127.0.0.1:6385/nodes/6d85703a-565d-469a-96ce-30b6de53079d/states",
"rel": "bookmark"
}
],
"storage_interface": "noop",
"target_power_state": null,
"target_provision_state": null,
"target_raid_config": {},
"traits": [
"CUSTOM_TRAIT1",
"HW_CPU_X86_VMX"
],
"updated_at": "2016-08-18T22:28:49.653974+00:00",
"uuid": "6d85703a-565d-469a-96ce-30b6de53079d",
"vendor_interface": null,
"volume": [
{
"href": "http://127.0.0.1:6385/v1/nodes/6d85703a-565d-469a-96ce-30b6de53079d/volume",
"rel": "self"
},
{
"href": "http://127.0.0.1:6385/nodes/6d85703a-565d-469a-96ce-30b6de53079d/volume",
"rel": "bookmark"
}
]
}
正常响应代码
200
错误码
400,403,404,406,409
删除裸金属节点
功能介绍
删除裸金属节点
URI
DELETE /v1/nodes/{node_ident}
请求消息
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
node_ident | string | 是 | 裸金属节点UUID |
响应消息
无
请求示例
无
正常响应示例
无
正常响应代码
204
错误码
400,403,404,409
修改裸金属节点电源状态
功能介绍
修改裸金属节点电源状态,包括开机,关机和重启状态
URI
PUT /v1/nodes/{node_ident}/states/power
请求消息
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
node_ident | string | 是 | 裸金属节点UUID |
target | string | 是 | 目标电源状态,例如开机(power on),关机(power off),重启(rebooting) |
timeout | integer | 否 | 超时时间 |
响应消息
无
请求示例
{
"target": "power off"
}
正常响应示例
无
正常响应代码
202
错误码
400,406,409,503
设置裸金属节点维护状态
功能介绍
设置裸金属节点维护状态
URI
PUT /v1/nodes/{node_ident}/maintenance
请求消息
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
node_ident | string | 是 | 裸金属节点UUID |
reason | string | 否 | 进入维护模式的原因 |
响应消息
无
请求示例
{
"reason": "Replacing the hard drive"
}
正常响应示例
无
正常响应代码
202
错误码
无
取消裸金属节点维护状态
功能介绍
取消裸金属节点维护状态
URI
DELETE /v1/nodes/{node_ident}/maintenance
请求消息
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
node_ident | string | 是 | 裸金属节点UUID |
响应消息
无
请求示例
无
正常响应示例
无
正常响应代码
202
错误码
无
重置裸金属节点状态
功能介绍
对于进入故障状态的裸金属节点,可以通过重置节点状态进行恢复。
URI
PUT /v1/nodes/{node_indent}/states/provision
请求消息
参数 | 参数类型 | 是否必选 | 描述 |
---|---|---|---|
node_indent | string | 是 | 裸金属节点ID。 |
target | string | 是 | 节点目标状态。 |
configdrive | string或object | 否 | 节点配置信息。例如元数据,用户数据等写入到节点启动盘的一个分区。 |
clean_steps | array | 否 | 节点清理操作步骤列表。 |
rescue_password | string | 否 | 节点救援ramdisk密码。 |
响应消息
无
请求示例
{
"target": "clean",
"clean_steps": [
{
"interface": "deploy",
"step": "upgrade_firmware",
"args": {
"force": "True"
}
}
]
}
正常响应示例
无
正常响应代码
202
错误码
409,400,406,503