更新时间:2024-04-18 GMT+08:00

设置云服务器元数据

功能介绍

设置弹性云服务器的元数据信息。

将删除目前弹性云服务器的所有元数据信息,并更新为请求参数中的值。

接口约束

弹性云服务器状态(弹性云服务器的OS-EXT-STS:vm_state属性)必须是active,stopped,paused或者suspended。

URI

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

参数说明请参见表1
表1 参数说明

参数

是否必选

描述

project_id

项目ID。

获取方法请参见获取项目ID

server_id

云服务器ID。

请求消息

请求参数如表2所示。

表2 请求参数

参数

参数类型

是否必选

描述

metadata

Object

用户自定义metadata键值对。

键。

最大长度255个Unicode字符,不能为空。可以为大写字母(A-Z)、小写字母(a-z)、数字(0-9)、中划线(-)、下划线(_)、冒号(:)和小数点(.)。

值。

最大长度为255个Unicode字符。

响应消息

响应参数如表3所示。

表3 响应参数

参数

参数类型

描述

metadata

Object

用户自定义metadata键值对。

请求示例

设置指定云服务器的元数据信息。

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

{
    "metadata": {
            "key1": "value1",
            "key2": "value2"
    }
}

响应示例

{
    "metadata": {
            "key1": "value1",
            "key2": "value2"
    }
}

返回值

请参考通用请求返回值