弹性云服务器 ECS弹性云服务器 ECS

更新时间:2021/03/18 GMT+08:00
分享

更新云服务器元数据

功能介绍

更新云服务器元数据。

  • 如果元数据中没有待更新字段,则自动添加该字段。
  • 如果元数据中已存在待更新字段,则直接更新字段值。
  • 如果元数据中的字段不再请求参数中,则保持不变

接口约束

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

URI

POST /v1/{project_id}/cloudservers/{server_id}/metadata

表1 参数说明

参数

是否必选

描述

project_id

项目ID。

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

server_id

云服务器ID。

请求消息

表2 请求参数说明

参数

是否必选

参数类型

说明

metadata

Object

用户自定义metadata键值对。

结构体允许为空,取值为空时不更新数据。

键。

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

值。

最大长度为255个Unicode字符。

响应消息

表3 参数说明

参数

参数类型

说明

metadata

Object

用户自定义metadata键值对。

请求示例

POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/metadata
{
    "metadata": {
        "key": "value"
    }
}

响应示例

{
    "metadata":{
        "key":"value"
    }
} 

返回值

请参考通用请求返回值

分享:

    相关文档

    相关产品