文档首页/ 裸金属服务器 BMS/ API参考/ API/ 裸金属服务器状态管理/ 修改裸金属服务器名称 - ChangeBaremetalServerName
更新时间：2025-10-31 GMT+08:00
编辑
查看PDF
分享

修改裸金属服务器名称 - ChangeBaremetalServerName

功能介绍

修改裸金属服务器名称。

约束

裸金属服务器名称取值范围：

只能由中文字符、英文字母（a~z，A~Z）、数字（0~9）、下划线（_）、中划线（-）、点（.）组成，且长度为[1-63]个字符。

本接口只修改裸金属服务器的实例名称，但hostname不能同步修改。重启裸金属服务器后生效。

调试

您可以在API Explorer中调试该接口。

URI

PUT /v1/{project_id}/baremetalservers/{server_id}

参数说明请参见表1。

表1 参数说明

参数

是否必选

描述

project_id

是

项目ID。

获取方式请参见获取项目ID。

server_id

是

裸金属服务器ID。

可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（废弃）获取。

请求参数

参数

是否必选

参数类型

描述

server

是

Object

裸金属服务器数据结构。详情请参见表2。
表2 server字段数据结构说明

参数

是否必选

参数类型

描述

name

是

String

修改后的裸金属服务器名称。

请求示例

修改裸金属服务器ID为95bf2490-5428-432c-ad9b-5e3406f869dd的名称为new-server-test。 
1
 
PUT https://{BMS Endpoint}/v1/c685484a8cc2416b97260938705deb65/baremetalservers/95bf2490-5428-432c-ad9b-5e3406f869dd

1
2
3
4
5
6
 
{
  "server":
    {
      "name": "new-server-test"
    }
}

响应参数

参数

参数类型

描述

server

Object

裸金属服务器信息。详情请参见表3。
表3 server字段数据结构说明

参数

参数类型

描述

name

String

裸金属服务器名称。

id

String

裸金属服务器唯一标识ID。

status

String

裸金属服务器当前状态。

  • ACTIVE：运行中/正在关机/删除中
  • BUILD：创建中
  • ERROR：故障
  • HARD_REBOOT：强制重启中
  • REBOOT：重启中
  • 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

裸金属服务器规格信息。详情请参见表6。

image

Object

裸金属服务器镜像信息。详情请参见表7。

tenant_id

String

裸金属服务器所属租户ID，格式为UUID。

该参数和project_id表示相同的概念。

key_name

String

SSH密钥名称。

user_id

String

裸金属服务器所属用户ID。

metadata

Object

裸金属服务器元数据。

属性为Map<String, String>结构。

详情请参见表9。

hostId

String

裸金属服务器的主机ID。

addresses

Object

裸金属服务器对应的网络地址信息。

属性为Map<String, Object>结构。

详情请参见表10。

security_groups

Array of objects

裸金属服务器所属安全组列表。详情请参见表12。

links

Array of objects

裸金属服务器相关信息快捷链接。详情请参见表8。

OS-DCF:diskConfig

String

扩展属性，磁盘配置方式，取值为如下两种：

  • MANUAL：API使用镜像中的分区方案和文件系统创建裸金属服务器。如果目标flavor磁盘较大，则API不会对剩余磁盘空间进行分区。
  • AUTO：API使用与目标flavor磁盘大小相同的单个分区创建裸金属服务器，API会自动调整文件系统以适应整个分区。

OS-EXT-AZ:availability_zone

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_state

Integer

扩展属性，裸金属服务器电源状态。例如：

  • 0表示“NO STATE”
  • 1表示“RUNNING”
  • 4表示“SHUTDOWN”

OS-EXT-STS:task_state

String

扩展属性，裸金属服务器任务状态。例如：

  • rebooting：重启中
  • reboot_started：普通重启
  • reboot_started_hard：强制重启
  • powering-off：关机中
  • powering-on：开机中
  • rebuilding：重建中
  • scheduling：调度中
  • deleting：删除中

OS-EXT-STS:vm_state

String

扩展属性，裸金属服务器状态。例如：

  • active：运行中
  • stopped：关机

OS-SRV-USG:launched_at

String

扩展属性，裸金属服务器启动时间。

时间戳格式为ISO 8601，例如：2019-05-25T03:40:25.000000

OS-SRV-USG:terminated_at

String

扩展属性，裸金属服务器关闭时间。

时间戳格式为ISO 8601，例如：2019-06-25T03:40:25.000000

os-extended-volumes:volumes_attached

Array of objects

裸金属服务器挂载的云硬盘信息。详情请参见表13。

accessIPv4

String

预留属性。

accessIPv6

String

预留属性。

fault

Object

裸金属服务器故障原因。详情请参见表14。

config_drive

String

预留属性。

progress

Integer

预留属性。

description

String

裸金属服务器的描述信息。

host_status

String

裸金属服务器宿主机状态。

  • UP：服务正常
  • UNKNOWN：状态未知
  • DOWN：服务异常
  • MAINTENANCE：维护状态
  • 空字符串：裸金属服务器无主机信息

OS-EXT-SRV-ATTR:hostname

String

裸金属服务器的主机名。

OS-EXT-SRV-ATTR:reservation_id

String

批量创建场景，裸金属服务器的预留ID。

当批量创建裸金属服务器时，这些服务器将拥有相同的reservation_id。

OS-EXT-SRV-ATTR:launch_index

Integer

批量创建场景，裸金属服务器的启动顺序。

OS-EXT-SRV-ATTR:kernel_id

String

若使用AMI格式的镜像，则表示kernel image的UUID；否则，留空。

OS-EXT-SRV-ATTR:ramdisk_id

String

若使用AMI格式镜像，则表示ramdisk image的UUID；否则，留空。

OS-EXT-SRV-ATTR:root_device_name

String

裸金属服务器系统盘的设备名称，例如“/dev/sdb”。

OS-EXT-SRV-ATTR:user_data

String

创建裸金属服务器时指定的user_data。取值为base64编码后的结果或空字符串。

locked

Boolean

裸金属服务器实例是否为锁定状态。

  • true：锁定
  • false：未锁定

tags

Array of strings

裸金属服务器标签。

sys_tags

Array of objects

裸金属服务器系统标签。详情请参考表4。

enterprise_project_id

String

企业项目ID。

os:scheduler_hints

Object

云服务器调度信息。详情请参考表5。
表4 sys_tags字段数据结构说明

参数

参数类型

描述

key

String

系统标签的Key值。

value

String

系统标签的value值。
表5 os:scheduler_hints字段数据结构说明（响应参数）

参数

参数类型

描述

group

Array of strings

云服务器组ID，UUID格式。
表6 flavor字段数据结构说明

参数

参数类型

描述

id

String

规格ID。

links

Array of objects

规格相关信息快捷链接。详情请参见表8。
表7 image字段数据结构说明

参数

参数类型

描述

id

String

裸金属服务器镜像ID。

links

Array of objects

裸金属服务器镜像相关快捷链接信息。详情请参见表8。
表8 links字段数据结构说明

参数

参数类型

描述

rel

String

快捷链接标记名称。取值为：

  • self：包含版本号的资源链接，需要立即跟踪时使用此类链接。
  • bookmark：提供了适合长期存储的资源链接。

href

String

对应快捷链接。
表9 metadata字段数据结构说明

参数

参数类型

描述

key

String

metadata键、值。

键、值长度均不大于255字节。
表10 addresses字段数据结构说明

参数

参数类型

描述

vpc_id

Array of objects

裸金属服务器所属网络信息。

  • key：表示裸金属服务器使用的虚拟私有云的ID。
  • value：网络详细信息，具体请参见表11。
表11 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地址方式。

  • fixed：代表私有IP地址。
  • floating：代表弹性IP地址。

OS-EXT-IPS:port_id

String

IP地址对应的端口ID。
表12 security_groups字段数据结构说明

参数

参数类型

描述

name

String
  • 创建裸金属服务器时未指定安全组，该值为default。
  • 创建裸金属服务器时，需要指定已有安全组的ID（UUID格式）。
表13 os-extended-volumes:volumes_attached字段数据结构说明

参数

参数类型

描述

id

String

云硬盘ID。

delete_on_termination

Boolean

删除裸金属服务器时是否一并删除该卷。

  • true：是
  • false：否
表14 fault字段数据结构说明

参数

参数类型

描述

message

String

故障信息。

code

Integer

故障code。

details

String

故障详情。

created

String

故障时间。

时间戳格式为ISO 8601：YYYY-MM-DDTHH:MM:SSZ，例如：2019-05-22T03:30:52Z

响应示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
{ 
     "server": { 
         "tenant_id": "c685484a8cc2416b97260938705deb65", 
         "addresses": { 
             "vpc_id": [  
                 { 
                     "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:0e:c4:77", 
                     "OS-EXT-IPS:type": "fixed",
                     "OS-EXT-IPS:port_id": "0c111191-9785-49e6-8b42-66ef2802bd8f",
                     "addr": "192.168.0.107", 
                     "version": 4 
                 } 
             ] 
         }, 
         "metadata": { 
             "key": "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": [ 
             { 
                 "id": "dfa375b5-9856-44ad-a937-a4802b6434c3" 
             }, 
             { 
                 "id": "bb9f1b27-843b-4561-b62e-ca18eeaec417" 
             }, 
             { 
                 "id": "86e801c3-acc6-465d-890c-d43ba493f553" 
             }, 
             { 
                 "id": "0994d3ac-3c6a-495c-a439-c597a4f08fa6" 
             } 
         ], 
         "OS-EXT-SRV-ATTR:host": "bms.az-dc-1", 
         "image": { 
             "links": [ 
                 { 
                     "rel": "bookmark", 
                     "href": "https://bms.az0.dc1.domainname.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319" 
                 } 
             ], 
             "id": "1a6635d8-afea-4f2b-abb6-27a202bad319" 
         }, 
         "OS-SRV-USG:terminated_at": null, 
         "accessIPv4": "", 
         "accessIPv6": "", 
         "created": "2017-05-24T06:14:05Z", 
         "hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e", 
         "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova004@2", 
         "key_name": "$key_name", 
         "flavor": { 
             "links": [ 
                 { 
                     "rel": "bookmark", 
                     "href": "https://bms.az0.dc1.domainname.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium" 
                 } 
             ], 
             "id": "physical.83.medium" 
         }, 
         "security_groups": [ 
             { 
                 "name": "0011b620-4982-42e4-ad12-47c95ca495c4" 
             } 
         ], 
         "config_drive": "", 
         "OS-EXT-STS:vm_state": "active", 
         "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", 
         "status": "ACTIVE" 
     } 
 }

返回值

正常返回值：

返回值

说明

200

服务器已成功处理了请求。

其他返回值请参考状态码。

错误码

请参考错误码。

相关文档