文档中心 API中心生命周期管理修改云服务器

修改云服务器

功能介绍

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

URI

PUT /v2.1/servers/{server_id}

参数说明

参数	是否必选	描述
server_id	是	云服务器ID。

请求消息

请求参数

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

表1 server字段数据结构说明

参数	是否必选	参数类型	描述
name	否	String	修改后的云服务器名称长度大于0小于256
description	否	String	对云服务器的任意描述，最大255字节。

响应消息

响应参数

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

表2 server字段数据结构说明

参数	参数类型	描述
tenant_id	String	租户ID或项目ID。
image	String	镜像ID。
accessIPv4	String	预留属性。
addresses	Object	云服务器对应的网络地址信息。详情请参见表3。
metadata	Object	云服务器元数据。
accessIPv6	String	预留属性。
created	String	云服务器创建时间。时间格式例如：2019-05-22T03:19:19Z
hostId	String	云服务器对应的主机ID。
flavor	Object	云服务器类型，详情请参见表5。
OS-DCF:diskConfig	String	扩展属性，磁盘配置方式。对镜像启动云服务器生效。
user_id	String	云服务器所属用户ID。
name	String	修改后的云服务器名称。
progress	Integer	预留属性。
links	Array of Object	云服务器相关快捷链接信息，详情请参见表6。
id	String	云服务器唯一标识。
updated	String	云服务器上一次更新时间。时间格式例如：2019-05-22T03:19:19Z
locked	Boolean	当云服务器被锁时为True，否则为False。
description	String	弹性云服务器的描述信息。
status	String	云服务器状态。取值范围：ACTIVE， BUILD，ERROR，HARD_REBOOT，MIGRATING，REBOOT，RESIZE，REVERT_RESIZE，SHELVED，SHELVED_OFFLOADED，SHUTOFF，UNKNOWN，VERIFY_RESIZE

表3 addresses字段数据结构说明

参数	参数类型	描述
网络名称	Object	弹性云服务器所属网络信息。详情请参见表4。

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

参数	参数类型	描述
addr	String	IP地址信息。
version	Integer	IP地址类型，值为4或6。4：IP地址类型是IPv46：IP地址类型是IPv6

表5 flavor字段数据结构说明

参数	参数类型	描述
id	String	云服务器类型ID。
links	Array of objects	云服务器类型相关快捷链接信息，详情请参见表6。
vcpus	Integer	该云服务器规格对应的CPU核数。
ram	Integer	该云服务器规格对应的内存大小，单位为MB。
disk	Integer	该云服务器规格对应要求系统盘大小，0为不限制。
ephemeral	Integer	未使用。
swap	Integer	未使用。
original_name	String	云服务器规格名称。

表6 links字段数据结构说明

参数	参数类型	描述
rel	String	快捷链接标记名称。
href	String	对应快捷链接。

请求示例

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

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

响应示例

{
	"server": {
		"status": "ACTIVE",
		"updated": "2021-03-29T06:54:31Z",
		"hostId": "2e67720469a5ebdcd5db74712788adf8eba9f2285d4485276c4a8be4",
		"user_id": "a906f30458c54f618995de8be92f97b7",
		"name": "new-server-test",
		"links": [{
			"href": "https://home.jcloud.sjtu.edu.cn:8774/v2.1/servers/d5fdfd93-f55d-4e19-a7e5-5d6b2fd68eb7",
			"rel": "self"
		}, {
			"href": "https://home.jcloud.sjtu.edu.cn:8774/servers/d5fdfd93-f55d-4e19-a7e5-5d6b2fd68eb7",
			"rel": "bookmark"
		}],
		"created": "2021-03-29T06:54:14Z",
		"tenant_id": "7a3856dc8df348c1ae22dd58d4197749",
		"image": {
			"id": "08a865d4-3714-46ff-a633-0a4d38fcffe2",
			"links": [{
				"href": "https://home.jcloud.sjtu.edu.cn:8774/images/08a865d4-3714-46ff-a633-0a4d38fcffe2",
				"rel": "bookmark"
			}]
		},
		"OS-DCF:diskConfig": "MANUAL",
		"addresses": {
			"net1": [{
				"version": 4,
				"addr": "192.168.1.10"
			}]
		},
		"accessIPv4": "",
		"accessIPv6": "",
		"progress": 0,
		"flavor": {
			"id": "02723f5f-5518-4031-bd5e-dfecae675606",
			"links": [{
				"href": "https://home.jcloud.sjtu.edu.cn:8774/flavors/02723f5f-5518-4031-bd5e-dfecae675606",
				"rel": "bookmark"
			}]
		},
		"id": "d5fdfd93-f55d-4e19-a7e5-5d6b2fd68eb7",
		"metadata": {
			"cinder_img_volume_type": "bbfdc5ea-f9ca-41f7-96b3-e3c473d20903",
			"volume_type": "bbfdc5ea-f9ca-41f7-96b3-e3c473d20903"
		}
	}
}