功能介绍
修改 裸金属服务器 名称。
约束
裸金属服务器名称取值范围:
只能由中文字符、英文字母(a~z,A~Z)、数字(0~9)、下划线(_)、中划线(-)、点(.)组成,且长度为[1-63]个字符。
本接口只修改裸金属服务器的实例名称,但hostname不能同步修改。重启裸金属服务器后生效。
调试
您可以在API Explorer中调试该接口。
URI
PUT /v1/{project_id}/baremetalservers/{server_id}
参数 |
是否必选 |
描述 |
---|---|---|
project_id |
是 |
项目ID。 获取方式请参见获取项目ID。 |
server_id |
是 |
裸金属服务器ID。 可以从裸金属服务器控制台查询,或者通过调用查询裸金属服务器列表(OpenStack原生)API获取。 |
请求参数
请求示例
PUT https://{BMS Endpoint}/v1/c685484a8cc2416b97260938705deb65/baremetalservers/95bf2490-5428-432c-ad9b-5e3406f869dd |
{ "server": { "name": "new-server-test" } } |
响应参数
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
裸金属服务器名称。 |
id |
String |
裸金属服务器唯一标识ID。 |
status |
String |
裸金属服务器当前状态。
|
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 |
|
image |
Object |
裸金属服务器 镜像 信息。详情请参见表7。 |
tenant_id |
String |
裸金属服务器所属租户ID,格式为UUID。 该参数和project_id表示相同的概念。 |
key_name |
String |
SSH密钥名称。 |
user_id |
String |
裸金属服务器所属用户ID。 |
metadata |
Object |
|
hostId |
String |
裸金属服务器的主机ID。 |
addresses |
Object |
|
security_groups |
Array of objects |
|
links |
Array of objects |
|
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-SRV-ATTR:instance_name |
String |
扩展属性,裸金属服务器别名。 |
OS-EXT-STS:power_state |
Integer |
扩展属性,裸金属服务器电源状态。例如:
|
OS-EXT-STS:task_state |
String |
扩展属性,裸金属服务器任务状态。例如:
|
OS-EXT-STS:vm_state |
String |
扩展属性,裸金属服务器状态。例如:
|
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 |
|
config_drive |
String |
预留属性。 |
progress |
Integer |
预留属性。 |
description |
String |
裸金属服务器的描述信息。 |
host_status |
String |
裸金属服务器宿主机状态。
|
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 |
裸金属服务器实例是否为锁定状态。
|
tags |
Array of strings |
裸金属服务器标签。 |
sys_tags |
Array of objects |
|
ent erp rise_project_id |
String |
企业项目ID。 |
os:scheduler_hints |
Object |
云服务器 调度信息。详情请参考表5。 |
参数 |
参数类型 |
描述 |
---|---|---|
rel |
String |
快捷链接标记名称。取值为:
|
href |
String |
对应快捷链接。 |
参数 |
参数类型 |
描述 |
---|---|---|
vpc_id |
Array of objects |
裸金属服务器所属网络信息。
|
参数 |
参数类型 |
描述 |
---|---|---|
addr |
String |
IP地址信息。 |
version |
Integer |
IP地址类型,值为4或6。
|
OS-EXT-IPS-MAC:mac_addr |
String |
扩展属性,MAC地址。 |
OS-EXT-IPS:type |
String |
扩展属性,分配IP地址方式。 |
OS-EXT-IPS:port_id |
String |
IP地址对应的端口ID。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
|
响应示例
{ "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", }, { "rel": "bookmark", } ], "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", } ], "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": "KeyPair-JX", "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" } } |
错误码
请参考错误码。