文档首页/ 裸金属服务器 BMS/ API参考/ 历史API/ 裸金属服务器状态管理（OpenStack Nova API）/ 修改裸金属服务器名称（废弃）
更新时间：2024-10-22 GMT+08:00
查看PDF
分享

修改裸金属服务器名称（废弃）

功能介绍

修改裸金属服务器信息，目前只支持修改裸金属服务器名称。

当前API已废弃，请使用“修改裸金属服务器名称”。

URI

PUT /v2.1/{project_id}/servers/{server_id}

参数说明请参见表1。

表1 参数说明

参数

是否必选

描述

project_id

是

项目ID。

获取方式请参见获取项目ID。

server_id

是

裸金属服务器ID。

可以从裸金属服务器控制台查询，或者通过调用查询裸金属服务器列表（废弃）获取。

请求参数

参数

是否必选

参数类型

描述

server

是

Object

裸金属服务器数据结构。详情请参见表2。
表2 server字段数据结构说明

参数

是否必选

参数类型

描述

name

是

String

修改后的裸金属服务器名称。

请求示例

修改ID为95bf2490-5428-432c-ad9b-5e3406f869dd的裸金属服务器的名称为new-server-test。 
1
 
PUT https://{ECS Endpoint}/v2.1/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd

1
2
3
4
5
 
{
    "server": {
        "name": "new-server-test"
    }
}

响应参数

表3 响应参数

参数

参数类型

描述

server

Object

裸金属服务器信息，详情请参见表4
表4 server字段数据结构说明

参数

参数类型

描述

name

String

裸金属服务器名称。

id

String

裸金属服务器唯一标识。

status

String

裸金属服务器当前状态。

  • ACTIVE：运行中/正在关机/删除中
  • BUILD：创建中
  • ERROR：故障
  • HARD_REBOOT：强制重启中
  • REBOOT：重启中
  • SHUTOFF：关机/正在开机/删除中/重建中/重装操作系统中/重装操作系统失败/冻结

created

String

裸金属服务器创建时间。

时间戳格式为ISO 8601：YYYY-MM-DDTHH:MM:SSZ，例如：2019-05-22T03:30:52Z

updated

String

裸金属服务器上一次更新时间。

时间戳格式为ISO 8601：YYYY-MM-DDTHH:MM:SSZ，例如：2019-05-22T04:30:52Z

flavor

Object

裸金属服务器规格信息。详情请参见表5。

image

Object

裸金属服务器镜像信息。详情请参见表6。

tenant_id

String

裸金属服务器所属租户ID，UUID格式。

该参数和project_id表示相同的概念。

user_id

String

裸金属服务器所属用户ID。

metadata

Object

裸金属服务器元数据。详情请参见表7。

hostId

String

裸金属服务器的主机ID。

addresses

Array of address objects

裸金属服务器所属网络信息。

  • key：表示裸金属服务器使用的虚拟私有云的ID。
  • value：网络详细信息，具体请参见表9。

links

Array of objects

裸金属服务器相关信息快捷链接。详情请参见表8。

accessIPv4

String

预留属性。

accessIPv6

String

预留属性。

OS-DCF:diskConfig

String

扩展属性，磁盘配置方式，取值为以下两种：

  • MANUAL：API使用镜像中的分区方案和文件系统创建裸金属服务器。如果目标flavor磁盘较大，则API不会对剩余磁盘空间进行分区。
  • AUTO：API使用与目标flavor磁盘大小相同的单个分区创建裸金属服务器，API会自动调整文件系统以适应整个分区。

progress

Integer

预留属性。
表5 flavor字段数据结构说明

参数

参数类型

描述

id

String

规格ID。

links

Array of objects

规格相关信息快捷链接。详情请参见表8。
表6 image字段数据结构说明

参数

参数类型

描述

id

String

裸金属服务器镜像ID。

links

Array of objects

裸金属服务器镜像相关快捷链接信息。详情请参见表8。
表7 metadata字段数据结构说明

参数

参数类型

描述

用户自定义字段键值对

String

metadata键、值。

键、值长度均不大于255字节。
表8 links字段数据结构说明

参数

参数类型

描述

rel

String

快捷链接标记名称。取值为：

  • self：包含版本号的资源链接，需要立即跟踪时使用此类链接。
  • bookmark：提供了适合长期存储的资源链接。

href

String

对应快捷链接。
表9 address字段数据结构说明

参数

参数类型

描述

addr

String

IP地址。

version

String

地址对应的版本。

响应示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
{
    "server": {
        "tenant_id": "c685484a8cc2416b97260938705deb65",
        "image": {
            "links": [
                {
                    "rel": "bookmark",
                    "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/images/1a6635d8-afea-4f2b-abb6-27a202bad319"
                }
            ],
            "id": "1a6635d8-afea-4f2b-abb6-27a202bad319"
        },
        "accessIPv4": "",
        "addresses": {
            "08a7715f-7de6-4ff9-a343-95ba4209f24a": [
                {
                    "addr": "192.168.0.107",
                    "version": 4
                }
            ]
        },
        "metadata": {
        },
        "accessIPv6": "",
        "created": "2017-05-24T06:14:05Z",
        "hostId": "e9c3ee0fcc58ab6085cf30df70b5544eab958858fb50d925f023e53e",
        "flavor": {
            "links": [
                {
                    "rel": "bookmark",
                    "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/flavors/physical.83.medium"
                }
            ],
            "id": "physical.83.medium"
        },
        "OS-DCF:diskConfig": "MANUAL",
        "user_id": "1311c433dd9b408886f57d695c229cbe",
        "name": "new-server-test",
        "progress": 0,
        "links": [
            {
                "rel": "self",
                "href": "https://openstack.example.com/v2/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd"
            },
            {
                "rel": "bookmark",
                "href": "https://openstack.example.com/c685484a8cc2416b97260938705deb65/servers/95bf2490-5428-432c-ad9b-5e3406f869dd"
            }
        ],
        "id": "95bf2490-5428-432c-ad9b-5e3406f869dd",
        "updated": "2017-05-25T03:40:25Z",
        "status": "ACTIVE"
    }
}

返回值

正常返回值：

返回值

说明

200

服务器已成功处理了请求。

其他返回值请参考状态码。

错误码

请参考错误码。