九游平台/ 弹性云服务器 ecs/ api参考/ api/ 生命周期管理/ 修改云服务器
更新时间：2024-11-14 gmt 08:00
查看pdf

修改云服务器-九游平台

功能介绍

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

该接口支持企业项目细粒度权限的校验，具体细粒度请参见 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

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

说明：
  • user_data的值为base64编码之后的内容。
  • 注入内容（编码之前的内容）最大长度为32k。

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

示例：

base64编码前：

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

base64编码后：

  • linux服务器： 
    iyevymlul2jhc2gkzwnobyb1c2vyx3rlc3qgpiavag9tzs91c2vylnr4da==
  • windows服务器： 
    cmvtigntza0kzwnobyaxmtegjmd0oybjolxhyweudhh0

响应消息

响应参数如表4所示。

表4 响应参数

参数

参数类型

描述

server

object

云服务器信息。

详情请参见表5。
表5 server字段数据结构说明

参数

参数类型

描述

tenant_id

string

租户id或项目id。

image

string

镜像id。

accessipv4

string

预留属性。

addresses

object

云服务器属性网络信息。

属性为map结构。

网络详细信息请参见表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或6。

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

返回值

请参考通用请求返回值。

错误码

请参考错误码。

父主题： 生命周期管理

相关文档

网站地图