4.4 裸金属服务器状态管理
4.4.1 修改裸金属服务器名称
功能介绍
修改裸金属服务器名称。
约束
裸金属服务器名称取值范围：
只能由中文字符、英文字母（a~z，A~Z）、数字（0~9）、下划线（_）、中划线
（-）、点（.）组成，且长度为[1-63]个字符。
说明
本接口只修改裸金属服务器的实例名称，但hostname不能同步修改。重启裸金属服务器后生 效。
调试
您可以在API Explorer中调试该接口。
URI
PUT /v1/{project_id}/baremetalservers/{server_id}
参数说明请参见表4-34。
表4-34 参数说明
参数 是否必选 描述
project_id 是 项目ID。
获取方式请参见获取项目ID。
server_id 是 裸金属服务器ID。
可以从裸金属服务器控制台查询，或者通 过调用查询裸金属服务器列表
（OpenStack原生）API获取。
请求消息
● 请求参数
参数 是否必选 参数类型 描述
server 是 Object 裸金属服务器数据结构。详
情请参见表4-35。
表4-35 server 字段数据结构说明
参数 是否必选 参数类型 描述
name 是 String 修改后的裸金属服务器名
称。
● 请求样例
PUT https://{BMS Endpoint}/v1/c685484a8cc2416b97260938705deb65/baremetalservers/
95bf2490-5428-432c-ad9b-5e3406f869dd { "server":
{
"name": "new-server-test"
} }
响应消息
● 响应参数
参数 参数类型 描述
server Object 裸金属服务器信息。详情请参见表4-36。
表4-36 server 字段数据结构说明
参数 参数类型 描述
name String 裸金属服务器名称。
id String 裸金属服务器唯一标识ID。
参数 参数类型 描述
status String 裸金属服务器当前状态。
● ACTIVE：运行中/正在关机/
删除中
● BUILD：创建中
● ERROR：故障
● HARD_REBOOT：强制重启 中
● REBOOT：重启中
● DELETED：实例已被正常删 除
● SHUTOFF：关机/正在开机/
删除中/重建中/重装操作系 统中/重装操作系统失败/冻 结
created String 裸金属服务器创建时间。
时间戳格式为ISO 8601：YYYY-MM-DDTHH:MM:SSZ，例如：
2019-05-22T03:30:52Z
updated String 裸金属服务器上一次更新时
间。
时间戳格式为ISO 8601：YYYY-MM-DDTHH:MM:SSZ，例如：
2019-05-22T04:30:52Z
flavor Object 裸金属服务器规格信息。详情
请参见表4-39。
image Object 裸金属服务器镜像信息。详情
请参见表4-40。
tenant_id String 裸金属服务器所属租户ID，格 式为UUID。
该参数和project_id表示相同的 概念。
key_name String SSH密钥名称。
user_id String 裸金属服务器所属用户ID。
metadata Object 裸金属服务器元数据。详情请
参见表4-42。
hostId String 裸金属服务器的主机ID。
addresses Object 裸金属服务器对应的网络地址 信息。详情请参见表4-43。
参数 参数类型 描述
security_groups Array of objects 裸金属服务器所属安全组列 表。详情请参见表4-45。
links Array of objects 裸金属服务器相关信息快捷链 接。详情请参见表4-41。
OS-DCF:diskConfig String 扩展属性，磁盘配置方式，取 值为如下两种：
● MANUAL：API使用镜像中 的分区方案和文件系统创建 裸金属服务器。如果目标 flavor磁盘较大，则API不会 对剩余磁盘空间进行分区。
● AUTO：API使用与目标 flavor磁盘大小相同的单个分 区创建裸金属服务器，API会 自动调整文件系统以适应整 个分区。
OS-EXT-AZ:availability_z one
String 扩展属性，裸金属服务器所在
可用区名称。
OS-EXT-SRV-ATTR:host String 扩展属性，裸金属服务器宿主 机名称。
OS-EXT-SRV-ATTR:hypervisor _hostname
String 扩展属性，裸金属服务器所在
虚拟化主机名。
OS-EXT-SRV-ATTR:instance_
name
String 扩展属性，裸金属服务器别
名。
OS-EXT-STS:power_stat e
Integer 扩展属性，裸金属服务器电源
状态。例如：
● 0表示“NO STATE”
● 1表示“RUNNING”
● 4表示“SHUTDOWN”
参数 参数类型 描述
OS-EXT-STS:task_state String 扩展属性，裸金属服务器任务 状态。例如：
OS-EXT-STS:vm_state String 扩展属性，裸金属服务器状 态。例如：
Array of objects 裸金属服务器挂载的云硬盘信 息。详情请参见表4-46。
accessIPv4 String 预留属性。
accessIPv6 String 预留属性。
fault Object 裸金属服务器故障原因。详情
请参见表4-47。
config_drive String 预留属性。
progress Integer 预留属性。
description String 裸金属服务器的描述信息。
参数 参数类型 描述
host_status String 裸金属服务器宿主机状态。
● UP：服务正常
OS-EXT-SRV-ATTR:hostname String 裸金属服务器的主机名。
OS-EXT-SRV-ATTR:kernel_id String 若使用AMI格式的镜像，则表示 kernel image的UUID；否则，
OS-EXT-SRV-ATTR:user_data String 创建裸金属服务器时指定的 user_data。取值为base64编码 后的结果或空字符串。
locked Boolean 裸金属服务器实例是否为锁定
状态。
● true：锁定
● false：未锁定 tags Array of strings 裸金属服务器标签。
sys_tags Array of objects 裸金属服务器系统标签。
enterprise_proje
ct_id String 企业项目id。
os:scheduler_hi
nts Object 云服务器调度信息。
表4-37 sys_tags 字段数据结构说明
参数 参数类型 描述
key String 系统标签的Key值。
value String 系统标签的value值。
表4-38 os:scheduler_hints 字段数据结构说明（响应参数）
参数 参数类型 描述
group Array of
strings 云服务器组ID，UUID格式。
表4-39 flavor 字段数据结构说明
参数 参数类型 描述
id String 规格ID。
links Array of objects 规格相关信息快捷链接。详情请参见表 4-41。
表4-40 image 字段数据结构说明
参数 参数类型 描述
id String 裸金属服务器镜像ID。
links Array of objects 裸金属服务器镜像相关快捷链接信息。
详情请参见表4-41。
表4-41 links 字段数据结构说明
参数 参数类型 描述
rel String 快捷链接标记名称。取值为：
● self：包含版本号的资源链接，需要 立即跟踪时使用此类链接。
● bookmark：提供了适合长期存储的 资源链接。
href String 对应快捷链接。
表4-42 metadata 字段数据结构说明
参数 参数类型 描述
key String metadata键、值。
键、值长度均不大于255字节。
表4-43 addresses 字段数据结构说明
参数 参数类型 描述
vpc_id Array of objects 裸金属服务器所属网络信息。
● key：表示裸金属服务器使用的虚拟 私有云的ID。
● value：网络详细信息，具体请参见 表4-44。
表4-44 address 字段数据结构说明
参数 参数类型 描述
addr String IP地址信息。
version Integer IP地址类型，值为4或6。
● 4：IP地址类型是IPv4
● 6：IP地址类型是IPv6
OS-EXT-IPS-MAC:mac_addr String 扩展属性，MAC地址。
OS-EXT-IPS:type String 扩展属性，分配IP地址方式。
OS-EXT-IPS:port_id String IP地址对应的端口ID。
表4-45 security_groups 字段数据结构说明
参数 参数类型 描述
name String ● 创建裸金属服务器时未指定安全组，
该值为default。
● 创建裸金属服务器时，需要指定已有 安全组的ID（UUID格式）。
表4-46 os-extended-volumes:volumes_attached 字段数据结构说明
参数 参数类型 描述
id String 云硬盘ID。
delete_on_termi
nation Boolean 删除裸金属服务器时是否一并删除该 卷。
● true：是
● false：否
表4-47 fault 字段数据结构说明
参数 参数类型 描述
message String 故障信息。
code Integer 故障code。
details String 故障详情。
created String 故障时间。
时间戳格式为ISO 8601：YYYY-MM-DDTHH:MM:SSZ，例如：
2019-05-22T03:30:52Z
● 响应样例
{ "server": {
"tenant_id": "c685484a8cc2416b97260938705deb65", "addresses": {
"op_svc_userid": "1311c433dd9b408886f57d695c229cbe"
},
"OS-EXT-STS:task_state": null, "OS-DCF:diskConfig": "MANUAL", "OS-EXT-AZ:availability_zone": "az-dc-1", "links": [
{
"rel": "self",
"href": "https://bms.az0.dc1.domainname.com/v2.1/c685484a8cc2416b97260938705deb65/
servers/95bf2490-5428-432c-ad9b-5e3406f869dd"
}, {
"rel": "bookmark",
"href": "https://bms.az0.dc1.domainname.com/c685484a8cc2416b97260938705deb65/
servers/95bf2490-5428-432c-ad9b-5e3406f869dd"
} ],
"OS-EXT-STS:power_state": 1,
"id": "95bf2490-5428-432c-ad9b-5e3406f869dd", "os-extended-volumes:volumes_attached": [ {
"href": "https://bms.az0.dc1.domainname.com/c685484a8cc2416b97260938705deb65/
images/1a6635d8-afea-4f2b-abb6-27a202bad319"
"hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e", "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova004@2",
"key_name": "KeyPair-JX", "flavor": {
"links": [ {
"rel": "bookmark",
"href": "https://bms.az0.dc1.domainname.com/c685484a8cc2416b97260938705deb65/
flavors/physical.83.medium"
"OS-EXT-SRV-ATTR:instance_name": "instance-0000ebd3", "user_id": "1311c433dd9b408886f57d695c229cbe", "name": "bms-83",
"progress": 0,
"OS-SRV-USG:launched_at": "2017-05-25T03:40:25.066078", "updated": "2017-05-25T03:40:25Z",
其他返回值请参考状态码。
错误码
请参考错误码。