更新时间:2022-05-12 GMT+08:00
分享

更新裸金属服务器元数据

功能介绍

更新裸金属服务器元数据。

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

约束

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

调试

您可以在API Explorer中调试该接口。

URI

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

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

参数

是否必选

描述

project_id

项目ID。

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

server_id

裸金属服务器ID。

可以从裸金属服务器控制台查询,或者通过调用查询裸金属服务器列表(OpenStack原生)API获取。

请求消息

表2 请求参数说明

参数

是否必选

参数类型

说明

metadata

Object

用户自定义metadata键值对。

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

键。

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

值。

最大长度为255个Unicode字符。

  • 请求样例
    1
    POST https://{BMS Endpoint}/v1/bbf1946d374b44a0a2a95533562ba954/baremetalservers/cf2a8b97-b5c6-47ef-9714-eb27adf26e5b/metadata
    
    1
    2
    3
    4
    5
    {
        "metadata": {
            "key": "value"
        }
    }
    

响应消息

表3 参数说明

参数

是否必选

参数类型

说明

metadata

Object

用户自定义metadata键值对。

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

键。

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

值。

最大长度为255个Unicode字符。

  • 响应样例
    1
    2
    3
    4
    5
    {
        "metadata":{
            "key": "value"
        }
    } 
    

返回值

正常返回值:

返回值

说明

200

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

其他返回值请参考状态码

错误码

请参考错误码

分享:

    相关文档

    相关产品

关闭导读