修改云服务器
接口约束
该接口仅支持修改云服务器的名称,如需修改云服务器的hostname,请参考怎样使修改的静态主机名永久生效?。
调试
您可以在API Explorer中调试该接口。
URI
PUT /v1/{project_id}/cloudservers/{server_id}
请求消息
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
修改后的云服务器名称。 只能由中文字符、英文字母、数字及“_”、“-”、“.”组成,且长度为[1-128]个英文字符或[1-64]个中文字符。 |
description |
否 |
String |
对弹性云服务器的任意描述。 不能包含“<”,“>”,且长度范围为[0-85]个字符。 |
hostname |
否 |
String |
修改云服务器的hostname。 命令规范:长度为 [1-64] 个字符,允许使用点号(.)分隔字符成多段,每段允许使用大小写字母、数字或连字符(-),但不能连续使用点号(.)或连字符(-),不能以点号(.)或连字符(-)开头或结尾,不能出现(.-)和(-.)。
说明:
该字段已废弃,如需修改云服务器的hostname,请参考怎样使修改的静态主机名永久生效?。 |
user_data |
否 |
String |
修改云服务器过程中待注入实例自定义数据。支持注入文本、文本文件。
说明:
更多关于待注入实例自定义数据的信息,请参见《弹性云服务器用户指南 》的“用户数据注入”章节。 示例: base64编码前:
base64编码后:
|
响应消息
响应参数如表4所示。
参数 |
参数类型 |
描述 |
---|---|---|
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值遵循如下规则:
|
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 |
弹性云服务器的主机名。 |
请求示例
修改云服务器的名称为“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" } }
返回值
请参考通用请求返回值。
错误码
请参考错误码。