修改云服务器

功能介绍

修改云服务器信息，目前支持修改云服务器名称及描述。

URI

PUT /v2.1/{project_id}/servers/{server_id}

参数说明请参见表1。

表1 参数说明
参数	是否必选	描述
project_id	是	项目ID。获取方法请参见获取项目ID。
server_id	是	云服务器ID。

请求消息

请求参数如表2所示。

表2 请求参数
参数	是否必选	参数类型	描述
server	是	Object	云服务器数据结构，详情请参见表3

表3 server字段数据结构说明
参数	是否必选	参数类型	描述
name	否	String	修改后的云服务器名称，字符长度范围为1-255。
description	否	String	对弹性云服务器的任意描述，最大255字节。微版本2.19及以上版本支持。

响应消息

响应参数如表4所示。

表4 响应参数
参数	参数类型	描述
server	Object	云服务器信息，详情请参见表5。

表5 server字段数据结构说明
参数	参数类型	描述
tenant_id	String	租户ID或项目ID。
image	String	镜像ID。
accessIPv4	String	预留属性。
addresses	Object	弹性云服务器所属网络信息。属性为Map<String, Object>结构。网络详细信息请参见表6。
metadata	Object	云服务器元数据。
accessIPv6	String	预留属性。
created	String	云服务器创建时间。时间格式例如：2019-05-22T03:19:19Z
hostId	String	云服务器对应的主机ID。
flavor	Object	云服务器类型，详情请参见表7。
OS-DCF:diskConfig	String	扩展属性，磁盘配置方式。对镜像启动云服务器生效。
user_id	String	云服务器所属用户ID。
name	String	修改后的云服务器名称。
progress	Integer	预留属性。
links	Array of Object	云服务器相关快捷链接信息，详情请参见表8。
id	String	云服务器唯一标识。
updated	String	云服务器上一次更新时间。时间格式例如：2019-05-22T03:19:19Z
locked	Boolean	当云服务器被锁时为True，否则为False。微版本2.9及以上版本支持。
description	String	弹性云服务器的描述信息。微版本2.19及以上版本支持。
tags	Array of strings	云服务器的标签列表。微版本2.26及以上版本支持，如果不使用微版本查询，响应中无tags字段。系统近期对标签功能进行了升级，升级后，返回的tag值遵循如下规则： key与value使用“=”连接，如“key=value”。如果value为空字符串，则仅返回key。 key与value使用“=”连接，如“key=value”。如果value为空字符串，则仅返回key。
status	String	云服务器状态。取值范围： ACTIVE， BUILD，ERROR，HARD_REBOOT，MIGRATING，REBOOT，RESIZE，REVERT_RESIZE，SHELVED，SHELVED_OFFLOADED，SHUTOFF，UNKNOWN，VERIFY_RESIZE 弹性云服务器状态说明请参考云服务器状态

表6 弹性云服务器所属网络信息数据结构说明
参数	参数类型	描述
addr	String	IP地址信息。
version	Integer	IP地址类型，值为4或6。 4：IP地址类型是IPv4 6：IP地址类型是IPv6

表7 flavor字段数据结构说明
参数	参数类型	描述
id	String	云服务器类型ID。微版本2.47及以上版本不支持。
links	Array of objects	云服务器类型相关快捷链接信息，详情请参见表8。微版本2.47及以上版本不支持。
vcpus	Integer	该云服务器规格对应的CPU核数。在微版本2.47及以上版本支持。
ram	Integer	该云服务器规格对应的内存大小，单位为MB。在微版本2.47及以上版本支持。
disk	Integer	该云服务器规格对应要求系统盘大小，0为不限制。在微版本2.47及以上版本支持。
ephemeral	Integer	未使用。在微版本2.47及以上版本支持。
swap	Integer	未使用。在微版本2.47及以上版本支持。
original_name	String	云服务器规格名称。在微版本2.47及以上版本支持。
extra_specs	Object	flavor扩展字段请参考：os_extra_specs（flavor）字段数据结构说明在微版本2.47及以上版本支持。

表8 links字段数据结构说明
参数	参数类型	描述
rel	String	快捷链接标记名称。
href	String	对应快捷链接。

请求示例

修改指定云服务器的名称为“new-server-test”。

PUT https://{endpoint}/v2.1/{project_id}/servers/{server_id}

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

响应示例

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