功能介紹
修改 云服務(wù)器 信息，目前支持修改云服務(wù)器名稱及描述和hostname。
該接口支持企業(yè)項(xiàng)目細(xì)粒度權(quán)限的校驗(yàn)，具體細(xì)粒度請(qǐng)參見(jiàn) ecs:cloudServers:updateServer
接口約束
云服務(wù)器hostname修改后，需要重啟云服務(wù)器后才會(huì)生效。
調(diào)試
您可以在API Explorer中調(diào)試該接口。
URI
PUT /v1/{project_id}/cloudservers/{server_id}
|
參數(shù) |
是否必選 |
描述 |
|---|---|---|
|
project_id |
是 |
項(xiàng)目ID。 獲取方法請(qǐng)參見(jiàn)獲取項(xiàng)目ID。 |
|
server_id |
是 |
云服務(wù)器ID。 |
請(qǐng)求消息
|
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
修改后的云服務(wù)器名稱。 只能由中文字符、英文字母、數(shù)字及“_”、“-”組成，且長(zhǎng)度為[1-64]個(gè)字符。 |
|
description |
否 |
String |
對(duì)彈性云服務(wù)器的任意描述。 不能包含“<”,“>”，且長(zhǎng)度范圍為[0-85]個(gè)字符。 |
|
hostname |
否 |
String |
修改云服務(wù)器 hostname。 命令規(guī)范：長(zhǎng)度為 [1-64] 個(gè)字符，允許使用點(diǎn)號(hào)(.)分隔字符成多段，每段允許使用大小寫(xiě)字母、數(shù)字或連字符(-)，但不能連續(xù)使用點(diǎn)號(hào)(.)或連字符(-),不能以點(diǎn)號(hào)(.)或連字符(-)開(kāi)頭或結(jié)尾，不能出現(xiàn)（.-）和（-.）。 |
響應(yīng)消息
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
tenant_id |
String |
租戶ID或項(xiàng)目ID。 |
|
image |
String |
鏡像 ID。 |
|
accessIPv4 |
String |
預(yù)留屬性。 |
|
addresses |
Object |
云服務(wù)器屬性網(wǎng)絡(luò)信息。 屬性為Map<String, Object>結(jié)構(gòu)。 |
|
metadata |
Object |
云服務(wù)器元數(shù)據(jù)。 |
|
accessIPv6 |
String |
預(yù)留屬性。 |
|
created |
String |
云服務(wù)器創(chuàng)建時(shí)間。時(shí)間格式例如：2019-05-22T03:19:19Z |
|
hostId |
String |
云服務(wù)器對(duì)應(yīng)的主機(jī)ID。 |
|
flavor |
Object |
|
|
OS-DCF:diskConfig |
String |
擴(kuò)展屬性，磁盤(pán)配置方式。對(duì)鏡像啟動(dòng)云服務(wù)器生效。 |
|
user_id |
String |
云服務(wù)器所屬用戶ID。 |
|
name |
String |
修改后的云服務(wù)器名稱。 |
|
progress |
Integer |
預(yù)留屬性。 |
|
links |
Array of Object |
|
|
id |
String |
云服務(wù)器唯一標(biāo)識(shí)。 |
|
updated |
String |
云服務(wù)器上一次更新時(shí)間。 時(shí)間格式例如：2019-05-22T03:19:19Z |
|
locked |
Boolean |
當(dāng)云服務(wù)器被鎖時(shí)為T(mén)rue，否則為False。 微版本2.9及以上版本支持。 |
|
description |
String |
彈性云服務(wù)器的描述信息。 微版本2.19及以上版本支持。 |
|
tags |
Array of strings |
云服務(wù)器的標(biāo)簽列表。 微版本2.26及以上版本支持，如果不使用微版本查詢，響應(yīng)中無(wú)tags字段。 系統(tǒng)近期對(duì)標(biāo)簽功能進(jìn)行了升級(jí)，升級(jí)后，返回的tag值遵循如下規(guī)則：
|
|
status |
String |
云服務(wù)器狀態(tài)。 取值范圍： ACTIVE， BUILD，ERROR，HARD_REBOOT，MIGRATING，REBOOT，RESIZE，REVERT_RESIZE，SHELVED，SHELVED_OFFLOADED，SHUTOFF，UNKNOWN，VERIFY_RESIZE 彈性云服務(wù)器狀態(tài)說(shuō)明請(qǐng)參考云服務(wù)器狀態(tài) |
|
OS-EXT-SRV-ATTR:hostname |
String |
彈性云服務(wù)器的主機(jī)名。 |
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
addr |
String |
IP地址信息。 |
|
version |
Integer |
IP地址類(lèi)型，值為4或6。
|
請(qǐng)求示例
修改云服務(wù)器的名稱為“new-server-test”。
PUT https://{endpoint}/v1/{project_id}/cloudservers/{server_id}
{
"server": {
"name": "new-server-test"
}
}
響應(yīng)示例
{
"server": {
"tenant_id": "66c860cb130b465fbafcdee43fb09c64",
"image": "",
"accessIPv4": "",
"addresses": {
"01d7aef8-442b-408e-b82f-13afff51e4e4": [
{
"addr": "192.168.26.22",
"version": 4
}
]
},
"metadata": {
"virtual_env_type": "FusionCompute"
},
"description": "",
"accessIPv6": "",
"created": "2019-04-25T11:52:53Z",
"hostId": "57d278e7c53d07cd34fad3ba4fdc9f3d779017d0879726d83b45a22a",
"OS-EXT-SRV-ATTR:hostname": "new-test-hostname",
"flavor": {
"links": [
{
"rel": "bookmark",
"href": "https://None/66c860cb130b465fbafcdee43fb09c64/flavors/s2.large.2"
}
],
"id": "s2.large.2"
},
"OS-DCF:diskConfig": "MANUAL",
"user_id": "f88581d53be64716a985c66ca28c75f6",
"name": "new-test-hostname",
"progress": 0,
"links": [
{
"rel": "self",
"href": "https://None/v2/66c860cb130b465fbafcdee43fb09c64/servers/24930df0-db4c-4a8b-8914-d0bd558564b0"
},
{
"rel": "bookmark",
"href": "https://None/66c860cb130b465fbafcdee43fb09c64/servers/24930df0-db4c-4a8b-8914-d0bd558564b0"
}
],
"id": "24930df0-db4c-4a8b-8914-d0bd558564b0",
"updated": "2019-04-28T08:15:36Z",
"status": "ACTIVE"
}
}
返回值
請(qǐng)參考通用請(qǐng)求返回值。
錯(cuò)誤碼
請(qǐng)參考錯(cuò)誤碼。
