功能介紹
修改 云服務(wù)器 信息,目前支持修改云服務(wù)器名稱及描述。
調(diào)試
您可以在API Explorer中調(diào)試該接口。
URI
PUT /v2.1/{project_id}/servers/{server_id}
參數(shù) |
是否必選 |
描述 |
---|---|---|
project_id |
是 |
項(xiàng)目ID。 獲取方法請參見獲取項(xiàng)目ID。 |
server_id |
是 |
云服務(wù)器ID。 |
請求消息
響應(yīng)消息
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
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)建時間。時間格式例如:2019-05-22T03:19:19Z |
hostId |
String |
云服務(wù)器對應(yīng)的主機(jī)ID。 |
flavor |
Object |
|
OS-DCF:diskConfig |
String |
擴(kuò)展屬性,磁盤配置方式。對鏡像啟動云服務(wù)器生效。 |
user_id |
String |
云服務(wù)器所屬用戶ID。 |
name |
String |
修改后的云服務(wù)器名稱。 |
progress |
Integer |
預(yù)留屬性。 |
links |
Array of Object |
|
id |
String |
云服務(wù)器唯一標(biāo)識。 |
updated |
String |
云服務(wù)器上一次更新時間。 時間格式例如:2019-05-22T03:19:19Z |
locked |
Boolean |
當(dāng)云服務(wù)器被鎖時為True,否則為False。 微版本2.9及以上版本支持。 |
description |
String |
彈性云服務(wù)器的描述信息。 微版本2.19及以上版本支持。 |
tags |
Array of strings |
云服務(wù)器的標(biāo)簽列表。 微版本2.26及以上版本支持,如果不使用微版本查詢,響應(yīng)中無tags字段。 系統(tǒng)近期對標(biāo)簽功能進(jìn)行了升級,升級后,返回的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)說明請參考云服務(wù)器狀態(tài) |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
addr |
String |
IP地址信息。 |
version |
Integer |
IP地址類型,值為4或6。
|
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
id |
String |
云服務(wù)器類型ID。 微版本2.47及以上版本不支持。 |
links |
Array of objects |
云服務(wù)器類型相關(guān)快捷鏈接信息,詳情請參見表8。 微版本2.47及以上版本不支持。 |
vcpus |
Integer |
該云服務(wù)器規(guī)格對應(yīng)的CPU核數(shù)。 在微版本2.47及以上版本支持。 |
ram |
Integer |
該云服務(wù)器規(guī)格對應(yīng)的內(nèi)存大小,單位為MB。 在微版本2.47及以上版本支持。 |
disk |
Integer |
該云服務(wù)器規(guī)格對應(yīng)要求系統(tǒng)盤大小,0為不限制。 在微版本2.47及以上版本支持。 |
ephemeral |
Integer |
未使用。 在微版本2.47及以上版本支持。 |
swap |
Integer |
未使用。 在微版本2.47及以上版本支持。 |
original_name |
String |
云服務(wù)器規(guī)格名稱。 在微版本2.47及以上版本支持。 |
extra_specs |
Object |
flavor擴(kuò)展字段請參考:os_extra_specs(flavor)字段數(shù)據(jù)結(jié)構(gòu)說明 在微版本2.47及以上版本支持。 |
請求示例
修改指定云服務(wù)器的名稱為“new-server-test”。
PUT https://{endpoint}/v2.1/{project_id}/servers/{server_id} { "server": { "name": "new-server-test" } }
響應(yīng)示例
{ "server": { "tenant_id": "7910a6e50b80402ba028c8d96c1b31fe", "image": "", "accessIPv4": "", "addresses": { "03be5c1e-e05d-4905-a105-c3bd9b730bdc": [ { "addr": "192.168.0.72", "version": 4 } ] }, "metadata": {}, "accessIPv6": "", "created": "2018-05-17T03:15:48Z", "hostId": "7dc82f6b1d406200fc63e395cf4829cbffcb49de0e9c75c5773f201f", "flavor": { "links": [ { "rel": "bookmark", "href": "https://None/7910a6e50b80402ba028c8d96c1b31fe/flavors/c3.1U1G" } ], "id": "c3.1U1G" }, "OS-DCF:diskConfig": "MANUAL", "user_id": "d698a78532ca430f8daec1858f2b500e", "name": "new-server-test", "progress": 0, "links": [ { "rel": "self", "href": "https://None/v2/7910a6e50b80402ba028c8d96c1b31fe/servers/1a19ef4f-be0a-4526-bf2f-14b4464d536a" }, { "rel": "bookmark", "href": "https://None/7910a6e50b80402ba028c8d96c1b31fe/servers/1a19ef4f-be0a-4526-bf2f-14b4464d536a" } ], "id": "1a19ef4f-be0a-4526-bf2f-14b4464d536a", "updated": "2018-05-21T00:36:27Z", "status": "ACTIVE" } }
返回值
請參考通用請求返回值。