更新时间:2025-08-18 GMT+08:00

修改云服务器

功能介绍

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

该接口支持企业项目细粒度权限的校验,具体细粒度请参见 ecs:cloudServers:updateServer

接口约束

该接口仅支持修改云服务器的名称,如需修改云服务器的hostname,请参考怎样使修改的静态主机名永久生效?

URI

PUT /v1/{project_id}/cloudservers/{server_id}

参数说明如表1所示。
表1 参数说明

参数

是否必选

描述

project_id

项目ID。

获取方法请参见获取项目ID

server_id

云服务器ID。

请求消息

请求参数如表2所示。
表2 请求参数

参数

是否必选

参数类型

描述

server

Object

参数解释:

云服务器数据结构。

详情请参见表3

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 server字段数据结构说明

参数

是否必选

参数类型

描述

name

String

参数解释:

修改后的云服务器名称。

约束限制:

只能由中文字符、英文字母、数字及“_”、“-”、“.”组成,且长度为[1-128]个英文字符或[1-64]个中文字符。

取值范围:

不涉及

默认取值:

不涉及

description

String

参数解释:

弹性云服务器的任意描述。

约束限制:

不能包含“<”,“>”。

取值范围:

且长度范围为[0-85]个字符。

默认取值:

不涉及

hostname

String

参数解释:

修改云服务器的hostname。

约束限制:

长度为 [1-64] 个字符,允许使用点号(.)分隔字符成多段,每段允许使用大小写字母、数字或连字符(-),但不能连续使用点号(.)或连字符(-),不能以点号(.)或连字符(-)开头或结尾,不能出现(.-)和(-.)。

说明:

该字段已废弃,如需修改云服务器的hostname,请参考怎样使修改的静态主机名永久生效?

取值范围:

不涉及

默认取值:

不涉及

user_data

String

参数解释:

修改云服务器过程中待注入实例自定义数据。支持注入文本、文本文件。

示例:

base64编码前:

  • Linux服务器:
    #!/bin/bash
    echo user_test > /home/user.txt
  • Windows服务器:
    rem cmd
    echo 111 > c:\aaa.txt

base64编码后:

  • Linux服务器:
    IyEvYmluL2Jhc2gKZWNobyB1c2VyX3Rlc3QgPiAvaG9tZS91c2VyLnR4dA==
  • Windows服务器:
    cmVtIGNtZA0KZWNobyAxMTEgJmd0OyBjOlxhYWEudHh0

更多关于待注入实例自定义数据的信息,请参见《弹性云服务器用户指南 》的“用户数据注入”章节。

约束限制:

  • user_data的值为base64编码之后的内容。
  • 注入内容(编码之前的内容)最大长度为32K。

取值范围:

不涉及

默认取值:

不涉及

响应消息

响应参数如表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

取值范围:

不涉及

OS-EXT-SRV-ATTR:user_data

String

参数解释:

创建弹性云服务器时指定的user_data(编码过后的信息)。

取值范围:

不涉及

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。

取值范围:

不涉及

status

String

参数解释:

云服务器状态。

取值范围:

ACTIVE, BUILD,ERROR,HARD_REBOOT,MIGRATING,REBOOT,RESIZE,REVERT_RESIZE,SHELVED,SHELVED_OFFLOADED,SHUTOFF,UNKNOWN,VERIFY_RESIZE

弹性云服务器状态说明请参考云服务器状态

OS-EXT-SRV-ATTR:hostname

String

参数解释:

弹性云服务器的主机名。

取值范围:

不涉及

表6 弹性云服务器所属网络信息数据结构说明

参数

参数类型

描述

addr

String

参数解释:

IP地址信息。

取值范围:

不涉及

version

Integer

参数解释:

IP地址类型。

取值范围:

  • 4:IP地址类型是IPv4
  • 6:IP地址类型是IPv6
表7 flavor字段数据结构说明

参数

参数类型

描述

id

String

参数解释:

云服务器类型ID。

取值范围:

不涉及

links

Array of objects

参数解释:

云服务器类型相关快捷链接信息,详情请参见表8

取值范围:

不涉及

表8 links字段数据结构说明

参数

参数类型

描述

rel

String

参数解释:

快捷链接标记名称。

取值范围:

不涉及

href

String

参数解释:

对应快捷链接。

取值范围:

不涉及

请求示例

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

PUT  https://{endpoint}/v1/{project_id}/cloudservers/{server_id}

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

响应示例

{
  "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",
    "OS-EXT-SRV-ATTR:user_data": "",
    "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"
  }
}

返回值

请参考通用请求返回值

错误码

请参考错误码