華為云計(jì)算 云知識(shí) 修改裸金屬服務(wù)器名稱ChangeBaremetalServerName
修改裸金屬服務(wù)器名稱ChangeBaremetalServerName
時(shí)間: 2023-07-27 15:16:17
猜你想看：
實(shí)時(shí)語(yǔ)音識(shí)別 云服務(wù)器配置 CDN是什么意思 視頻點(diǎn)播加速 什么是云桌面

 

功能介紹

修改 裸金屬服務(wù)器 名稱。

約束

裸金屬服務(wù)器名稱取值范圍：

只能由中文字符、英文字母（a~z，A~Z）、數(shù)字（0~9）、下劃線（_）、中劃線（-）、點(diǎn)（.）組成，且長(zhǎng)度為[1-63]個(gè)字符。

本接口只修改裸金屬服務(wù)器的實(shí)例名稱，但hostname不能同步修改。重啟裸金屬服務(wù)器后生效。

調(diào)試

您可以在API Explorer中調(diào)試該接口。

URI

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

參數(shù)說(shuō)明請(qǐng)參見(jiàn)表1。

表1 參數(shù)說(shuō)明

參數(shù)

是否必選

描述

project_id

是

項(xiàng)目ID。

獲取方式請(qǐng)參見(jiàn)獲取項(xiàng)目ID。

server_id

是

裸金屬服務(wù)器ID。

可以從裸金屬服務(wù)器控制臺(tái)查詢，或者通過(guò)調(diào)用查詢裸金屬服務(wù)器列表（OpenStack原生）API獲取。

請(qǐng)求參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

server

是

Object

裸金屬服務(wù)器數(shù)據(jù)結(jié)構(gòu)。詳情請(qǐng)參見(jiàn)表2。
表2 server字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

是否必選

參數(shù)類型

描述

name

是

String

修改后的裸金屬服務(wù)器名稱。

請(qǐng)求示例

修改裸金屬服務(wù)器ID為95bf2490-5428-432c-ad9b-5e3406f869dd的名稱為new-server-test。 
PUT https://{BMS Endpoint}/v1/c685484a8cc2416b97260938705deb65/baremetalservers/95bf2490-5428-432c-ad9b-5e3406f869dd

{
  "server":
    {
      "name": "new-server-test"
    }
}

響應(yīng)參數(shù)

參數(shù)

參數(shù)類型

描述

server

Object

裸金屬服務(wù)器信息。詳情請(qǐng)參見(jiàn)表3。
表3 server字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類型

描述

name

String

裸金屬服務(wù)器名稱。

id

String

裸金屬服務(wù)器唯一標(biāo)識(shí)ID。

status

String

裸金屬服務(wù)器當(dāng)前狀態(tài)。

  • ACTIVE：運(yùn)行中/正在關(guān)機(jī)/刪除中
  • BUILD：創(chuàng)建中
  • ERROR：故障
  • HARD_REBOOT：強(qiáng)制重啟中
  • REBOOT：重啟中
  • SHUTOFF：關(guān)機(jī)/正在開機(jī)/刪除中/重建中/重裝操作系統(tǒng)中/重裝操作系統(tǒng)失敗/凍結(jié)

created

String

裸金屬服務(wù)器創(chuàng)建時(shí)間。

時(shí)間戳格式為ISO 8601：YYYY-MM-DDTHH:MM:SSZ，例如：2019-05-22T03:30:52Z

updated

String

裸金屬服務(wù)器上一次更新時(shí)間。

時(shí)間戳格式為ISO 8601：YYYY-MM-DDTHH:MM:SSZ，例如：2019-05-22T04:30:52Z

flavor

Object

裸金屬服務(wù)器規(guī)格信息。詳情請(qǐng)參見(jiàn)表6。

image

Object

裸金屬服務(wù)器 鏡像 信息。詳情請(qǐng)參見(jiàn)表7。

tenant_id

String

裸金屬服務(wù)器所屬租戶ID，格式為UUID。

該參數(shù)和project_id表示相同的概念。

key_name

String

SSH密鑰名稱。

user_id

String

裸金屬服務(wù)器所屬用戶ID。

metadata

Object

裸金屬服務(wù)器元數(shù)據(jù)。詳情請(qǐng)參見(jiàn)表 metadata字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明。

hostId

String

裸金屬服務(wù)器的主機(jī)ID。

addresses

Object

裸金屬服務(wù)器對(duì)應(yīng)的網(wǎng)絡(luò)地址信息。詳情請(qǐng)參見(jiàn)表10。

security_groups

Array of objects

裸金屬服務(wù)器所屬安全組列表。詳情請(qǐng)參見(jiàn)表12。

links

Array of objects

裸金屬服務(wù)器相關(guān)信息快捷鏈接。詳情請(qǐng)參見(jiàn)表8。

OS-DCF:diskConfig

String

擴(kuò)展屬性，磁盤配置方式，取值為如下兩種：

  • MANUAL：API使用鏡像中的分區(qū)方案和文件系統(tǒng)創(chuàng)建裸金屬服務(wù)器。如果目標(biāo)flavor磁盤較大，則API不會(huì)對(duì)剩余磁盤空間進(jìn)行分區(qū)。
  • AUTO：API使用與目標(biāo)flavor磁盤大小相同的單個(gè)分區(qū)創(chuàng)建裸金屬服務(wù)器，API會(huì)自動(dòng)調(diào)整文件系統(tǒng)以適應(yīng)整個(gè)分區(qū)。

OS-EXT-AZ:availability_zone

String

擴(kuò)展屬性，裸金屬服務(wù)器所在可用區(qū)名稱。

OS-EXT-SRV-ATTR:host

String

擴(kuò)展屬性，裸金屬服務(wù)器宿主機(jī)名稱。

OS-EXT-SRV-ATTR:hypervisor_hostname

String

擴(kuò)展屬性，裸金屬服務(wù)器所在虛擬化主機(jī)名。

OS-EXT-SRV-ATTR:instance_name

String

擴(kuò)展屬性，裸金屬服務(wù)器別名。

OS-EXT-STS:power_state

Integer

擴(kuò)展屬性，裸金屬服務(wù)器電源狀態(tài)。例如：

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

OS-EXT-STS:task_state

String

擴(kuò)展屬性，裸金屬服務(wù)器任務(wù)狀態(tài)。例如：

  • rebooting：重啟中
  • reboot_started：普通重啟
  • reboot_started_hard：強(qiáng)制重啟
  • powering-off：關(guān)機(jī)中
  • powering-on：開機(jī)中
  • rebuilding：重建中
  • scheduling：調(diào)度中
  • deleting：刪除中

OS-EXT-STS:vm_state

String

擴(kuò)展屬性，裸金屬服務(wù)器狀態(tài)。例如：

  • active：運(yùn)行中
  • shutoff：關(guān)機(jī)
  • reboot：重啟

OS-SRV-USG:launched_at

String

擴(kuò)展屬性，裸金屬服務(wù)器啟動(dòng)時(shí)間。

時(shí)間戳格式為ISO 8601，例如：2019-05-25T03:40:25.000000

OS-SRV-USG:terminated_at

String

擴(kuò)展屬性，裸金屬服務(wù)器關(guān)閉時(shí)間。

時(shí)間戳格式為ISO 8601，例如：2019-06-25T03:40:25.000000

os-extended-volumes:volumes_attached

Array of objects

裸金屬服務(wù)器掛載的 云硬盤 信息。詳情請(qǐng)參見(jiàn)表13。

accessIPv4

String

預(yù)留屬性。

accessIPv6

String

預(yù)留屬性。

fault

Object

裸金屬服務(wù)器故障原因。詳情請(qǐng)參見(jiàn)表14。

config_drive

String

預(yù)留屬性。

progress

Integer

預(yù)留屬性。

description

String

裸金屬服務(wù)器的描述信息。

host_status

String

裸金屬服務(wù)器宿主機(jī)狀態(tài)。

  • UP：服務(wù)正常
  • UNKNOWN：狀態(tài)未知
  • DOWN：服務(wù)異常
  • MAINTENANCE：維護(hù)狀態(tài)
  • 空字符串：裸金屬服務(wù)器無(wú)主機(jī)信息

OS-EXT-SRV-ATTR:hostname

String

裸金屬服務(wù)器的主機(jī)名。

OS-EXT-SRV-ATTR:reservation_id

String

批量創(chuàng)建場(chǎng)景，裸金屬服務(wù)器的預(yù)留ID。

當(dāng)批量創(chuàng)建裸金屬服務(wù)器時(shí)，這些服務(wù)器將擁有相同的reservation_id。

OS-EXT-SRV-ATTR:launch_index

Integer

批量創(chuàng)建場(chǎng)景，裸金屬服務(wù)器的啟動(dòng)順序。

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

裸金屬服務(wù)器系統(tǒng)盤的設(shè)備名稱，例如“/dev/sdb”。

OS-EXT-SRV-ATTR:user_data

String

創(chuàng)建裸金屬服務(wù)器時(shí)指定的user_data。取值為base64編碼后的結(jié)果或空字符串。

locked

Boolean

裸金屬服務(wù)器實(shí)例是否為鎖定狀態(tài)。

  • true：鎖定
  • false：未鎖定

tags

Array of strings

裸金屬服務(wù)器標(biāo)簽。

sys_tags

Array of objects

裸金屬服務(wù)器系統(tǒng)標(biāo)簽。詳情請(qǐng)參考表4。

enterprise_project_id

String

企業(yè)項(xiàng)目ID。

os:scheduler_hints

Object

云服務(wù)器 調(diào)度信息。詳情請(qǐng)參考表5。
表4 sys_tags字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類型

描述

key

String

系統(tǒng)標(biāo)簽的Key值。

value

String

系統(tǒng)標(biāo)簽的value值。
表5 os:scheduler_hints字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明（響應(yīng)參數(shù)）

參數(shù)

參數(shù)類型

描述

group

Array of strings

云服務(wù)器組ID，UUID格式。
表6 flavor字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類型

描述

id

String

規(guī)格ID。

links

Array of objects

規(guī)格相關(guān)信息快捷鏈接。詳情請(qǐng)參見(jiàn)表8。
表7 image字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類型

描述

id

String

裸金屬服務(wù)器鏡像ID。

links

Array of objects

裸金屬服務(wù)器鏡像相關(guān)快捷鏈接信息。詳情請(qǐng)參見(jiàn)表8。
表8 links字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類型

描述

rel

String

快捷鏈接標(biāo)記名稱。取值為：

  • self：包含版本號(hào)的資源鏈接，需要立即跟蹤時(shí)使用此類鏈接。
  • bookmark：提供了適合長(zhǎng)期存儲(chǔ)的資源鏈接。

href

String

對(duì)應(yīng)快捷鏈接。
表9 metadata字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類型

描述

key

String

metadata鍵、值。

鍵、值長(zhǎng)度均不大于255字節(jié)。
表10 addresses字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類型

描述

vpc_id

Array of objects

裸金屬服務(wù)器所屬網(wǎng)絡(luò)信息。

  • key：表示裸金屬服務(wù)器使用的 虛擬私有云 的ID。
  • value：網(wǎng)絡(luò)詳細(xì)信息，具體請(qǐng)參見(jiàn)表11。
表11 address字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類型

描述

addr

String

IP地址信息。

version

Integer

IP地址類型，值為4或6。

  • 4：IP地址類型是IPv4
  • 6：IP地址類型是IPv6

OS-EXT-IPS-MAC:mac_addr

String

擴(kuò)展屬性，MAC地址。

OS-EXT-IPS:type

String

擴(kuò)展屬性，分配IP地址方式。

OS-EXT-IPS:port_id

String

IP地址對(duì)應(yīng)的端口ID。
表12 security_groups字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類型

描述

name

String
  • 創(chuàng)建裸金屬服務(wù)器時(shí)未指定安全組，該值為default。
  • 創(chuàng)建裸金屬服務(wù)器時(shí)，需要指定已有安全組的ID（UUID格式）。
表13 os-extended-volumes:volumes_attached字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類型

描述

id

String

云硬盤ID。

delete_on_termination

Boolean

刪除裸金屬服務(wù)器時(shí)是否一并刪除該卷。

  • true：是
  • false：否
表14 fault字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類型

描述

message

String

故障信息。

code

Integer

故障code。

details

String

故障詳情。

created

String

故障時(shí)間。

時(shí)間戳格式為ISO 8601：YYYY-MM-DDTHH:MM:SSZ，例如：2019-05-22T03:30:52Z

響應(yīng)示例

{ 
     "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" 
     } 
 }

返回值

正常返回值：

返回值

說(shuō)明

200

服務(wù)器已成功處理了請(qǐng)求。

其他返回值請(qǐng)參考狀態(tài)碼。

錯(cuò)誤碼

請(qǐng)參考錯(cuò)誤碼。

修改裸金屬服務(wù)器名稱ChangeBaremetalServerName

意見(jiàn)反饋

0/200

提交 取消

提交成功！非常感謝您的反饋，我們會(huì)繼續(xù)努力做到更好 反饋提交失??！請(qǐng)稍后重試！