裸金属主机

裸金属主机列表

功能介绍

获取用户所在租户的裸金属主机列表

URI

GET /v2.1/{tenant_id}/servers

请求消息

参数	参数类型	是否必选	描述
tenant_id	string	是	项目ID
root_device_name	string	否	根据裸金属主机的根设备名称过滤
access_ip_v4	string	否	根据裸金属主机的IPv4地址过滤
access_ip_v6	string	否	根据裸金属主机的IPv6地址过滤
all_tenants	boolean	否	查询所有项目的所有实例。限仅管理员使用
auto_disk_config	string	否	按裸金属主机的磁盘设置过滤
availability_zone	string	否	按裸金属主机可用区过滤
config_drive	boolean	否	按裸金属主机的配置驱动器过滤
changes-since	string	否	按裸金属主机的修改时间过滤
created_at	string	否	按裸金属主机的创建时间过滤
deleted	boolean	否	显示已删除的项目
description	string	否	按描述信息过滤
flavor	string	否	按裸金属主机规格过滤
host	string	否	按计算节点的主机名过滤
hostname	string	否	按裸金属主机的主机名过滤
image	string	否	按裸金属主机镜像过滤
ip	string	否	按IPv4地址过滤
ip6	string	否	按IPv6地址过滤
kernel_id	string	否	使用AMI时，按内核镜像ID过滤
key_name	string	否	按密钥对名称过滤
launch_index	string	否	按裸金属主机启动的顺序过滤
launched_at	string	否	按启动实例的时间过滤
limit	integer	否	返回列表的长度限制
locked_by	string	否	按裸金属主机的锁定人过滤
name	string	否	按裸金属主机名称过滤
node	string	否	按计算节点过滤
not-tags	string	否	按裸金属主机的标签过滤
not-tags-any	string	否	按裸金属主机列表的标签过滤
power_state	string	否	按裸金属主机电源状态过滤
progress	string	否	按裸金属主机的创建进度过滤
project_id	string	否	按项目ID过滤
ramdisk_id	string	否	使用AMI时，按ramdisk镜像ID过滤
sort_dir	string	否	排序方式，asc升序或desc降序。默认是desc
sort_key	string	否	按裸金属主机属性排序
status	string	否	按裸金属主机状态过滤
tags	string	否	按云主机标签过滤
task_state	string	否	按裸金属主机的任务状态过滤
terminated_at	string	否	按裸金属主机终止时间过滤
user_id	string	否	按用户ID过滤
uuid	string	否	按裸金属主机UUID过滤
vm_state	string	否	按裸金属主机状态过滤

响应消息

参数	参数类型	描述
servers	array	裸金属主机列表
id	string	裸金属主机UUID
links	array	链接的资源
name	string	裸金属主机名称

请求示例

无

正常响应示例

{
    "servers": [
        {
            "id": "22c91117-08de-4894-9aa9-6ef382400985",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/6f70656e737461636b20342065766572/servers/22c91117-08de-4894-9aa9-6ef382400985",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/6f70656e737461636b20342065766572/servers/22c91117-08de-4894-9aa9-6ef382400985",
                    "rel": "bookmark"
                }
            ],
            "name": "new-server-test"
        }
    ]
}

正常响应代码

200

错误码

无

创建裸金属主机

功能介绍

创建裸金属主机

URI

POST /v2.1/{tenant_id}/servers

请求消息

参数	参数类型	是否必选	描述
server	object	是	裸金属主机信息
flavorRef	string	是	裸金属主机规格
availability_zone	string	是	裸金属主机可用区。参数格式为{az_name}:{hypervisor_hostname}:{node_uuid}，其中，az_name是可用区名称，hypervisor_hostname是裸金属节点的hypervisor hostname，node_uuid是裸金属节点ID
name	string	是	裸金属主机名称
networks	array	是	裸金属主机网络对象列表
networks.uuid	string	否	要为裸金属主机实例提供网络网卡，请在网络对象的UUID属性中指定网络的UUID
networks.port	string	否	裸金属主机网络端口UUID
networks.fixed_ip	string	否	裸金属主机网卡IPv4地址
networks.tag	string	否	裸金属主机网络接口的设备角色标签
accessIPv4	string	否	访问裸金属主机的IPv4地址
accessIPv6	string	否	访问裸金属主机的IPv6地址
adminPass	string	否	裸金属主机管理员密码
imageRef	string	是	用于创建裸金属实例的镜像的 UUID
key_name	string	否	密钥对名称
metadata	object	是	元数据键值对。使用{‘reserve_instance_type’: ‘baremetal’} 区分裸金属主机和云主机
user_data	string	否	Base64编码的启动时使用的配置信息或脚本。如果开启裸金属主机监控，则需传入监控脚本
description	string	否	裸金属主机的描述
tags	string	否	标签列表

响应消息

参数	参数类型	描述
server	object	裸金属主机对象
addresses	object	裸金属主机地址
created	string	裸金属主机创建的时间
flavor	string	裸金属主机使用的规格
hostid	string	裸金属主机的宿主机 ID
id	string	裸金属主机的 UUID
image	object	用于创建裸金属主机的镜像的信息
key_name	string	密钥对名称
links	array	链接信息
metadata	object	元数据键值对
name	string	裸金属主机名称
accessIPv4	string	用于访问该裸金属主机的 IPv4 地址
accessIPv6	string	用于访问该裸金属主机的 IPv6 地址
OS-DCF:diskconfig	string	控制如何对磁盘进行分区
OS-EXT-AZ:availability_zone	string	可用区名称
OS-EXT-SRV-ATTR:host	string	宿主机名称
OS-EXT-SRV-ATTR:hypervisor_hostname	string	创建裸金属主机的管理程序的主机名
OS-EXT-SRC-ATTR:instance_name	string	裸金属主机名称
OS-EXT-STS:power_state	integer	裸金属主机状态
OS-EXT-STS:take_state	string	裸金属主机工作状态
OS-EXT-STS:vm_state	string	裸金属主机运行状态
os-extended-volumes:volumes_attached	string	挂载的云盘列表
OS-SRV-USG:launched_at	string	裸金属主机创建的日期
OS-SRV-USG:terminated_at	string	裸金属主机删除的日期
progress	integer	裸金属主机创建进度
security_groups	array	一个或多个安全组对象
security_group.name	string	安全组名称
status	string	裸金属主机状态
host_status	string	裸金属主机宿主机状态
tenant_id	string	项目 ID
updated	string	裸金属主机更新时间
user_id	string	裸金属主机用户 ID
OS-EXT-SERV-ATTR:hostname	string	裸金属主机启动时的主机名
OS-EXT-SERV-ATTR:reservation_id	string	裸金属主机资源预留 ID
OS-EXT-SERV-ATTR:launch_index	integer	同时创建多个裸金属主机时的顺序
OS-EXT-SERV-ATTR:kernel_id	string	使用 AMI 镜像时的内核镜像 ID
OS-EXT-SERV-ATTR:ramdisk_id	string	使用 AMI 镜像时的内存镜像 ID
OS-EXT-SERV-ATTR:root_device_name	string	裸金属主机系统盘名称
OS-EXT-SERV-ATTR:user_data	string	启动时使用的配置信息或脚本。 Base64 编码

请求示例

{
    "server" : {
        "name" : "test_bm_1",
        "flavorRef" : "211",
        "availability_zone": "default-az:f3703ade-d29e-436c-a6e7-008240bb6fbe:46d0add1-5e77-407f-a394-e61d1c85efe6",
        "adminPass": "Admin123",
        "OS-DCF:diskConfig": "AUTO",
        "metadata" : {
            "My Server Name" : "Apache1"，
            "reserve_instance_type": "baremetal"
        },
        "security_groups": [
            {
                "name": "default"
            }
        ],
        "networks": [
            {
                "uuid": "11aabbae-14ac-4546-b8a5-1c8ee36b302b"
            }
        ]
        "user_data" : "IyEvYmluL2Jhc2gKL2Jpbi9zdQplY2hvICJJIGFtIGluIHlvdSEiCg=="
    },
}

正常响应示例

{
    "server": {
        "OS-DCF:diskConfig": "AUTO",
        "adminPass": "6NpUwoz2QDRN",
        "id": "f5dc173b-6804-445a-a6d8-c705dad5b5eb",
        "links": [
            {
                "href": "fake_href",
                "rel": "self"
            },
            {
                "href": "fake_href",
                "rel": "bookmark"
            }
        ],
        "security_groups": [
            {
                "name": "default"
            }
        ]
    }
}

正常响应代码

201

错误码

无

启动裸金属主机

功能介绍

启动裸金属主机

URI

POST /v2.1/{tenant_id}/servers/{server_id}/action

请求消息

参数	参数类型	是否必选	描述
tenant_id	string	是	租户ID
server_id	string	是	裸金属主机UUID
os-start	none	是	启动操作

响应消息

无

请求示例

{
    "os-start" : null
}

正常响应示例

无

正常响应代码

200

错误码

无

关闭裸金属主机

功能介绍

关闭裸金属主机

URI

POST /v2.1/{tenant_id}/servers/{server_id}/action

请求消息

参数	参数类型	是否必选	描述
tenant_id	string	是	租户ID
server_id	string	是	裸金属主机UUID
os-stop	none	是	启动操作

响应消息

无

请求示例

{
    "os-stop" : null
}

正常响应示例

无

正常响应代码

200

错误码

无

重启裸金属主机

功能介绍

重启裸金属主机

URI

POST /v2.1/{tenant_id}/servers/{server_id}/action

请求消息

参数	参数类型	是否必选	描述
tenant_id	string	是	租户ID
server_id	string	是	裸金属主机UUID
reboot	object	是	重启裸金属主机的动作
type	string	是	重启的类型。HARD 表示硬重启， SOFT 表示软重启。

响应消息

无

请求示例

{
    "reboot": {
        "type": "SOFT"
    }
}

正常响应示例

无

正常响应代码

200

错误码

无

删除裸金属主机

功能介绍

删除裸金属主机

URI

DELETE /v2.1/{tenant_id}/servers/{server_id}/action

请求消息

参数	参数类型	是否必选	描述
tenant_id	string	是	租户ID
server_id	string	是	裸金属主机UUID
forceDelete	none	是	删除操作

响应消息

无

请求示例

{
    "forceDelete": null
}

正常响应示例

无

正常响应代码

204

错误码

无

重建裸金属主机

功能介绍

重建裸金属主机

URI

POST /v2.1/{project_id}/servers/{server_id}/action

请求消息

参数	参数类型	是否必选	描述
server_id	string	是	裸金属主机UUID
project_id	string	是	项目UUID
rebuild	object	是	重建动作
imageRef	string	是	重建使用的镜像 UUID
name	string	否	重建的裸金属主机名称
adminPass	string	否	重建的裸金属主机名称
metadata	object	否	重建裸金属主机要使用的元数据

响应消息

无

请求示例

{
    "rebuild" : {
        "imageRef" : "70a599e0-31e7-49b7-b260-868f441e862b",
        "name" : "foobar",
        "description" : "description of foobar",
        "adminPass" : "seekr3t",
        "metadata" : {
            "meta_var" : "meta_val"
        }
    }
}

正常响应示例

无

正常响应代码

200

错误码

无

裸金属主机控制台

功能介绍

裸金属主机控制台

URI

POST /v2.1/{project_id}/servers/{server_id}/action

请求消息

参数	参数类型	是否必选	描述
server_id	string	是	裸金属主机UUID
project_id	string	是	项目UUID
os-getSerialConsole	object	是	裸金属主机控制台操作
type	string	是	控制台类型，只支持唯一值serial

响应消息

参数	参数类型	描述
console	object	裸金属主机控制台对象
type	string	控制台类型，唯一值serial
url	string	访问裸金属主机控制台的URL

请求示例

{
    "os-getSerialConsole": {
        "type": "serial"
    }
}

正常响应示例

{
    "console": {
        "type": "serial",
        "url":"ws://127.0.0.1:6083/?token=f9906a48-b71e-4f18-baca-c987da3ebdb3"
    }
}

正常响应代码

200

错误码

无