# 修改云服务器 - UpdateServer #### 功能介绍 修改云服务器信息，目前支持修改云服务器名称和描述。 该接口支持企业项目细粒度权限的校验，具体细粒度请参见 [ecs:cloudServers:updateServer](https://support.huaweicloud.com/api-ecs/ecs_06_0002.html) #### 接口约束 该接口仅支持修改云服务器的名称，如需修改云服务器的hostname，请参考[怎样使修改的静态主机名永久生效？](https://support.huaweicloud.com/ecs_faq/zh-cn_topic_0050735736.html)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=ECS&api=UpdateServer)中调试该接口。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ecs/ecs_06_0000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | ecs:cloudServers:updateServer | write | instance \* | - g:ResourceTag/\ - g:EnterpriseProjectId | ecs:cloudServers:put | - | #### URI PUT /v1/{project_id}/cloudservers/{server_id} 参数说明如[表1]所示。 表1参数说明 | 参数 | 是否必选 | 描述 | |:---|:---|:---| | project_id | 是 | **参数解释：** 项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-ecs/ecs_01_0016.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | server_id | 是 | **参数解释：** 云服务器ID。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求消息 请求参数如[表2]所示。 表2请求参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | server | 是 | Object | **参数解释：** 云服务器数据结构。 详情请参见[表3]。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表3server字段数据结构说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释：** 修改后的云服务器名称。 **约束限制：** 只能由中文字符、英文字母、数字及"_"、"-"、"."组成，且长度为\[1-128\]个英文字符或\[1-64\]个中文字符。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | description | 否 | String | **参数解释：** 对弹性云服务器的任意描述。 **约束限制：** 不能包含"\<","\>"。 **取值范围：** 且长度范围为\[0-85\]个字符。 **默认取值：** 不涉及 | | hostname | 否 | String | **参数解释：** 修改云服务器的hostname。 **约束限制：** 长度为 \[1-64\] 个字符，允许使用点号(.)分隔字符成多段，每段允许使用大小写字母、数字或连字符(-)，但不能连续使用点号(.)或连字符(-),不能以点号(.)或连字符(-)开头或结尾，不能出现（.-）和（-.）。 说明： 该字段已废弃，如需修改云服务器的hostname，请参考[怎样使修改的静态主机名永久生效？](https://support.huaweicloud.com/ecs_faq/zh-cn_topic_0050735736.html)。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | 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 ``` 更多关于待注入实例自定义数据的信息，请参见《弹性云服务器用户指南 》的"[用户数据注入](https://support.huaweicloud.com/usermanual-ecs/zh-cn_topic_0032380449.html)"章节。 **约束限制：** - user_data的值为base64编码之后的内容。 - 注入内容（编码之前的内容）最大长度为32K。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | security_options | 否 | Object | **参数解释：** 安全启动选项security_options 详情请参见[表4]。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表4security_options数据结构说明 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | secure_boot_enabled | 否 | Boolean | **参数解释：** 安全启动开关。 **约束限制：** 不涉及 **取值范围：** - true: 打开安全启动。 - false: 关闭安全启动。 **默认取值：** false | | tpm_enabled | 否 | Boolean | **参数解释：** tpm启动开关。 **约束限制：** 不涉及 **取值范围：** - true: 打开tpm。 - false: 关闭tpm。 **默认取值：** false | #### 响应消息 响应参数如[表5]所示。 表5响应参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | server | Object | **参数解释：** 云服务器信息。 详情请参见[表6]。 **取值范围：** 不涉及 | 表6server字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | tenant_id | String | **参数解释：** 租户ID或项目ID。 **取值范围：** 不涉及 | | image | String | **参数解释：** 镜像ID。 **取值范围：** 不涉及 | | accessIPv4 | String | **参数解释：** 预留属性。 **取值范围：** 不涉及 | | addresses | Object | **参数解释：** 云服务器属性网络信息。 属性为Map\结构。 网络详细信息请参见[表7]。 **取值范围：** 不涉及 | | 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 | **参数解释：** 云服务器类型，详情请参见[表8]。 **取值范围：** 不涉及 | | OS-DCF:diskConfig | String | **参数解释：** 扩展属性，磁盘配置方式。对镜像启动云服务器生效。 **取值范围：** 不涉及 | | user_id | String | **参数解释：** 云服务器所属用户ID。 **取值范围：** 不涉及 | | name | String | **参数解释：** 修改后的云服务器名称。 **取值范围：** 不涉及 | | progress | Integer | **参数解释：** 预留属性。 **取值范围：** 不涉及 | | links | Array of Object | **参数解释：** 云服务器相关快捷链接信息，详情请参见[表9]。 **取值范围：** 不涉及 | | id | String | **参数解释：** 云服务器唯一标识。 **取值范围：** 不涉及 | | updated | String | **参数解释：** 云服务器上一次更新时间。 时间格式例如：2019-05-22T03:19:19Z **取值范围：** 不涉及 | | locked | Boolean | **参数解释：** 当云服务器被锁时为True，否则为False。 **取值范围：** 不涉及 | | description | String | **参数解释：** 弹性云服务器的描述信息。 **取值范围：** 不涉及 | | tags | Array of strings | **参数解释：** 云服务器的标签列表。 系统近期对标签功能进行了升级，升级后，返回的tag值遵循如下规则： - key与value使用"="连接，如"key=value"。 - 如果value为空字符串，则仅返回key。 **取值范围：** 不涉及 | | status | String | **参数解释：** 云服务器状态。 **取值范围：** ACTIVE、BUILD、ERROR、HARD_REBOOT、MIGRATING、REBOOT、REBUILD、RESIZE、REVERT_RESIZE、SHUTOFF、VERIFY_RESIZE、DELETED、SHELVED、SHELVED_OFFLOADED 、UNKNOWN 弹性云服务器状态说明请参考[云服务器状态](https://support.huaweicloud.com/api-ecs/ecs_08_0002.html) | | OS-EXT-SRV-ATTR:hostname | String | **参数解释：** 弹性云服务器的主机名。 **取值范围：** 不涉及 | 表7弹性云服务器所属网络信息数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | addr | String | **参数解释：** IP地址信息。 **取值范围：** 不涉及 | | version | Integer | **参数解释：** IP地址类型。 **取值范围：** - 4：IP地址类型是IPv4 - 6：IP地址类型是IPv6 | 表8flavor字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 云服务器类型ID。 **取值范围：** 不涉及 | | links | Array of objects | **参数解释：** 云服务器类型相关快捷链接信息，详情请参见[表9]。 **取值范围：** 不涉及 | 表9links字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | rel | String | **参数解释：** 快捷链接标记名称。 **取值范围：** 不涉及 | | href | String | **参数解释：** 对应快捷链接。 **取值范围：** 不涉及 | #### 请求示例 修改云服务器的名称为"new-server-test"。 ``` PUT https://{endpoint}/v1/{project_id}/cloudservers/{server_id} { "server": { "name": "new-server-test" } } ``` #### 响应示例 ``` { "server": { "tenant_id": "10c351034cb84212ba9d9721504812fe", "image": "", "accessIPv4": null, "metadata": { "__support_agent_list": "hss,ces" }, "addresses": { "ee8d408c-9f11-4407-9cbc-b17c8d372502": [ { "addr": "192.168.26.22", "version": 4 } ] }, "accessIPv6": null, "created": "2025-07-23T08:22:35Z", "OS-EXT-SRV-ATTR:user_data": null, "hostId": "5228412f60464f196eb4db431011d476312bf0d53de9c828f36daeef", "description": "", "OS-EXT-SRV-ATTR:hostname": "server-test", "flavor": { "links": [ { "rel": "bookmark", "href": "https://{endpoint}/flavors/s2.large.2" } ], "id": "s2.large.2" }, "OS-DCF:diskConfig": "MANUAL", "user_id": "d4e91bab74ac4d45bb7d7bce182b6684", "name": "new-server-test", "progress": 0, "links": [ { "rel": "self", "href": "https://{endpoint}/v1.0/servers/17833209-75ba-4ad3-931d-5645919e3664" }, { "rel": "bookmark", "href": "https://{endpoint}/servers/17833209-75ba-4ad3-931d-5645919e3664" } ], "id": "17833209-75ba-4ad3-931d-5645919e3664", "updated": "2026-07-23T08:23:05Z", "status": "ACTIVE" } } ``` #### 返回值 请参考[通用请求返回值](https://support.huaweicloud.com/api-ecs/ecs_07_0001.html)。 #### 错误码 请参考[错误码](https://support.huaweicloud.com/api-ecs/ecs_07_0002.html)。