
功能介绍
设置 云服务器 指定key的元数据。
- 如果元数据中没有待更新字段,则自动添加该字段。
- 如果元数据中已存在待更新字段,则直接更新字段值。
接口约束
云服务 器状态(云服务器的OS-EXT-STS:vm_state属性)必须是active,stopped,paused或者suspended。
调试
您可以在API Explorer中调试该接口。
URI
PUT /v2.1/{project_id}/servers/{server_id}/metadata/{key}
参数说明请参见
表1。
表1 参数说明
参数
|
是否必选
|
描述
|
project_id
|
是
|
项目ID。
获取方法请参见获取项目ID。
|
server_id
|
是
|
云服务器ID。
|
key
|
是
|
待修改的云服务器metadata键值。
|
请求消息
请求参数如表2所示。
表2 请求参数
参数
|
是否必选
|
参数类型
|
描述
|
meta
|
是
|
Object
|
用户自定义metadata键值对。
键。
最大长度255个Unicode字符,不能为空。可以为大写字母(A-Z)、小写字母(a-z)、数字(0-9)、中划线(-)、下划线(_)、冒号(:)和小数点(.)。
值。
最大长度为255个Unicode字符。
|
响应消息
响应参数如
表3所示。
表3 响应参数
参数
|
参数类型
|
描述
|
meta
|
Object
|
用户自定义metadata键值对。
|
请求示例
设置指定云服务器的指定key的元数据。
PUT https://{endpoint}/v2.1/{project_id}/servers/{server_id}/metadata/{key}
{
"meta":{
"key":"value"
}
}
响应示例
{
"meta":{
"key":"value"
}
}