華為云計(jì)算 云知識(shí) 修改彈性云服務(wù)器NovaUpdateServer
修改彈性云服務(wù)器NovaUpdateServer

 

功能介紹

修改 云服務(wù)器 信息,目前支持修改云服務(wù)器名稱及描述。

調(diào)試

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

URI

PUT /v2.1/{project_id}/servers/{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。

請(qǐng)求消息

請(qǐng)求參數(shù)如表2所示。
表2 請(qǐng)求參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

server

Object

云服務(wù)器數(shù)據(jù)結(jié)構(gòu),詳情請(qǐng)參見(jiàn)表3

表3 server字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

是否必選

參數(shù)類型

描述

name

String

修改后的云服務(wù)器名稱

  • 長(zhǎng)度大于0小于256

description

String

對(duì)彈性云服務(wù)器的任意描述,最大255字節(jié)。

微版本2.19及以上版本支持。

響應(yīng)消息

響應(yīng)參數(shù)如表4所示。

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

參數(shù)

參數(shù)類型

描述

server

Object

云服務(wù)器信息,詳情請(qǐng)參見(jiàn)表5。

表5 server字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(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)。

網(wǎng)絡(luò)詳細(xì)信息請(qǐng)參見(jiàn)表6。

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

云服務(wù)器類型,詳情請(qǐng)參見(jiàn)表7。

OS-DCF:diskConfig

String

擴(kuò)展屬性,磁盤配置方式。對(duì)鏡像啟動(dòng)云服務(wù)器生效。

user_id

String

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

name

String

修改后的云服務(wù)器名稱。

progress

Integer

預(yù)留屬性。

links

Array of Object

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

id

String

云服務(wù)器唯一標(biāo)識(shí)。

updated

String

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

時(shí)間格式例如:2019-05-22T03:19:19Z

locked

Boolean

當(dāng)云服務(wù)器被鎖時(shí)為True,否則為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ī)則:
  • key與value使用“=”連接,如“key=value”。
  • 如果value為空字符串,則僅返回key。
  • key與value使用“=”連接,如“key=value”。
  • 如果value為空字符串,則僅返回key。

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)

表6 彈性云服務(wù)器所屬網(wǎng)絡(luò)信息數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類型

描述

addr

String

IP地址信息。

version

Integer

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

  • 4:IP地址類型是IPv4
  • 6:IP地址類型是IPv6
表7 flavor字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類型

描述

id

String

云服務(wù)器類型ID。

微版本2.47及以上版本不支持。

links

Array of objects

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

微版本2.47及以上版本不支持。

vcpus

Integer

云服務(wù)器規(guī)格對(duì)應(yīng)的CPU核數(shù)。

在微版本2.47及以上版本支持。

ram

Integer

云服務(wù)器規(guī)格對(duì)應(yīng)的內(nèi)存大小,單位為MB。

在微版本2.47及以上版本支持。

disk

Integer

云服務(wù)器規(guī)格對(duì)應(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ò)展字段請(qǐng)參考:os_extra_specs(flavor)字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

在微版本2.47及以上版本支持。

表8 links字段數(shù)據(jù)結(jié)構(gòu)說(shuō)明

參數(shù)

參數(shù)類型

描述

rel

String

快捷鏈接標(biāo)記名稱。

href

String

對(duì)應(yīng)快捷鏈接。

請(qǐng)求示例

修改指定云服務(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"
  }
}

返回值

請(qǐng)參考通用請(qǐng)求返回值。